Package com.helger.as2lib.processor.resender

Class InMemoryResenderModule

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.InMemoryResenderModule

All Implemented Interfaces:

IDynamicComponent, IProcessorActiveModule, IProcessorModule, IProcessorResenderModule

public class InMemoryResenderModule
extends AbstractActiveResenderModule

An asynchronous, in-memory, polling based resender module. Upon handle(String, IMessage, Map) the document is added to a queue there is a background poller task that checks for resending (see resend() ). If resending fails an exception is thrown.

Since:

2.2.0

Author:

Philip Helger

Field Summary

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
InMemoryResenderModule()

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
void	doStop()	Implement the internal stop logic.
com.helger.commons.collection.impl.ICommonsList<ResendItem>	getAllResendItems()
int	getResendItemCount()
void	handle(String sAction, IMessage aMsg, Map<String,Object> aOptions)	Main handling of the message.
void	removeAllResendItems()	Remove all resend items.
void	resend()
protected void	resendItem(ResendItem aItem)

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

doStart, equals, getResendDelayMS, hashCode, initDynamicComponent

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

Constructor Detail

InMemoryResenderModule

public InMemoryResenderModule()

Method Detail

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.

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

resendItem

protected void resendItem(@Nonnull
                          ResendItem aItem)
                   throws AS2Exception

Throws:

AS2Exception

resend

public void resend()

Specified by:

resend in class AbstractActiveResenderModule

getResendItemCount

@Nonnegative
public int getResendItemCount()

removeAllResendItems

public void removeAllResendItems()

Remove all resend items.

getAllResendItems

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<ResendItem> getAllResendItems()

doStop

public void doStop()
            throws AS2Exception

Description copied from class: AbstractActiveModule

Implement the internal stop logic.

Overrides:

doStop in class AbstractActiveResenderModule

Throws:

AS2Exception - In case of an error.