com.ibm.di.api
Class Tombstone

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

All Implemented Interfaces:

java.io.Serializable

public class Tombstone
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

static java.lang.String	PROPERTY_NAME_COMPONENT_NAME Property that specifies the name of the component.
static java.lang.String	PROPERTY_NAME_COMPONENT_TYPE_ID Property that specifies the type of the component. Possible values: 0 – Config Instance 1 – AssemblyLine
static java.lang.String	PROPERTY_NAME_CONFIGURATION Property that specifies the configuration id which the AssemblyLine is started from.
static java.lang.String	PROPERTY_NAME_CREATED_ON Property that specifies the time the component was created.
static java.lang.String	PROPERTY_NAME_ERROR_DESCR Property that specifies the description of the error the component ended with (if any).
static java.lang.String	PROPERTY_NAME_EVENT_TYPE_ID Property that specifies the type of the event.
static java.lang.String	PROPERTY_NAME_EXIT_CODE Property that specifies the code which the Component exited with.
static java.lang.String	PROPERTY_NAME_GUID Property that specifies the globally unique identifier of the tombstone record.
static java.lang.String	PROPERTY_NAME_START_TIME Property that specifies the time the component was started.
static java.lang.String	PROPERTY_NAME_STAT Property that specifies the statistics for the component.
static java.lang.String	PROPERTY_NAME_USER_MESSAGE Property that specifies the user message this tombstone will contain.

Constructor Summary

Tombstone(java.util.Map<java.lang.String,java.lang.Object> aData)
Construct tombstone object from a map, containing tombstone properties.

Method Summary

java.lang.String	getComponentName() Returns the name of the tombstone component (Config Instance or AssemblyLine).
int	getComponentTypeID() Returns component type ID.
java.lang.String	getConfiguration() Returns the name of the configuration to which the AssemblyLine belonged.
java.lang.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.
java.lang.String	getGUID() Returns tombstone Global Unique Identifier (GUID).
java.util.Date	getStartTime() Returns the start time of current tombstone component object (Config Instance or AssemblyLine).
Entry	getStatistics() Returns AssemblyLine's Entry statistics object.
java.util.Date	getTombstoneCreateTime() Returns tombstone record creation time.
java.lang.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 java.lang.String PROPERTY_NAME_COMPONENT_TYPE_ID

Property that specifies the type of the component.
Possible values:

• 0 – Config Instance
• 1 – AssemblyLine

See Also:

Constant Field Values

PROPERTY_NAME_EVENT_TYPE_ID

public static final java.lang.String PROPERTY_NAME_EVENT_TYPE_ID

Property that specifies the type of the event. Possible values:

• 0 – Stop Event

See Also:

Constant Field Values

PROPERTY_NAME_START_TIME

public static final java.lang.String PROPERTY_NAME_START_TIME

Property that specifies the time the component was started.

See Also:

Constant Field Values

PROPERTY_NAME_CREATED_ON

public static final java.lang.String PROPERTY_NAME_CREATED_ON

Property that specifies the time the component was created.

See Also:

Constant Field Values

PROPERTY_NAME_COMPONENT_NAME

public static final java.lang.String PROPERTY_NAME_COMPONENT_NAME

Property that specifies the name of the component.

See Also:

Constant Field Values

PROPERTY_NAME_CONFIGURATION

public static final java.lang.String PROPERTY_NAME_CONFIGURATION

Property that specifies the configuration id which the AssemblyLine is started from.

See Also:

Constant Field Values

PROPERTY_NAME_EXIT_CODE

public static final java.lang.String PROPERTY_NAME_EXIT_CODE

Property that specifies the code which the Component exited with. Possible Values:

• 0 – Normal termination
• 1 – Error

See Also:

Constant Field Values

PROPERTY_NAME_ERROR_DESCR

public static final java.lang.String PROPERTY_NAME_ERROR_DESCR

Property that specifies the description of the error the component ended with (if any).

See Also:

Constant Field Values

PROPERTY_NAME_STAT

public static final java.lang.String PROPERTY_NAME_STAT

Property that specifies the statistics for the component. The statistics are stored as an Entry object.

See Also:

Constant Field Values

PROPERTY_NAME_GUID

public static final java.lang.String PROPERTY_NAME_GUID

Property that specifies the globally unique identifier of the tombstone record.

See Also:

Constant Field Values

PROPERTY_NAME_USER_MESSAGE

public static final java.lang.String PROPERTY_NAME_USER_MESSAGE

Property that specifies the user message this tombstone will contain.

See Also:

Constant Field Values

Constructor Detail

Tombstone

public Tombstone(java.util.Map<java.lang.String,java.lang.Object> aData)

Construct tombstone object from a map, containing tombstone properties.

Parameters:

aData - contains the data that will be written as a tombstone.

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 java.util.Date getStartTime()

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

Returns:

Tombstone component start time

getTombstoneCreateTime

public java.util.Date getTombstoneCreateTime()

Returns tombstone record creation time.

Returns:

Tombstone creation time

getComponentName

public java.lang.String getComponentName()

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

Returns:

Tombstone component name

getConfiguration

public java.lang.String getConfiguration()

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

Returns:

configuration 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 java.lang.String getErrorDescription()

Returns error description in case of abnormal tombstone component termination.

Returns:

error description

getGUID

public java.lang.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 statistics object.

Returns:

Entry statistics object

getUserMessage

public java.lang.String getUserMessage()

Returns the user specified tombstone message.

Returns:

the user specified tombstone message