com.ibm.di.api
Class DIEvent

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ALEvent, CIEvent

public class DIEvent
extends Object
implements Serializable

This class is the object that describes the event that have been triggered. Its purpose is to be a general event information carrier.

See Also:

Serialized Form

Field Summary

static String	EVT_AL_START A constant value used to tell the type of the DIEvent object.
static String	EVT_AL_STOP A constant value used to tell the type of the DIEvent object.
static String	EVT_CI_START A constant value used to tell the type of the DIEvent object.
static String	EVT_CI_STOP A constant value used to tell the type of the DIEvent object.
static String	EVT_CI_UPDATED A constant value used to tell the type of the DIEvent object.
static String	EVT_SRV_STOP A constant value used to tell the type of the DIEvent object.
static String	EVT_USER_PREFIX If the type of the DIEvent starts with this prefix then it means that the this is a custom user defined event that have been triggered.

Constructor Summary

DIEvent(String aType, String aId, Object aData)
Create a new DIEvent instance.

DIEvent(String aType, String aId, Object aData, String aConfigInstanceId)
Create a new DIEvent instance.

Method Summary

String	getConfigInstanceId() Retrieves the config instance ID.
Object	getData() Retrives tha data from the object.
Date	getDateCreated() Retrieves the cration of the DIEvent
String	getId() Retrieves the ID of the DIEvent
String	getType() Retrieves the type of the event.
String	toString() Converts the event to a readable output.

Methods inherited from class java.lang.Object

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

Field Detail

EVT_CI_START

public static final String EVT_CI_START

A constant value used to tell the type of the DIEvent object.
EVT_CI_START = "di.ci.start"

See Also:

Constant Field Values

EVT_CI_STOP

public static final String EVT_CI_STOP

A constant value used to tell the type of the DIEvent object.
EVT_CI_STOP = "di.ci.stop"

See Also:

Constant Field Values

EVT_CI_UPDATED

public static final String EVT_CI_UPDATED

A constant value used to tell the type of the DIEvent object.
EVT_CI_UPDATED = "di.ci.file.updated"

See Also:

Constant Field Values

EVT_AL_START

public static final String EVT_AL_START

A constant value used to tell the type of the DIEvent object.
EVT_AL_START = "di.al.start"

See Also:

Constant Field Values

EVT_AL_STOP

public static final String EVT_AL_STOP

A constant value used to tell the type of the DIEvent object.
EVT_AL_STOP = "di.al.stop"

See Also:

Constant Field Values

EVT_SRV_STOP

public static final String EVT_SRV_STOP

A constant value used to tell the type of the DIEvent object.
EVT_SRV_STOP = "di.server.stop"

See Also:

Constant Field Values

EVT_USER_PREFIX

public static final String EVT_USER_PREFIX

If the type of the DIEvent starts with this prefix then it means that the this is a custom user defined event that have been triggered.
EVT_USER_PREFIX = "user."

See Also:

Constant Field Values

Constructor Detail

DIEvent

public DIEvent(String aType,
               String aId,
               Object aData)
        throws DIException

Create a new DIEvent instance.

Parameters:

aType - the type of the event that had occurred.
Predefined constants:
EVT_CI_START = "di.ci.start"
EVT_CI_STOP = "di.ci.stop"
EVT_CI_UPDATED = "di.ci.file.updated"
EVT_AL_START = "di.al.start"
EVT_AL_STOP = "di.al.stop"
EVT_SRV_STOP = "di.server.stop"

aId - the ID of the event Note: This ID should not to be think of as a Unique Identifier used for distinguishing different events occurring in the system.

aData - the additional information this event carrier might contain.

Throws:

DIException - if the aType is null.

DIEvent

public DIEvent(String aType,
               String aId,
               Object aData,
               String aConfigInstanceId)
        throws DIException

Create a new DIEvent instance.

Parameters:

aType - the type of the event that had occurred.
Predefined constants:
EVT_CI_START = "di.ci.start"
EVT_CI_STOP = "di.ci.stop"
EVT_CI_UPDATED = "di.ci.file.updated"
EVT_AL_START = "di.al.start"
EVT_AL_STOP = "di.al.stop"
EVT_SRV_STOP = "di.server.stop"

aId - the ID of the event Note: This ID should not to be think of as a Unique Identifier used for distinguishing different events occurring in the system.

aData - the additional information this event carrier might contain.

aConfigInstanceId - the configInstance id, this might be null.

Throws:

DIException - if the aType is null.

Method Detail

getType

public String getType()

Retrieves the type of the event.

Returns:

the type of this event.

getConfigInstanceId

public String getConfigInstanceId()

Retrieves the config instance ID.

Returns:

the identifier of the configInstance in which the event had occurred, or null if the event had occurred in different place.

getId

public String getId()

Retrieves the ID of the DIEvent

Returns:

the identifier of this DIEvent instance.

getData

public Object getData()

Retrives tha data from the object.

Returns:

the information this object carries.

getDateCreated

public Date getDateCreated()

Retrieves the cration of the DIEvent

Returns:

the time this DIEvent object was created.

toString

public String toString()

Converts the event to a readable output.

Overrides:

toString in class Object

Returns:

the String representation of this DIEvent object, containing all of its attributes.