org.ikasan.framework.event.wiretap.model
Class WiretapEventHeader

java.lang.Object
  org.ikasan.framework.event.wiretap.model.WiretapEventHeader

All Implemented Interfaces:

Serializable, Comparable<WiretapEventHeader>

Direct Known Subclasses:

WiretapEvent

public class WiretapEventHeader
extends Object
implements Comparable<WiretapEventHeader>, Serializable

The Header for a Wiretap event

Author:

Ikasan Development Team

See Also:

Serialized Form

Field Summary

protected String	componentName Wiretap component name
protected Date	created Created date/time
protected String	eventId Event id
protected Date	expiry Time after which this WiretapEvent should be cleaned up
protected String	flowName Flow name
protected Long	id Dao assigned id
protected String	moduleName Module name
protected Long	nextByPayload Next WiretapEvent (if any) for this payload
protected String	payloadId Payload id
protected Long	previousByPayload Previous WiretapEvent (if any) for this payload

Constructor Summary

protected	WiretapEventHeader() Constructor
	WiretapEventHeader(String moduleName, String flowName, String componentName, String eventId, String payloadId, Date expiry) Constructor

Method Summary

int	compareTo(WiretapEventHeader other)
String	getComponentName() Getter for componentName
Date	getCreated() Getter for date/time created
String	getEventId() Getter for eventId
Date	getExpiry() Getter for expiry
String	getFlowName() Getter for flowName
Long	getId() Getter for id
String	getModuleName() Getter for moduleName
Long	getNextByPayload() Accessor for nextByPayload
String	getPayloadId() Getter for payloadId
Long	getPreviousByPayload() Accessor for previousByPayload
protected void	setComponentName(String componentName) Setter for component name
protected void	setCreated(Date created) Setter for created date/time
protected void	setEventId(String eventId) Setter for event id
protected void	setExpiry(Date expiry) Setter for expiry
protected void	setFlowName(String flowName) Setter for flow name
void	setId(Long id) Setter for id
protected void	setModuleName(String moduleName) Setter for module name
void	setNextByPayload(Long nextByPayload) Setter for nextByPayload
protected void	setPayloadId(String payloadId) Setter for payload id
void	setPreviousByPayload(Long previousByPayload) Setter for previousByPayload
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

Dao assigned id

moduleName

protected String moduleName

Module name

flowName

protected String flowName

Flow name

componentName

protected String componentName

Wiretap component name

eventId

protected String eventId

Event id

payloadId

protected String payloadId

Payload id

created

protected Date created

Created date/time

expiry

protected Date expiry

Time after which this WiretapEvent should be cleaned up

nextByPayload

protected transient Long nextByPayload

Next WiretapEvent (if any) for this payload

previousByPayload

protected transient Long previousByPayload

Previous WiretapEvent (if any) for this payload

Constructor Detail

WiretapEventHeader

public WiretapEventHeader(String moduleName,
                          String flowName,
                          String componentName,
                          String eventId,
                          String payloadId,
                          Date expiry)

Constructor

Parameters:

moduleName - The name of the module

flowName - The name of the flow

componentName - The name of the component

eventId - The event id

payloadId - The payload id

expiry - The time to expire

WiretapEventHeader

protected WiretapEventHeader()

Constructor

Method Detail

getComponentName

public String getComponentName()

Getter for componentName

Returns:

componentName

getCreated

public Date getCreated()

Getter for date/time created

Returns:

date/time created

getEventId

public String getEventId()

Getter for eventId

Returns:

eventId

getFlowName

public String getFlowName()

Getter for flowName

Returns:

flowName

getId

public Long getId()

Getter for id

Returns:

id

getModuleName

public String getModuleName()

Getter for moduleName

Returns:

moduleName

getPayloadId

public String getPayloadId()

Getter for payloadId

Returns:

payloadId

getExpiry

public Date getExpiry()

Getter for expiry

Returns:

expiry date

setComponentName

protected void setComponentName(String componentName)

Setter for component name

Parameters:

componentName - - The name of the component to set

setCreated

protected void setCreated(Date created)

Setter for created date/time

Parameters:

created - - The created date time to set

setEventId

protected void setEventId(String eventId)

Setter for event id

Parameters:

eventId - - The Event id to set

setFlowName

protected void setFlowName(String flowName)

Setter for flow name

Parameters:

flowName - - The name of the flow to set

setId

public void setId(Long id)

Setter for id

Parameters:

id - - The wire tap header id to set

setModuleName

protected void setModuleName(String moduleName)

Setter for module name

Parameters:

moduleName - - The module name to set

setPayloadId

protected void setPayloadId(String payloadId)

Setter for payload id

Parameters:

payloadId - - The payload id to set

setExpiry

protected void setExpiry(Date expiry)

Setter for expiry

Parameters:

expiry - - The time to expire

compareTo

public int compareTo(WiretapEventHeader other)

Specified by:

compareTo in interface Comparable<WiretapEventHeader>

getNextByPayload

public Long getNextByPayload()

Accessor for nextByPayload

Returns:

id for next WiretapEvent related by payload

setNextByPayload

public void setNextByPayload(Long nextByPayload)

Setter for nextByPayload

Parameters:

nextByPayload - id for next WiretapEvent related by payload

getPreviousByPayload

public Long getPreviousByPayload()

Accessor for previousByPayload

Returns:

id for previous WiretapEvent related by payload

setPreviousByPayload

public void setPreviousByPayload(Long previousByPayload)

Setter for previousByPayload

Parameters:

previousByPayload - id for previous WiretapEvent related by payload

toString

public String toString()

Overrides:

toString in class Object