Package com.helger.as2lib.processor.resender

Class DirectoryResenderModule

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.processor.module.AbstractProcessorModule

com.helger.as2lib.processor.module.AbstractActiveModule

com.helger.as2lib.processor.resender.AbstractActiveResenderModule

com.helger.as2lib.processor.resender.DirectoryResenderModule

All Implemented Interfaces:

IDynamicComponent, IProcessorActiveModule, IProcessorModule, IProcessorResenderModule

public class DirectoryResenderModule
extends AbstractActiveResenderModule

An asynchronous, persisting, file based, polling resender module. Upon handle(String, IMessage, Map) it writes the document into a file and there is a background poller task that checks for resending (see resend()). If re-sending fails, the document is moved into an error folder.

Author:

OpenAS2, Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_ERROR_DIRECTORY	The error directory.
static final String	ATTR_RESEND_DIRECTORY
static final String	ATTR_STORED_ERROR_FILENAME	Optional filename for storage in the error directory.

Fields inherited from class com.helger.as2lib.processor.resender.AbstractActiveResenderModule

ATTR_POLLING_INTERVAL_SECONDS, ATTR_RESEND_DELAY_SECONDS, DEFAULT_POLLING_MS, DEFAULT_RESEND_DELAY_MS

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Fields inherited from interface com.helger.as2lib.processor.resender.IProcessorResenderModule

DEFAULT_RETRIES, DO_RESEND, DO_RESENDMDN, OPTION_CAUSE, OPTION_INITIAL_SENDER, OPTION_RESEND_ACTION, OPTION_RETRIES

Constructor Summary

Constructors

Constructor	Description
DirectoryResenderModule()

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
protected String	getFilename()	Build the filename for re-sending.
void	handle(String sAction, IMessage aMsg, Map<String,Object> aOptions)	Main handling of the message.
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 boolean	isTimeToSend(File aCurrentFile)
void	resend()
protected void	resendFile(File aFile)
protected com.helger.commons.collection.impl.ICommonsList<File>	scanDirectory()

Methods inherited from class com.helger.as2lib.processor.resender.AbstractActiveResenderModule

doStart, doStop, equals, getResendDelayMS, hashCode

Methods inherited from class com.helger.as2lib.processor.module.AbstractActiveModule

forceStop, isRunning, start, stop, toString

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession

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

Field Details

ATTR_RESEND_DIRECTORY

public static final String ATTR_RESEND_DIRECTORY

See Also:

• Constant Field Values

ATTR_ERROR_DIRECTORY

public static final String ATTR_ERROR_DIRECTORY

The error directory. May contain "date" parameters.

See Also:

• Constant Field Values

ATTR_STORED_ERROR_FILENAME

public static final String ATTR_STORED_ERROR_FILENAME

Optional filename for storage in the error directory. May contain "date" parameters.

Since:

4.8.0

See Also:

• Constant Field Values

Constructor Details

DirectoryResenderModule

public DirectoryResenderModule()

Method Details

initDynamicComponent

public 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 AbstractActiveResenderModule

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

canHandle

public 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

Overrides:

canHandle in class AbstractActiveModule

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.

getFilename

@Nonnull
protected String getFilename()
                      throws AS2InvalidParameterException

Build the filename for re-sending. The filename consists of the date and time when the document is to be re-send.

Returns:

The filename and never null.

Throws:

AS2InvalidParameterException - Only theoretically

handle

public void handle(@Nonnull
 String sAction,
 @Nonnull
 IMessage aMsg,
 @Nullable
 Map<String,Object> aOptions)
            throws AS2Exception

Description copied from interface: IProcessorModule

Main handling of the message. Only called, if IProcessorModule.canHandle(String, IMessage, Map) returned true.

Specified by:

handle in interface IProcessorModule

Overrides:

handle in class AbstractActiveModule

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.

Throws:

AS2Exception - in case something goes wrong

isTimeToSend

protected boolean isTimeToSend(@Nonnull
 File aCurrentFile)

resendFile

protected void resendFile(@Nonnull
 File aFile)
                   throws AS2Exception

Throws:

AS2Exception

scanDirectory

@Nonnull
@ReturnsMutableCopy
protected com.helger.commons.collection.impl.ICommonsList<File> scanDirectory()
                                                                       throws AS2InvalidParameterException

Returns:

A list with all files that are ready to be resend.

Throws:

AS2InvalidParameterException - In case the directory listing fails

resend

public void resend()

Specified by:

resend in class AbstractActiveResenderModule