Package org.openas2.processor.receiver

Class PollingModule

java.lang.Object

org.openas2.BaseComponent

org.openas2.processor.BaseProcessorModule

org.openas2.processor.BaseActiveModule

org.openas2.processor.receiver.BaseReceiverModule

org.openas2.processor.receiver.MessageBuilderModule

org.openas2.processor.receiver.PollingModule

All Implemented Interfaces:

Component, ActiveModule, ProcessorModule, ReceiverModule

Direct Known Subclasses:

DirectoryPollingModule

public abstract class PollingModule
extends MessageBuilderModule

Field Summary

Fields inherited from class org.openas2.processor.receiver.MessageBuilderModule

PARAM_DEFAULTS, PARAM_DELIMITERS, PARAM_ERROR_DIRECTORY, PARAM_FORMAT, PARAM_MIMETYPE, PARAM_RESEND_MAX_RETRIES, PARAM_SENT_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
PollingModule()

Method Summary

Modifier and Type	Method	Description
void	doStart()
void	doStop()
void	init(Session session, Map<String,String> options)	Component lifecycle hook.
abstract void	poll()

Methods inherited from interface org.openas2.processor.ActiveModule

healthcheck, isRunning, start, stop

Methods inherited from class org.openas2.processor.BaseActiveModule

canHandle, forceStop, handle, healthcheck, isRunning, start, stop, toString

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 org.openas2.processor.receiver.MessageBuilderModule

buildMessageData, buildMessageMetadata, createMessage, processDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openas2.processor.ProcessorModule

canHandle, handle

Constructor Detail

PollingModule

public PollingModule()

Method Detail

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 MessageBuilderModule

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

poll

public abstract void poll()

doStart

public void doStart()
             throws OpenAS2Exception

Specified by:

doStart in class BaseActiveModule

Throws:

OpenAS2Exception

doStop

public void doStop()
            throws OpenAS2Exception

Specified by:

doStop in class BaseActiveModule

Throws:

OpenAS2Exception