com.adaptris.core

Class Event

java.lang.Object

com.adaptris.core.Event

Direct Known Subclasses:

AdapterLifecycleEvent, MessageLifecycleEvent

public abstract class Event
extends java.lang.Object

Contains behaviour common to all Events in the framework.

Note on unique ids: initially UID was generated for each new Event instance and immutable. I.e. a 'system' level UID. This meant that if an Event was marshalled then unmarshalled it would have a different UID. This has been changed to an 'application' level UID, which doesn't change during marshalling / unmarshalling.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	createNameSpace() Creates the hierarchical name space for this event.
long	getCreationTime() Returns the creation time of this Event.
java.lang.String	getDestinationId() Returns the unique ID of the destination Adapter (or other entity such as a GUI).
java.lang.String	getNameSpace() Returns the immutable name space of this Event.
java.lang.String	getSourceId() Returns the unique ID of the source Adapter (or other entity such as a GUI).
java.lang.String	getUniqueId() Returns the Event's unique ID.
void	setCreationTime(long l) Sets the creation time of this Event.
void	setDestinationId(java.lang.String s) Sets the unique ID of the destination Adapter (or other entity such as a GUI).
void	setSourceId(java.lang.String s) Sets the unique ID of the source Adapter (or other entity such as a GUI).
void	setUniqueId(java.lang.String s) Sets the Event's unique ID.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

Event

protected Event()

Event

protected Event(java.lang.String s)

Creates a new instance with passed name space.

Parameters:

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

Method Detail

createNameSpace

public java.lang.String createNameSpace()

Creates the hierarchical name space for this event.

The namespace is made up of the configured (or default namespace for the event, plus the source adapter unique id, plus the destination adapter id. These elements are separated by '.', the configured name space may contain '.' delimiters as required and destination id may be null.

Returns:

the Event's name space

setUniqueId

public void setUniqueId(java.lang.String s)

Sets the Event's unique ID.

Parameters:

s - the Event's unique ID, may not be null or empty

getUniqueId

public java.lang.String getUniqueId()

Returns the Event's unique ID.

Returns:

the Event's unique ID

setDestinationId

public void setDestinationId(java.lang.String s)

Sets the unique ID of the destination Adapter (or other entity such as a GUI). This is optional.

Parameters:

s - the unique ID of the destination Adapter

getDestinationId

public java.lang.String getDestinationId()

Returns the unique ID of the destination Adapter (or other entity such as a GUI).

Returns:

the unique ID of the destination Adapter

setSourceId

public void setSourceId(java.lang.String s)

Sets the unique ID of the source Adapter (or other entity such as a GUI).

Parameters:

s - the unique ID of the source Adapter

getSourceId

public java.lang.String getSourceId()

Returns the unique ID of the source Adapter (or other entity such as a GUI).

Returns:

the unique ID of the source Adapter

setCreationTime

public void setCreationTime(long l)

Sets the creation time of this Event.

Parameters:

l - the creation time of this Event

getCreationTime

public long getCreationTime()

Returns the creation time of this Event.

Returns:

the creation time of this Event

getNameSpace

public java.lang.String getNameSpace()

Returns the immutable name space of this Event.

Returns:

the namespace of this Event