com.ibm.di.api
Class Tombstone

java.lang.Object
  com.ibm.di.api.Tombstone

All Implemented Interfaces:

Serializable

public class Tombstone
extends Object
implements Serializable

This class is used to represent tombstone objects. Tombstone objects contain information for the termination of an AssemblyLine, EventHandler or Config Instance.

See Also:

Serialized Form

Field Summary

static String	PROPERTY_NAME_COMPONENT_NAME
static String	PROPERTY_NAME_COMPONENT_TYPE_ID
static String	PROPERTY_NAME_CONFIGURATION
static String	PROPERTY_NAME_CREATED_ON
static String	PROPERTY_NAME_ERROR_DESCR
static String	PROPERTY_NAME_EVENT_TYPE_ID
static String	PROPERTY_NAME_EXIT_CODE
static String	PROPERTY_NAME_GUID
static String	PROPERTY_NAME_START_TIME
static String	PROPERTY_NAME_STAT
static String	PROPERTY_NAME_USER_MESSAGE

Constructor Summary

Tombstone(Map aData)
Construct tombstone object from a map, containg tombstone properties.

Method Summary

String	getComponentName() Returns the name of the tombstone component (Config Instance, AssemblyLine or EventHandler).
int	getComponentTypeID() Returns component type ID.
String	getConfiguration() Returns the name of the configuration to which the AssemblyLine or EventHandler belonged.
String	getErrorDescription() Returns error description in case of abnormal tombstone component termination.
int	getEventTypeID() Returns event type ID.
int	getExitCode() Returns status indicator for how the tombstone component terminated.
String	getGUID() Returns tombstone Global Unique Identifier (GUID).
Date	getStartTime() Returns the start time of current tombstone component object (Config Instance, AssemblyLine or EventHandler).
Entry	getStatistics() Returns AssemblyLine's Entry statistis object.
Date	getTombstoneCreateTime() Returns tombstone record creation time.
String	getUserMessage() Returns the user specified tombstone message.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_COMPONENT_TYPE_ID

public static final String PROPERTY_NAME_COMPONENT_TYPE_ID

See Also:

Constant Field Values

PROPERTY_NAME_EVENT_TYPE_ID

public static final String PROPERTY_NAME_EVENT_TYPE_ID

See Also:

Constant Field Values

PROPERTY_NAME_START_TIME

public static final String PROPERTY_NAME_START_TIME

See Also:

Constant Field Values

PROPERTY_NAME_CREATED_ON

public static final String PROPERTY_NAME_CREATED_ON

See Also:

Constant Field Values

PROPERTY_NAME_COMPONENT_NAME

public static final String PROPERTY_NAME_COMPONENT_NAME

See Also:

Constant Field Values

PROPERTY_NAME_CONFIGURATION

public static final String PROPERTY_NAME_CONFIGURATION

See Also:

Constant Field Values

PROPERTY_NAME_EXIT_CODE

public static final String PROPERTY_NAME_EXIT_CODE

See Also:

Constant Field Values

PROPERTY_NAME_ERROR_DESCR

public static final String PROPERTY_NAME_ERROR_DESCR

See Also:

Constant Field Values

PROPERTY_NAME_STAT

public static final String PROPERTY_NAME_STAT

See Also:

Constant Field Values

PROPERTY_NAME_GUID

public static final String PROPERTY_NAME_GUID

See Also:

Constant Field Values

PROPERTY_NAME_USER_MESSAGE

public static final String PROPERTY_NAME_USER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

Tombstone

public Tombstone(Map aData)

Construct tombstone object from a map, containg tombstone properties.

Method Detail

getComponentTypeID

public int getComponentTypeID()

Returns component type ID. Possible values are: 0 - configuration instance 1 - assembly line 2 - event handler

Returns:

component type ID value

getEventTypeID

public int getEventTypeID()

Returns event type ID. Current version supports only stop event, which has 0 value

Returns:

event type ID value

getStartTime

public Date getStartTime()

Returns the start time of current tombstone component object (Config Instance, AssemblyLine or EventHandler).

Returns:

Tombstone component start time

getTombstoneCreateTime

public Date getTombstoneCreateTime()

Returns tombstone record creation time.

Returns:

Tombstone creation time

getComponentName

public String getComponentName()

Returns the name of the tombstone component (Config Instance, AssemblyLine or EventHandler).

Returns:

Tombstone component name

getConfiguration

public String getConfiguration()

Returns the name of the configuration to which the AssemblyLine or EventHandler belonged.

Returns:

configuraion name

getExitCode

public int getExitCode()

Returns status indicator for how the tombstone component terminated.

Returns:

Tombstone component exit code. 0 means normal termination. 1 means termination with error.

getErrorDescription

public String getErrorDescription()

Returns error description in case of abnormal tombstone component termination.

Returns:

error description

getGUID

public String getGUID()

Returns tombstone Global Unique Identifier (GUID). The GUID is a unique string object for each tombstone record created.

Returns:

Tombstone GUID

getStatistics

public Entry getStatistics()

Returns AssemblyLine's Entry statistis object.

Returns:

Entry statistics object

getUserMessage

public String getUserMessage()

Returns the user specified tombstone message.

Returns:

the user specified tombstone message