atg.epub.purge

Class PurgeEvent

java.lang.Object

atg.epub.purge.PurgeEvent

public class PurgeEvent
extends java.lang.Object

A purge event denoting the start and end of a purge process.

Deployment events are generic in structure and are keyed off of a set of state codes defined as constants in the event. Each time a deployment or deployment agent changes state, a deployment event is fired with relevant information.

DeploymentEvents also provide the ability to interrupt the deployment process. If a DeploymentEventListener receives a deployment event and needs to halt the deployment process, the listener can call interrupt() on the deployment event. Interrupted deployments are treated the same as if an error occurred during the deployment process.

See Also:

PurgeEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	END_STATE_FAILURE This state means that a purge has ended in failure.
static int	END_STATE_SUCCESS This state means that a purge has ended successfully.
static int	PRE_COMMIT_STATE This state means that a purge is about to commits its work.
static int	START_STATE

Constructor Summary

Constructors

Constructor and Description
PurgeEvent(java.sql.Timestamp pPurgeTime, int pState)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInterruptCaller() Who is interrupting this event, if it is interrupted.
java.lang.String	getInterruptReason() Why this event is being interrupted, if it is being interrupted.
java.sql.Timestamp	getPurgeCutOff() Time to be used as purge criteria
int	getState() Purge state one of START_STATE, PRE_COMMIT_STATE, END_STATE_SUCCESS, END_STATE_FAILURE
boolean	interrupt(java.lang.String pCaller, java.lang.String pReason) Call this method if you wish to adandon the current purge process.
boolean	isInterrupted() Whether or not this event has been interrupted.

Methods inherited from class java.lang.Object

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

Field Detail

START_STATE

public static int START_STATE

PRE_COMMIT_STATE

public static int PRE_COMMIT_STATE

This state means that a purge is about to commits its work.

END_STATE_SUCCESS

public static int END_STATE_SUCCESS

This state means that a purge has ended successfully.

END_STATE_FAILURE

public static int END_STATE_FAILURE

This state means that a purge has ended in failure.

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

PurgeEvent

public PurgeEvent(java.sql.Timestamp pPurgeTime,
                  int pState)

Method Detail

isInterrupted

public boolean isInterrupted()

Whether or not this event has been interrupted.

Returns:

boolean

getInterruptCaller

public java.lang.String getInterruptCaller()

Who is interrupting this event, if it is interrupted.

Returns:

String

getInterruptReason

public java.lang.String getInterruptReason()

Why this event is being interrupted, if it is being interrupted.

Returns:

String

interrupt

public boolean interrupt(java.lang.String pCaller,
                         java.lang.String pReason)

Call this method if you wish to adandon the current purge process. Note that you can call this from a purge "end" event too to abandon the purge. It might take a while to rollback a transaction for purge which is already at the end event state.

Parameters:

pCaller -

pReason -

Returns:

getState

public int getState()

Purge state one of START_STATE, PRE_COMMIT_STATE, END_STATE_SUCCESS, END_STATE_FAILURE

Returns:

getPurgeCutOff

public java.sql.Timestamp getPurgeCutOff()

Time to be used as purge criteria

Returns: