com.ibm.di.api.jmx.mbeans
Interface EventHandlerMBean

All Superinterfaces:

BaseAdminMBean, BaseMBean

All Known Implementing Classes:

EventHandler

public interface EventHandlerMBean
extends BaseAdminMBean

Represents an EventHandler instance.

Method Summary

EventHandlerConfig	getConfig() Returns configuration information about the EventHandler.
javax.management.ObjectName	getConfigInstance() Returns ObjectName generated from the EventHandler’s configuration ID, gotten from the EventHandler’s configuration instance.
Integer	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(Integer aLastKilobytes) Retrieves the last chunk from the current EventHandler's system log.
Integer	getUniqueCode() Returns the unique code of the EventHandler.
void	stop() Stops the execution of the EventHandler.

Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean

getId, getType

Method Detail

getEventHandlerType

Integer getEventHandlerType()
                            throws DIException

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

Returns:

The type of the EventHandler as Integer object.

Throws:

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

getEventHandlerTypeName

String getEventHandlerTypeName()
                               throws DIException

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.

getConfigInstance

javax.management.ObjectName getConfigInstance()
                                              throws DIException

Returns ObjectName generated from the EventHandler’s configuration ID, gotten from the EventHandler’s configuration instance.

Returns:

ObjectName object generated from the EventHandler’s configuration ID.

Throws:

DIException - if an error occurs while generating the ObjectName.

getName

String getName()
               throws DIException

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.

getUniqueCode

Integer getUniqueCode()
                      throws DIException

Returns the unique code of the EventHandler.

Returns:

Integer object representing the unique code of the EventHandler.

Throws:

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

getConfig

EventHandlerConfig getConfig()
                             throws DIException

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.

getStatistics

TaskStatistics getStatistics()
                             throws DIException

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.

stop

void stop()
          throws DIException

Stops the execution of the EventHandler.

Throws:

DIException - if an error occurs while stopping the EventHandler.

getSystemLogFilePath

String getSystemLogFilePath()
                            throws DIException

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.

getSystemLogFileName

String getSystemLogFileName()
                            throws DIException

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.

getSystemLog

String getSystemLog()
                    throws DIException

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.

getSystemLogLastChunk

String getSystemLogLastChunk(Integer aLastKilobytes)
                             throws DIException

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.

getGlobalUniqueID

String getGlobalUniqueID()
                         throws DIException

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 GUID.