Package org.openas2.processor.msgtracking

Class BaseMsgTrackingModule

java.lang.Object

org.openas2.BaseComponent

org.openas2.processor.BaseProcessorModule

org.openas2.processor.msgtracking.BaseMsgTrackingModule

All Implemented Interfaces:

Component, ActiveModule, TrackingModule, ProcessorModule

Direct Known Subclasses:

DbTrackingModule

public abstract class BaseMsgTrackingModule
extends BaseProcessorModule
implements TrackingModule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseMsgTrackingModule.FIELDS

Field Summary

Fields inherited from interface org.openas2.processor.msgtracking.TrackingModule

DO_TRACK_MSG, TRACK_MSG_TCP_SERVER

Constructor Summary

Constructors

Constructor	Description
BaseMsgTrackingModule()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	buildMap(Message msg, Map<Object,Object> options)
boolean	canHandle(String action, Message msg, Map<Object,Object> options)
protected abstract String	getModuleAction()
void	handle(String action, Message msg, Map<Object,Object> options)
void	init(Session session, Map<String,String> options)	Component lifecycle hook.
protected abstract void	persist(Message msg, Map<String,String> map)

Methods inherited from interface org.openas2.processor.ActiveModule

healthcheck, isRunning, start, stop

Methods inherited from class org.openas2.BaseComponent

destroy, getName, getParameter, getParameter, getParameterInt, getParameters, getSession, setParameter, setParameter

Methods inherited from interface org.openas2.Component

destroy, getName, getParameters, getSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseMsgTrackingModule

public BaseMsgTrackingModule()

Method Detail

handle

public void handle(String action,
                   Message msg,
                   Map<Object,Object> options)
            throws OpenAS2Exception

Specified by:

handle in interface ProcessorModule

Throws:

OpenAS2Exception

canHandle

public boolean canHandle(String action,
                         Message msg,
                         Map<Object,Object> options)

Specified by:

canHandle in interface ProcessorModule

init

public void init(Session session,
                 Map<String,String> options)
          throws OpenAS2Exception

Description copied from interface: Component

Component lifecycle hook. 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:

init in interface Component

Overrides:

init in class BaseComponent

Parameters:

session - the component uses this object to access other components

options - configuration values for the component

Throws:

OpenAS2Exception - If an error occurs while initializing the component

See Also:

Session

getModuleAction

protected abstract String getModuleAction()

persist

protected abstract void persist(Message msg,
                                Map<String,String> map)

buildMap

protected Map<String,String> buildMap(Message msg,
                                      Map<Object,Object> options)