com.helger.as2lib.processor

Class AbstractMessageProcessor

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.processor.AbstractMessageProcessor

All Implemented Interfaces:

IDynamicComponent, IMessageProcessor

Direct Known Subclasses:

AsyncMessageProcessor, DefaultMessageProcessor

public abstract class AbstractMessageProcessor
extends AbstractDynamicComponent
implements IMessageProcessor

Abstract empty implementation of IMessageProcessor. It provides all methods except IMessageProcessor.handle(String, com.helger.as2lib.message.IMessage, java.util.Map).

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Fields inherited from interface com.helger.as2lib.processor.IMessageProcessor

ATTR_PENDINGMDN, ATTR_PENDINGMDNINFO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessageProcessor()

Method Summary

Modifier and Type	Method and Description
void	addModule(IProcessorModule aModule)
boolean	equals(Object o)
protected void	executeAction(String sAction, IMessage aMsg, Map<String,Object> aOptions) Execution the provided action with the registered modules.
com.helger.commons.collection.impl.ICommonsList<IProcessorActiveModule>	getAllActiveModules()
com.helger.commons.collection.impl.ICommonsList<IProcessorModule>	getAllModules()
<T extends IProcessorModule> com.helger.commons.collection.impl.ICommonsList<T>	getAllModulesOfClass(Class<T> aClass)
int	getModuleCount()
<T extends IProcessorModule> T	getModuleOfClass(Class<T> aClass)
int	hashCode()
com.helger.commons.state.EChange	removeModule(IProcessorModule aModule)
void	startActiveModules() Call start on all modules that implement the IProcessorActiveModule interface.
void	stopActiveModules() Call stop on all modules that implement the IProcessorActiveModule interface.

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, initDynamicComponent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.as2lib.processor.IMessageProcessor

getPendingMDNFolder, getPendingMDNInfoFolder, handle, setPendingMDNFolder, setPendingMDNInfoFolder

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession, initDynamicComponent

Constructor Detail

AbstractMessageProcessor

protected AbstractMessageProcessor()

Method Detail

addModule

public void addModule(@Nonnull
                      IProcessorModule aModule)

Specified by:

addModule in interface IMessageProcessor

removeModule

@Nonnull
public com.helger.commons.state.EChange removeModule(@Nullable
                                                               IProcessorModule aModule)

Specified by:

removeModule in interface IMessageProcessor

getModuleCount

@Nonnegative
public int getModuleCount()

Specified by:

getModuleCount in interface IMessageProcessor

getAllModules

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IProcessorModule> getAllModules()

Specified by:

getAllModules in interface IMessageProcessor

getModuleOfClass

@Nullable
public <T extends IProcessorModule> T getModuleOfClass(@Nonnull
                                                                  Class<T> aClass)

Specified by:

getModuleOfClass in interface IMessageProcessor

getAllModulesOfClass

@Nonnull
 @ReturnsMutableCopy
public <T extends IProcessorModule> com.helger.commons.collection.impl.ICommonsList<T> getAllModulesOfClass(@Nonnull
                                                                                                                                            Class<T> aClass)

Specified by:

getAllModulesOfClass in interface IMessageProcessor

getAllActiveModules

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IProcessorActiveModule> getAllActiveModules()

Specified by:

getAllActiveModules in interface IMessageProcessor

Returns:

A list of all modules, that implement the IProcessorActiveModule interface. Never null but maybe empty.

startActiveModules

public void startActiveModules()

Description copied from interface: IMessageProcessor

Call start on all modules that implement the IProcessorActiveModule interface.

Specified by:

startActiveModules in interface IMessageProcessor

stopActiveModules

public void stopActiveModules()

Description copied from interface: IMessageProcessor

Call stop on all modules that implement the IProcessorActiveModule interface.

Specified by:

stopActiveModules in interface IMessageProcessor

executeAction

protected final void executeAction(@Nonnull
                                   String sAction,
                                   @Nonnull
                                   IMessage aMsg,
                                   @Nullable
                                   Map<String,Object> aOptions)
                            throws AS2Exception

Execution the provided action with the registered modules.

Parameters:

sAction - Action to execute. Never null.

aMsg - Message it is about. Never null.

aOptions - Optional options map to be used. May be null.

Throws:

AS2Exception - In case of error

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent