com.adaptris.core

Class AdapterLifecycleEvent

java.lang.Object

com.adaptris.core.Event

com.adaptris.core.AdapterLifecycleEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdapterCloseEvent, AdapterInitEvent, AdapterShutdownEvent, AdapterStartEvent, AdapterStartUpEvent, AdapterStopEvent, ChannelRestartEvent, HeartbeatEvent, LicenseExpiryWarningEvent

public abstract class AdapterLifecycleEvent
extends Event
implements java.io.Serializable

Contains behaviour common to all Events in the framework which relate to an Adapter's lifecycle.

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.adaptris.core.Event

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdapterLifecycleEvent(java.lang.String s) Creates a new instance with passed name space.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdapterUniqueId() Returns the unique ID of the adapter emitting this event.
java.lang.String	getNameSpace() Returns the name space of this Event.
boolean	getWasSuccessful() Returns true if the adapter life cycle event occurred successfully, otherwise false.
void	setAdapterUniqueId(java.lang.String string) Sets the unique ID of the adapter emitting this event.
void	setWasSuccessful(boolean b) Sets the success or otherwise of the adapter life cycle event.

Methods inherited from class com.adaptris.core.Event

createNameSpace, getCreationTime, getDestinationId, getSourceId, getUniqueId, setCreationTime, setDestinationId, setSourceId, setUniqueId

Methods inherited from class java.lang.Object

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

Constructor Detail

AdapterLifecycleEvent

protected AdapterLifecycleEvent(java.lang.String s)

Creates a new instance with passed name space. Used by concrete sub classes. Success defaults to true.

Parameters:

s - the name space of this Event, may not be null or empty

Method Detail

getNameSpace

public java.lang.String getNameSpace()

Returns the name space of this Event. Over-rides implementation in Event and adds .fail or .success to the end of the original name space, based on calling getWasSuccessful.

Overrides:

getNameSpace in class Event

Returns:

the namespace of this Event

getAdapterUniqueId

public java.lang.String getAdapterUniqueId()

Returns the unique ID of the adapter emitting this event.

Returns:

the unique ID of the adapter emitting this event

setAdapterUniqueId

public void setAdapterUniqueId(java.lang.String string)

Sets the unique ID of the adapter emitting this event.

Parameters:

string - the unique ID of the adapter emitting this event

getWasSuccessful

public boolean getWasSuccessful()

Returns true if the adapter life cycle event occurred successfully, otherwise false.

Returns:

true if the adapter life cycle event occurred successfully.

setWasSuccessful

public void setWasSuccessful(boolean b)

Sets the success or otherwise of the adapter life cycle event.

Parameters:

b - the success or otherwise of the adapter life cycle event