com.tibco.xp.runtime

Class NonTransient

java.lang.Object

com.tibco.xp.runtime.Entity

com.tibco.xp.runtime.Event

com.tibco.xp.runtime.NonTransient

All Implemented Interfaces:

java.io.Serializable

@Managed
public abstract class NonTransient
extends Event

Base class for non-transient events

A non-transient event is one that has a TTL != 0.

Events with a TTL > 0 have an expiration timer started. When the expiration timer fires, the event is removed from shared memory

Events with a TTL < 0 do not have an expiration timer started. These events remain in shared memory until explicitly deleted by the application.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.tibco.xp.runtime.Event

_DEFAULT_RETRY_ON_EXCEPTION, _DEFAULT_TIME_TO_LIVE, _INVALID_TIMER_IDENTIFIER, _TIME_TO_LIVE_UNITS_DEFAULT, TIME_TO_LIVE_UNITS_DAYS, TIME_TO_LIVE_UNITS_HOURS, TIME_TO_LIVE_UNITS_MILLISECONDS, TIME_TO_LIVE_UNITS_MINUTES, TIME_TO_LIVE_UNITS_SECONDS

Fields inherited from class com.tibco.xp.runtime.Entity

INVALID_TYPE_IDENTIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NonTransient() Java constructor
protected	NonTransient(long id) Rule or Rule Function constructor

Method Summary

Modifier and Type	Method and Description
void	assertEvent() Assert an event.
void	delete() Delete this event.
protected static com.tibco.cep.runtime.model.event.EventContext	getChannelContext(NonTransient event) Get the channel context for an event
java.lang.String	getDestination() Get the event destination
protected java.lang.Boolean	getDispatched() Get the current dispatch state
PayLoad	getPayLoad() Get the event payload
java.lang.Boolean	getRetryOnException() Get the retry-on-exception value for this event.
java.lang.Long	getTimeToLive() Get the Time-To-Live value for this event.
java.lang.String	getTimeToLiveUnits() Get the Time-To-Live units for this event.
protected static void	setChannelContext(NonTransient event, com.tibco.cep.runtime.model.event.EventContext context) Set the channel context for an event
void	setDestination(java.lang.String destination) Set the event destination
protected void	setDispatched() Set dispatched to true
protected void	setRetryOnException(java.lang.Boolean retryOnException) Set retry on exception
protected void	setTimeToLive(java.lang.Long timeToLive) Set the time to live for this event
protected void	setTimeToLiveUnits(java.lang.String timeToLiveUnits) Set time to live units
java.lang.String	toString()
protected void	updatePayLoad(PayLoad payload) Update the internal payload
protected void	updateProperties() Update event handle properties from shared memory
protected abstract void	updateUserProperties(com.tibco.cep.runtime.model.event.impl.SimpleEventImpl eventImpl) Update user properties from shared memory

Methods inherited from class com.tibco.xp.runtime.Event

enforceDispatchState, generate, getPayload, setPayLoad, setPayload

Methods inherited from class com.tibco.xp.runtime.Entity

assertEntity, checkActive, getExtId, getHandle, getHandle, getId, load, mapArray, mapHandle, mapHandleArray, register

Methods inherited from class java.lang.Object

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

Constructor Detail

NonTransient

protected NonTransient()

Java constructor

NonTransient

protected NonTransient(long id)

Rule or Rule Function constructor

Parameters:

id - Unique identifier

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class Event

delete

public final void delete()

Delete this event.

If this event currently has a TTL expiration timer scheduled, the timer is canceled.

Specified by:

delete in class Event

getRetryOnException

public final java.lang.Boolean getRetryOnException()

Description copied from class: Event

Get the retry-on-exception value for this event.

Specified by:

getRetryOnException in class Event

Returns:

Retry on exception value

getTimeToLive

public final java.lang.Long getTimeToLive()

Description copied from class: Event

Get the Time-To-Live value for this event.

Specified by:

getTimeToLive in class Event

Returns:

TTL value

getTimeToLiveUnits

public final java.lang.String getTimeToLiveUnits()

Description copied from class: Event

Get the Time-To-Live units for this event.

Specified by:

getTimeToLiveUnits in class Event

Returns:

TTL units

assertEvent

public final void assertEvent()
                       throws ObjectNotUniqueError,
                              ResourceUnavailableException

Description copied from class: Event

Assert an event.

This method starts a new run-to-completion (RTC) cycle if one is not already active. If there is already an active RTC, this event is added to the current RTC agenda.

If this method started a new RTC cycle, it is complete when this method returns. If there is already an active RTC cycle, this event is just added to the current agenda and it will be executed at the end of the current conflict resolution cycle.

A new transaction is started if one is not already active.

RETE working memory is cleared at the end of the RTC cycle.

Overrides:

assertEvent in class Event

Throws:

ObjectNotUniqueError - Duplicate external identifier

ResourceUnavailableException - Rules engine not running

updateUserProperties

protected abstract void updateUserProperties(com.tibco.cep.runtime.model.event.impl.SimpleEventImpl eventImpl)

Update user properties from shared memory

Parameters:

eventImpl - Event handle to update

setRetryOnException

protected final void setRetryOnException(java.lang.Boolean retryOnException)

Description copied from class: Event

Set retry on exception

Specified by:

setRetryOnException in class Event

Parameters:

retryOnException - Retry on exception value

getPayLoad

public final PayLoad getPayLoad()

Description copied from class: Event

Get the event payload

Specified by:

getPayLoad in class Event

Returns:

The payload stored in this event.

setDestination

public final void setDestination(java.lang.String destination)

Description copied from class: Event

Set the event destination

The destination cannot be changed after an event has been asserted.

Destination cannot be null.

Specified by:

setDestination in class Event

Parameters:

destination - Destination value

getDestination

public final java.lang.String getDestination()

Description copied from class: Event

Get the event destination

Specified by:

getDestination in class Event

Returns:

The destination stored in this event.

updatePayLoad

protected final void updatePayLoad(PayLoad payload)

Description copied from class: Event

Update the internal payload

Specified by:

updatePayLoad in class Event

Parameters:

payload - Payload value

setTimeToLive

protected final void setTimeToLive(java.lang.Long timeToLive)

Description copied from class: Event

Set the time to live for this event

Specified by:

setTimeToLive in class Event

Parameters:

timeToLive - Time to live value.

setTimeToLiveUnits

protected final void setTimeToLiveUnits(java.lang.String timeToLiveUnits)

Description copied from class: Event

Set time to live units

Specified by:

setTimeToLiveUnits in class Event

Parameters:

timeToLiveUnits - Time to live units

getDispatched

protected final java.lang.Boolean getDispatched()

Description copied from class: Event

Get the current dispatch state

Specified by:

getDispatched in class Event

Returns:

True if dispatched, false otherwise

setDispatched

protected final void setDispatched()

Description copied from class: Event

Set dispatched to true

Specified by:

setDispatched in class Event

updateProperties

protected final void updateProperties()

Description copied from class: Event

Update event handle properties from shared memory

Specified by:

updateProperties in class Event

getChannelContext

protected static final com.tibco.cep.runtime.model.event.EventContext getChannelContext(NonTransient event)

Get the channel context for an event

Parameters:

event - Event event

Returns:

Channel context for this event, may be null

N.B. This method is static to prevent it from being dispatched on distributed objects since it is accessing local POJOs

setChannelContext

protected static final void setChannelContext(NonTransient event,
                                              com.tibco.cep.runtime.model.event.EventContext context)

Set the channel context for an event

Parameters:

event - Event

context - Channel context to set, may be null

N.B. This method is static to prevent it from being dispatched on distributed objects since it is accessing local POJOs