Package org.openas2.schedule

Class SchedulerComponent

java.lang.Object

org.openas2.BaseComponent

org.openas2.schedule.SchedulerComponent

All Implemented Interfaces:

Component

public class SchedulerComponent
extends BaseComponent

Scheduler module for periodic tasks.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAMETER_THREADS

Constructor Summary

Constructors

Constructor	Description
SchedulerComponent()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Component lifecycle hook.
void	init(Session session, java.util.Map<java.lang.String,java.lang.String> parameters)	Component lifecycle hook.

Methods inherited from class org.openas2.BaseComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_THREADS

public static final java.lang.String PARAMETER_THREADS

See Also:

Constant Field Values

Constructor Detail

SchedulerComponent

public SchedulerComponent()

Method Detail

init

public void init(Session session,
                 java.util.Map<java.lang.String,java.lang.String> parameters)
          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

parameters - configuration values for the component

Throws:

OpenAS2Exception - If an error occurs while initializing the component

See Also:

Session

destroy

public void destroy()
             throws java.lang.Exception

Description copied from interface: Component

Component lifecycle hook. If lifecycle of Component requires a destroy function this method can be used.

Specified by:

destroy in interface Component

Overrides:

destroy in class BaseComponent

Throws:

java.lang.Exception - Something went wrong

See Also:

Component.init(Session, Map), Session