Package com.helger.as2lib.processor.module

Class AbstractActiveModule

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.processor.module.AbstractProcessorModule

com.helger.as2lib.processor.module.AbstractActiveModule

All Implemented Interfaces:

IDynamicComponent, IProcessorActiveModule, IProcessorModule

Direct Known Subclasses:

AbstractActiveReceiverModule, AbstractActiveResenderModule

public abstract class AbstractActiveModule
extends AbstractProcessorModule
implements IProcessorActiveModule

Abstract base implementation for IProcessorActiveModule derived from AbstractProcessorModule.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Constructor Summary

Constructors

Constructor	Description
AbstractActiveModule()

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
abstract void	doStart()	Implement the internal start logic.
abstract void	doStop()	Implement the internal stop logic.
boolean	equals(Object o)
void	forceStop(Exception aCause)
void	handle(String sAction, IMessage aMsg, Map<String,Object> aOptions)	Main handling of the message.
int	hashCode()
final boolean	isRunning()
void	start()	Start the module
void	stop()	Stop the module
String	toString()

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, initDynamicComponent

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

Constructor Details

AbstractActiveModule

public AbstractActiveModule()

Method Details

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface IProcessorActiveModule

Returns:

true of the module is running, false if not.

canHandle

@OverrideOnDemand
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

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

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

forceStop

public void forceStop(@Nullable
 Exception aCause)

doStart

public abstract void doStart()
                      throws AS2Exception

Implement the internal start logic.

Throws:

AS2Exception - In case of an error.

start

public void start()
           throws AS2Exception

Description copied from interface: IProcessorActiveModule

Start the module

Specified by:

start in interface IProcessorActiveModule

Throws:

AS2Exception - in case starting failed

doStop

public abstract void doStop()
                     throws AS2Exception

Implement the internal stop logic.

Throws:

AS2Exception - In case of an error.

stop

public void stop()
          throws AS2Exception

Description copied from interface: IProcessorActiveModule

Stop the module

Specified by:

stop in interface IProcessorActiveModule

Throws:

AS2Exception - in case stopping failed

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent

toString

public String toString()

Overrides:

toString in class AbstractDynamicComponent