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, Serializable

Direct Known Subclasses:

MDNFileModule, MessageFileModule

public abstract class AbstractStorageModule
extends AbstractProcessorModule
implements IProcessorStorageModule

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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 and Description
protected	AbstractStorageModule(String sModuleAction)

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(String sAction, IMessage aMsg, Map<String,Object> aOptions)
protected Charset	getCharset()
protected File	getFile(IMessage aMsg, String sFileParam, String sAction)
protected abstract String	getFilename(IMessage aMsg, String sFileParam, String sAction)
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.
protected void	store(File aMsgFile, InputStream aIS)

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, equals, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, hashCode, toString

Methods inherited from class java.lang.Object

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

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

handle

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession

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

canHandle

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

Specified by:

canHandle in interface IProcessorModule

initDynamicComponent

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

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:

OpenAS2Exception - If an error occurs while initializing the component

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

See Also:

IAS2Session

getCharset

@Nonnull
protected Charset getCharset()

Returns:

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

getFile

protected File getFile(IMessage aMsg,
                       String sFileParam,
                       String sAction)
                throws IOException,
                       OpenAS2Exception

Parameters:

aMsg - The source message

sFileParam - The parameter name including the filename

sAction - Action name

Returns:

File The File to be used

Throws:

IOException - In case of IO error

OpenAS2Exception - In case of error

Since:

2007-06-01

getFilename

protected abstract String getFilename(IMessage aMsg,
                                      String sFileParam,
                                      String sAction)
                               throws InvalidParameterException

Throws:

InvalidParameterException

store

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

Throws:

IOException