com.adaptris.core

Class AdapterStateSummary

java.lang.Object

com.adaptris.core.AdapterStateSummary

public class AdapterStateSummary
extends java.lang.Object

Summary of the state of an Adapter and associated Channels

In the adapter configuration file this class is aliased as adapter-state-summary which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
AdapterStateSummary()
AdapterStateSummary(Adapter adapter) Utility constructor that summarises the current state of the passed Adapter.

Method Summary

Modifier and Type	Method and Description
void	addChannelState(KeyValuePair state) Adds the state of a Channel to the internal store.
void	addChannelState(java.lang.String uniqueId, ComponentState state) Adds the state of a Channel to the internal store.
KeyValuePair	getAdapterState() Returns the state of the Adapter.
KeyValuePairSet	getChannelStates()
java.lang.String	getLastStartTime()
java.lang.String	getLastStopTime()
void	setAdapterState(KeyValuePair state) Sets the state of the Adapter.
void	setAdapterState(java.lang.String uniqueId, ComponentState state) Sets the state of the Adapter.
void	setChannelStates(KeyValuePairSet states)
void	setLastStartTime(java.lang.String lastStartTime)
void	setLastStopTime(java.lang.String lastStopTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdapterStateSummary

public AdapterStateSummary()

AdapterStateSummary

public AdapterStateSummary(Adapter adapter)

Utility constructor that summarises the current state of the passed Adapter.

Parameters:

adapter - the Adapter to report the state of

Method Detail

setAdapterState

public void setAdapterState(java.lang.String uniqueId,
                            ComponentState state)

Sets the state of the Adapter.

Parameters:

uniqueId - the unique ID, may not be null or empty

state - the state, may not be null or empty

setAdapterState

public void setAdapterState(KeyValuePair state)

Sets the state of the Adapter.

Parameters:

state - a KeyValuePair of state against unique ID

getAdapterState

public KeyValuePair getAdapterState()

Returns the state of the Adapter.

Returns:

the state of the Adapter

addChannelState

public void addChannelState(java.lang.String uniqueId,
                            ComponentState state)

Adds the state of a Channel to the internal store. If state for the passed unique ID has already been stored it will be over-written. Non-uniquely identified Channels are ignored.

Parameters:

uniqueId - the unique ID of the Channel

state - the state may not be null

addChannelState

public void addChannelState(KeyValuePair state)

Adds the state of a Channel to the internal store.

Parameters:

state - the state of the Channel to add

getChannelStates

public KeyValuePairSet getChannelStates()

setChannelStates

public void setChannelStates(KeyValuePairSet states)

getLastStartTime

public java.lang.String getLastStartTime()

setLastStartTime

public void setLastStartTime(java.lang.String lastStartTime)

getLastStopTime

public java.lang.String getLastStopTime()

setLastStopTime

public void setLastStopTime(java.lang.String lastStopTime)