com.adaptris.core

Class ComponentStateImp

java.lang.Object

com.adaptris.core.ComponentStateImp

All Implemented Interfaces:

ComponentState, java.io.Serializable

Direct Known Subclasses:

ClosedState, InitialisedState, StartedState, StoppedState

public abstract class ComponentStateImp
extends java.lang.Object
implements ComponentState

Default implementation of ComponentState. Each default method implementation does nothing other than request the same operation on any StateManagedComponents which are sub-components of comp. This is required if for example an Adapter is started and one of its Channels is stopped. requestStart has nothing to do at the Adapter level but must still be propogated to the stopped Channel which does require manipulation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ComponentStateImp()

Method Summary

Modifier and Type	Method and Description
void	requestClose(StateManagedComponent comp) Perform operations required to move comp from this state to ClosedState, if possible.
void	requestInit(StateManagedComponent comp) Perform operations required to move comp from this state to InitialisedState, if possible.
void	requestRestart(StateManagedComponent comp) Perform operations required to restart the comp.
void	requestStart(StateManagedComponent comp) Perform operations required to move comp from this state to StartedState, if possible.
void	requestStop(StateManagedComponent comp) Perform operations required to move comp from this state to StoppedState, if possible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

ComponentStateImp

public ComponentStateImp()

Method Detail

requestInit

public void requestInit(StateManagedComponent comp)
                 throws CoreException

Description copied from interface: ComponentState

Perform operations required to move comp from this state to InitialisedState, if possible.

Specified by:

requestInit in interface ComponentState

Parameters:

comp - the StateManagedComponent to manipulate

Throws:

CoreException - wrapping any underlying exceptions

See Also:

(com.adaptris.core.StateManagedComponent)

requestStart

public void requestStart(StateManagedComponent comp)
                  throws CoreException

Description copied from interface: ComponentState

Perform operations required to move comp from this state to StartedState, if possible.

Specified by:

requestStart in interface ComponentState

Parameters:

comp - the StateManagedComponent to manipulate

Throws:

CoreException - wrapping any underlying exceptions

See Also:

(com.adaptris.core.StateManagedComponent)

requestStop

public void requestStop(StateManagedComponent comp)

Description copied from interface: ComponentState

Perform operations required to move comp from this state to StoppedState, if possible.

Specified by:

requestStop in interface ComponentState

Parameters:

comp - the StateManagedComponent to manipulate

See Also:

(com.adaptris.core.StateManagedComponent)

requestClose

public void requestClose(StateManagedComponent comp)

Description copied from interface: ComponentState

Perform operations required to move comp from this state to ClosedState, if possible.

Specified by:

requestClose in interface ComponentState

Parameters:

comp - the StateManagedComponent to manipulate

See Also:

(com.adaptris.core.StateManagedComponent)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

requestRestart

public void requestRestart(StateManagedComponent comp)
                    throws CoreException

Description copied from interface: ComponentState

Perform operations required to restart the comp. Differs from start in that underlying components which are in the StartedState will be stopped, closed, inited and started.

Specified by:

requestRestart in interface ComponentState

Parameters:

comp - the StateManagedComponent to manipulate

Throws:

CoreException - wrapping any underlying exceptions

See Also:

ComponentState.requestRestart(com.adaptris.core.StateManagedComponent)