Package com.helger.as2lib.processor.storage

Class AbstractStorageModule

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.processor.module.AbstractProcessorModule

com.helger.as2lib.processor.storage.AbstractStorageModule

All Implemented Interfaces:

IDynamicComponent, IProcessorModule, IProcessorStorageModule

Direct Known Subclasses:

MDNFileModule, MessageFileModule

public abstract class AbstractStorageModule
extends AbstractProcessorModule
implements IProcessorStorageModule

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CHARSET
static String	ATTR_FILENAME
static String	ATTR_PROTOCOL
static String	ATTR_TEMPDIR

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Fields inherited from interface com.helger.as2lib.processor.storage.IProcessorStorageModule

DO_STORE, DO_STOREMDN, DO_VALIDATE_AFTER_STORE, DO_VALIDATE_BEFORE_STORE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStorageModule(String sModuleAction)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String sAction, IMessage aMsg, Map<String,Object> aOptions)	Check if this processor module can handle a certain action on the provided message
boolean	equals(Object o)
protected Charset	getCharset()
String	getCharsetName()
protected File	getFile(IMessage aMsg, String sFileParam)	Not final - see #105
String	getFilename()
protected abstract String	getFilename(IMessage aMsg, String sFileParam)
String	getProtocol()
String	getTempDir()
int	hashCode()
void	initDynamicComponent(IAS2Session aSession, com.helger.commons.collection.attr.IStringMap aOptions)	After creating a Component object, this method should be called to set any parameters used by the component.
void	setCharsetName(String sCharsetName)
void	setFilename(String sFilename)
void	setProtocol(String sProtocol)
void	setTempDir(String sTempDir)
protected void	store(File aMsgFile, InputStream aIS)

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession

Methods inherited from interface com.helger.as2lib.processor.module.IProcessorModule

handle

Field Detail

ATTR_FILENAME

public static final String ATTR_FILENAME

See Also:

Constant Field Values

ATTR_PROTOCOL

public static final String ATTR_PROTOCOL

See Also:

Constant Field Values

ATTR_TEMPDIR

public static final String ATTR_TEMPDIR

See Also:

Constant Field Values

ATTR_CHARSET

public static final String ATTR_CHARSET

See Also:

Constant Field Values

Constructor Detail

AbstractStorageModule

protected AbstractStorageModule(@Nonnull @Nonempty
                                String sModuleAction)

Method Detail

getFilename

@Nullable
public final String getFilename()

setFilename

public final void setFilename(@Nullable
                              String sFilename)

getProtocol

@Nullable
public final String getProtocol()

setProtocol

public final void setProtocol(@Nullable
                              String sProtocol)

getTempDir

@Nullable
public final String getTempDir()

setTempDir

public final void setTempDir(@Nullable
                             String sTempDir)

getCharsetName

@Nullable
public final String getCharsetName()

getCharset

@Nonnull
protected Charset getCharset()

Returns:

The charset configured via ATTR_CHARSET parameter or the system default. Never null.

setCharsetName

public final void setCharsetName(@Nullable
                                 String sCharsetName)

canHandle

public final boolean canHandle(@Nonnull
                               String sAction,
                               @Nonnull
                               IMessage aMsg,
                               @Nullable
                               Map<String,Object> aOptions)

Description copied from interface: IProcessorModule

Check if this processor module can handle a certain action on the provided message

Specified by:

canHandle in interface IProcessorModule

Parameters:

sAction - The action to be executed. Never null.

aMsg - The message in question. May be an AS2 message or an MDN message. Never null.

aOptions - The options to be considered. May be null.

Returns:

true of this module can handle the respective message, false if not.

initDynamicComponent

public final void initDynamicComponent(@Nonnull
                                       IAS2Session aSession,
                                       @Nullable
                                       com.helger.commons.collection.attr.IStringMap aOptions)
                                throws AS2Exception

Description copied from interface: IDynamicComponent

After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.

Specified by:

initDynamicComponent in interface IDynamicComponent

Overrides:

initDynamicComponent in class AbstractDynamicComponent

Parameters:

aSession - the component uses this object to access other components

aOptions - configuration values for the component. All parameters will be stored as attributes of this component. All attributes existing before this method is called will be removed!

Throws:

AS2Exception - If an error occurs while initializing the component

AS2InvalidParameterException - If a required parameter is null in the parameters Map

See Also:

IAS2Session

getFilename

protected abstract String getFilename(IMessage aMsg,
                                      String sFileParam)
                               throws AS2InvalidParameterException

Throws:

AS2InvalidParameterException

getFile

@Nonnull
@OverrideOnDemand
protected File getFile(@Nonnull
                       IMessage aMsg,
                       @Nullable
                       String sFileParam)
                throws IOException,
                       AS2Exception

Not final - see #105

Parameters:

aMsg - The source message

sFileParam - The parameter name including the filename

Returns:

File The File to be used

Throws:

IOException - In case of IO error

AS2Exception - In case of error

Since:

2007-06-01

store

protected void store(@Nonnull
                     File aMsgFile,
                     @Nonnull @WillClose
                     InputStream aIS)
              throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent