com.ibm.di.api.remote
Interface EventHandler

All Superinterfaces:

Remote

All Known Implementing Classes:

EventHandlerImpl

public interface EventHandler
extends Remote

Represents an EventHandler instance.

Field Summary

static String[]	EH_TYPE_NAME
static int	EH_TYPE_SWITCHBOARD
static int	EH_TYPE_TRIGGER

Method Summary

EventHandlerConfig	getConfig() Returns configuration information about the EventHandler.
ConfigInstance	getConfigInstance() Returns the configuration instance of the EventHandler.
int	getEventHandlerType() Returns the EventHandler type.
String	getEventHandlerTypeName() Returns the EventHandler type name.
String	getGlobalUniqueID() Returns EventHandler GUID.
String	getName() Returns the name of the EventHandler.
TaskStatistics	getStatistics() This method returns the TaskStatistics object for this EventHandler.
String	getSystemLog() Retrieves the current EventHandler's system log.
String	getSystemLogFileName() Returns the name of the log file of the EventHandler (not prefixed by folders path).
String	getSystemLogFilePath() Returns the fully-qualified path of the log file of the EventHandler.
String	getSystemLogLastChunk(int aLastKilobytes) Retrieves the last chunk from the current EventHandler's system log.
int	getUniqueCode() Returns the unique code of the EventHandler.
void	stop() Stops the execution of the EventHandler.

Field Detail

EH_TYPE_TRIGGER

static final int EH_TYPE_TRIGGER

See Also:

Constant Field Values

EH_TYPE_SWITCHBOARD

static final int EH_TYPE_SWITCHBOARD

See Also:

Constant Field Values

EH_TYPE_NAME

static final String[] EH_TYPE_NAME

Method Detail

getEventHandlerType

int getEventHandlerType()
                        throws DIException,
                               RemoteException

Returns the EventHandler type. 0 is Trigger type and 1 is Switchboard type.

Returns:

The type of the EventHandler as int.

Throws:

DIException - if an error occurs while retrieving the EventHandler type.

RemoteException - if a communication-related exception occurs.

getEventHandlerTypeName

String getEventHandlerTypeName()
                               throws DIException,
                                      RemoteException

Returns the EventHandler type name.

Returns:

String object representing the name of the EventHandler type.

Throws:

DIException - if an error occurs while retrieving EventHandler type name.

RemoteException - if a communication-related exception occurs.

getConfigInstance

ConfigInstance getConfigInstance()
                                 throws DIException,
                                        RemoteException

Returns the configuration instance of the EventHandler.

Returns:

ConfigInstance object representing the configuration instance of the EventHandler.

Throws:

DIException - if an error occurs while retrieving the configuration instance information.

RemoteException - if a communication-related exception occurs.

getName

String getName()
               throws DIException,
                      RemoteException

Returns the name of the EventHandler.

Returns:

String object representing the EventHandler’s name.

Throws:

DIException - if an error occurs while retrieving the name of the EventHandler.

RemoteException - if a communication-related exception occurs.

getUniqueCode

int getUniqueCode()
                  throws DIException,
                         RemoteException

Returns the unique code of the EventHandler.

Returns:

int value representing the unique code of the EventHandler.

Throws:

DIException - if an error occurs while retrieving the unique code of the EventHandler.

RemoteException - if a communication-related exception occurs.

getConfig

EventHandlerConfig getConfig()
                             throws DIException,
                                    RemoteException

Returns configuration information about the EventHandler.

Returns:

EventHandlerConfig representing the configuration information of the EventHandler.

Throws:

DIException - if an error occurs while retrieving the configuration information of the EventHandler.

RemoteException - if a communication-related exception occurs.

getStatistics

TaskStatistics getStatistics()
                             throws DIException,
                                    RemoteException

This method returns the TaskStatistics object for this EventHandler.

Returns:

The accumulated TaskStatistics object.

Throws:

DIException - if an error occurs while getting the EventHandler statistics.

RemoteException - if a communication-related exception occurs.

stop

void stop()
          throws DIException,
                 RemoteException

Stops the execution of the EventHandler.

Throws:

DIException - if an error occurs while stopping the EventHandler.

RemoteException - if a communication-related exception occurs.

getSystemLogFilePath

String getSystemLogFilePath()
                            throws DIException,
                                   RemoteException

Returns the fully-qualified path of the log file of the EventHandler.

Returns:

the fully-qualified log file path.

Throws:

DIException - if an error occurs while obtaining EventHandler log file path.

RemoteException - if a communication-related exception occurs.

getSystemLogFileName

String getSystemLogFileName()
                            throws DIException,
                                   RemoteException

Returns the name of the log file of the EventHandler (not prefixed by folders path).

Returns:

the log file name.

Throws:

DIException - if an error occurs while obtaining EventHandler log file name.

RemoteException - if a communication-related exception occurs.

getSystemLog

String getSystemLog()
                    throws DIException,
                           RemoteException

Retrieves the current EventHandler's system log.

Returns:

the log generated by the EventHandler so far.

Throws:

DIException - if an error occurs while obtaining EventHandler's log.

RemoteException - if a communication-related exception occurs.

getSystemLogLastChunk

String getSystemLogLastChunk(int aLastKilobytes)
                             throws DIException,
                                    RemoteException

Retrieves the last chunk from the current EventHandler's system log.

Parameters:

aLastKilobytes - specifies in kilobytes the size of the log's last chunk that will be read.

Returns:

the last chunk of the EventHandler's log, generated so far.

Throws:

DIException - if an error occurs while obtaining EventHandler's log.

RemoteException - if a communication-related exception occurs.

getGlobalUniqueID

String getGlobalUniqueID()
                         throws DIException,
                                RemoteException

Returns EventHandler GUID. The GUID is a string value that is unique for each component ever created by a particular TDI Server.

Returns:

The EventHandler GUID value.

Throws:

DIException - if an error occurs while obtaining the EventHandler GUID value.

RemoteException - if a communication-related exception occurs.