com.ibm.di.api.jmx.mbeans
Class ConfigInstance

java.lang.Object
  com.ibm.di.api.jmx.mbeans.BaseAdmin
      com.ibm.di.api.jmx.mbeans.ConfigInstance

All Implemented Interfaces:

BaseAdminMBean, BaseMBean, ConfigInstanceMBean

public class ConfigInstance
extends BaseAdmin
implements ConfigInstanceMBean

Field Summary

static String

MBEAN_TYPE

Constructor Summary

ConfigInstance(ConfigInstance aConfigInstance)

Method Summary

static javax.management.ObjectName	genObjectName(String aConfigInstanceName)
String	getALLastLogFileName(String aALName) Returns the name of the log file created on the last run of a given AssemblyLine.
String	getALLog(String aALName, String aLogFileName) Given an AssemblyLine name, and a log file name, retrieves the log of this AssemblyLine, stored in the specified file.
String[]	getALLogFileNames(String aALName) Returns the names of all available log files for a given AssemblyLine.
String	getALLogLastChunk(String aALName, String aLogFileName, Integer aKilobytes) Retrieves the last chunk from a specified AssemblyLine's log file.
SchemaConfig	getAssemblyLineInputParameters(String aAssemblyLineName) Returns the AssemblyLine’s input parameters.
SchemaConfig	getAssemblyLineOutputParameters(String aAssemblyLineName) Returns the AssemblyLine’s output parameters.
javax.management.ObjectName[]	getAssemblyLines() Returns the names of currently started AssemblyLines of the configuration each represented as ObjectName generated from AssemblyLine’s name and unique code.
String[]	getAssemblyLinesNames() Returns the AssemblyLines’ names.
String	getConfigId() Returns the configuration ID generated by the server.
MetamergeConfig	getConfiguration() Returns configuration instance representing this configuration.
PoolDefConfig	getConnectorPoolConfig(String aConnectorPoolName) Returns the Connector Pool configuration object.
int	getConnectorPoolFreeNum(String aConnectorPoolName) Returns the number of free Connectors in the specified Connector Pool.
String[]	getConnectorPoolNames() Returns the names of all Connector Pools in the Config Instance.
int	getConnectorPoolSize(String aConnectorPoolName) Returns the size of the specified Connector Pool.
String	getEHLastLogFileName(String aEHName) Returns the name of the log file created on the last run of a given EventHandler.
String	getEHLog(String aEHName, String aLogFileName) Given an EventHandler name, and a log file name, retrieves the log of this EventHandler, stored in the specified file.
String[]	getEHLogFileNames(String aEHName) Rreturns the names of all available log files for a given EventHandler.
String	getEHLogLastChunk(String aEHName, String aLogFileName, Integer aKilobytes) Retrieves the last chunk from a specified EventHandler's log file.
javax.management.ObjectName[]	getEventHandlers() Returns the names of the EventHandlers of the configuration each represented as ObjectName generated from EventHandler’s name and unique code.
String[]	getEventHandlersNames() Returns the EventHandlers’ names.
ExternalPropertiesConfig	getExternalProperties() Returns the external properties of the configuration.
ExternalPropertiesConfig	getExternalProperties(String aKey) Returns the ExternalPropertiesConfig object for the named external properties object.
String[]	getExternalPropertiesKeys() Returns the external properties object names.
String	getGlobalUniqueID() Returns the Config Instance GUID.
String	getId() Reads attribute "Id".
Date	getInstanceBootTime() Returns the Instance boot time.
javax.management.ObjectName	getTDIProperties() Access to the TDIProperies for the particular config.
String	getType() Reads attribute "Type".
int	purgeConnectorPool(String aConnectorPoolName) Unused Connectors will be released so that the Pool is shrunk to its minimum size.
void	reload() Reloads the Config Instance with its current configuration.
void	saveConfiguration()
void	saveConfiguration(Boolean aEncrypt)
void	saveExternalProperties()
void	setConfiguration(MetamergeConfig aConfiguration) Sets given configuration to this configuration.
void	setExternalProperties(ExternalPropertiesConfig aExPropConfig)
void	setExternalProperties(String aKey, ExternalPropertiesConfig aExPropConfig)
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName) Starts the specified AssemblyLine asynchronously.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, Boolean aSync) Starts the specified AssemblyLine.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, Entry aInputData) Starts the specified AssemblyLine with the given input data asynchronously.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, Boolean aGetLogs) Starts asynchronously the specified AssemblyLine with the given input data and results listener.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, Boolean aGetLogs, Boolean aSync) Starts the specified AssemblyLine with the given input data and results listener.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, Entry aInputData, Boolean aSync) Starts the specified AssemblyLine with the given input data.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb) Starts asynchronously the specified AssemblyLine with the given TaskCallBlock.
javax.management.ObjectName	startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb, Boolean aSync) Starts the specified AssemblyLine with the given TaskCallBlock.
javax.management.ObjectName	startAssemblyLineManual(String aAssemblyLineName, Entry aInputData) Starts the specified AssemblyLine with the given input data in manual mode.
javax.management.ObjectName	startEventHandler(String aEventHandlerName) Starts the specified EventHandler asynchronously.
javax.management.ObjectName	startEventHandler(String aEventHandlerName, Boolean aSync) Starts the specified EventHandler.
javax.management.ObjectName	startEventHandler(String aEventHandlerName, EventHandlerListener aListener, Boolean aGetLogs, Boolean aRecordEvents) Starts the specified EventHandler asynchronously.
javax.management.ObjectName	startEventHandler(String aEventHandlerName, EventHandlerListener aListener, Boolean aGetLogs, Boolean aRecordEvents, Boolean aSync) Starts the specified EventHandler.
void	stop() Stops the Config Instance.

Methods inherited from class com.ibm.di.api.jmx.mbeans.BaseAdmin

getCurrentUserId, getKeyPropertyList

Methods inherited from class java.lang.Object

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

Field Detail

MBEAN_TYPE

public static final String MBEAN_TYPE

See Also:

Constant Field Values

Constructor Detail

ConfigInstance

public ConfigInstance(ConfigInstance aConfigInstance)
               throws DIException

Throws:

DIException

Method Detail

getType

public String getType()

Description copied from interface: BaseMBean

Reads attribute "Type".

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getType in interface BaseMBean

Returns:

the type of this MBean.

getId

public String getId()
             throws DIException

Description copied from interface: BaseMBean

Reads attribute "Id". The "Id" value should be different for different MBeans of the same type.

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getId in interface BaseMBean

Returns:

the Id of this MBean.

Throws:

DIException - if an error occurs while obtaining MBean's Id.

getConfigId

public String getConfigId()
                   throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the configuration ID generated by the server.

Specified by:

getConfigId in interface ConfigInstanceMBean

Returns:

String object representing the configuration ID.

Throws:

DIException - if an error occurs while getting the configuration ID.

getConfiguration

public MetamergeConfig getConfiguration()
                                 throws DIException

Description copied from interface: ConfigInstanceMBean

Returns configuration instance representing this configuration.

Specified by:

getConfiguration in interface ConfigInstanceMBean

Returns:

MetamergeConfig object representing this configuration.

Throws:

DIException - if an error occurs while getting the configuration.

setConfiguration

public void setConfiguration(MetamergeConfig aConfiguration)
                      throws DIException

Description copied from interface: ConfigInstanceMBean

Sets given configuration to this configuration.

Specified by:

setConfiguration in interface ConfigInstanceMBean

Parameters:

aConfiguration - The new configuration.

Throws:

DIException - if an error occurs while setting the configuration.

saveConfiguration

public void saveConfiguration()
                       throws DIException

Specified by:

saveConfiguration in interface ConfigInstanceMBean

Throws:

DIException

saveConfiguration

public void saveConfiguration(Boolean aEncrypt)
                       throws DIException

Specified by:

saveConfiguration in interface ConfigInstanceMBean

Throws:

DIException

getExternalProperties

public ExternalPropertiesConfig getExternalProperties()
                                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the external properties of the configuration.

Specified by:

getExternalProperties in interface ConfigInstanceMBean

Returns:

ExternalPropertiesConfig object representing the configuration’s external properties.

Throws:

DIException - if an error occurs while getting the external properties.

getExternalProperties

public ExternalPropertiesConfig getExternalProperties(String aKey)
                                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the ExternalPropertiesConfig object for the named external properties object.

Specified by:

getExternalProperties in interface ConfigInstanceMBean

Parameters:

aKey - The external property object name.

Returns:

ExternalPropertiesConfig object representing the configuration’s external properties specified by the external property object name.

Throws:

DIException - if an error occurs while getting the external properties.

getExternalPropertiesKeys

public String[] getExternalPropertiesKeys()
                                   throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the external properties object names.

Specified by:

getExternalPropertiesKeys in interface ConfigInstanceMBean

Returns:

String array each value representing one external property object name.

Throws:

DIException - if an error occurs while getting the external properties names.

setExternalProperties

public void setExternalProperties(ExternalPropertiesConfig aExPropConfig)
                           throws DIException

Specified by:

setExternalProperties in interface ConfigInstanceMBean

Throws:

DIException

setExternalProperties

public void setExternalProperties(String aKey,
                                  ExternalPropertiesConfig aExPropConfig)
                           throws DIException

Specified by:

setExternalProperties in interface ConfigInstanceMBean

Throws:

DIException

saveExternalProperties

public void saveExternalProperties()
                            throws DIException

Specified by:

saveExternalProperties in interface ConfigInstanceMBean

Throws:

DIException

getAssemblyLinesNames

public String[] getAssemblyLinesNames()
                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the AssemblyLines’ names.

Specified by:

getAssemblyLinesNames in interface ConfigInstanceMBean

Returns:

String array each value representing AssemblyLine name.

Throws:

DIException - if an error occurs while getting the AssemblyLines’ names.

getAssemblyLineInputParameters

public SchemaConfig getAssemblyLineInputParameters(String aAssemblyLineName)
                                            throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the AssemblyLine’s input parameters.

Specified by:

getAssemblyLineInputParameters in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - the name of the AssemblyLine.

Returns:

SchemaConfig representing the schema input of the AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLine's input parameters.

getAssemblyLineOutputParameters

public SchemaConfig getAssemblyLineOutputParameters(String aAssemblyLineName)
                                             throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the AssemblyLine’s output parameters.

Specified by:

getAssemblyLineOutputParameters in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - the name of the AssemblyLine.

Returns:

SchemaConfig representing the schema output of the AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLine's output parameters.

getEventHandlersNames

public String[] getEventHandlersNames()
                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the EventHandlers’ names.

Specified by:

getEventHandlersNames in interface ConfigInstanceMBean

Returns:

String array each value representing EventHandler name.

Throws:

DIException - if an error occurs while getting the EventHandlers’ names.

getAssemblyLines

public javax.management.ObjectName[] getAssemblyLines()
                                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the names of currently started AssemblyLines of the configuration each represented as ObjectName generated from AssemblyLine’s name and unique code.

Specified by:

getAssemblyLines in interface ConfigInstanceMBean

Returns:

ObjectName array each value representing ObjectName object of an AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLines’ names.

getEventHandlers

public javax.management.ObjectName[] getEventHandlers()
                                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the names of the EventHandlers of the configuration each represented as ObjectName generated from EventHandler’s name and unique code.

Specified by:

getEventHandlers in interface ConfigInstanceMBean

Returns:

ObjectName array each value representing ObjectName object of an EventHandler.

Throws:

DIException - if an error occurs while getting the EventHandlers’ names.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine asynchronously.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aSync - when true the AssemblyLine is started synchronously, when false the AssemblyLine is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     Entry aInputData)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine with the given input data asynchronously.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     Entry aInputData,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine with the given input data.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

aSync - when true the AssemblyLine is started synchronously, when false the AssemblyLine is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     Entry aInputData,
                                                     AssemblyLineListener aListener,
                                                     Boolean aGetLogs)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts asynchronously the specified AssemblyLine with the given input data and results listener.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

aListener - A listener for Entries produced by the AssemblyLine.

aGetLogs - when true the AssemblyLineListener delivers log messages, when false log messages are not delivered.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     Entry aInputData,
                                                     AssemblyLineListener aListener,
                                                     Boolean aGetLogs,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine with the given input data and results listener.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

aListener - A listener for Entries produced by the AssemblyLine.

aGetLogs - when true the AssemblyLineListener delivers log messages, when false log messages are not delivered.

aSync - when true the AssemblyLine is started synchronously, when false the AssemblyLine is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLineManual

public javax.management.ObjectName startAssemblyLineManual(String aAssemblyLineName,
                                                           Entry aInputData)
                                                    throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine with the given input data in manual mode.

Specified by:

startAssemblyLineManual in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

Returns:

ObjectName generated from the mbean server domain name and the key property list of the AssemblyLineHandler of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     TaskCallBlock aTcb)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts asynchronously the specified AssemblyLine with the given TaskCallBlock.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aTcb - The TaskCallBlock object to start the AL with.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

public javax.management.ObjectName startAssemblyLine(String aAssemblyLineName,
                                                     TaskCallBlock aTcb,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified AssemblyLine with the given TaskCallBlock.

Specified by:

startAssemblyLine in interface ConfigInstanceMBean

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aTcb - The TaskCallBlock object to start the AL with.

aSync - when true the AssemblyLine is started synchronously, when false the AssemblyLine is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given AssemblyLine.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startEventHandler

public javax.management.ObjectName startEventHandler(String aEventHandlerName)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified EventHandler asynchronously.

Specified by:

startEventHandler in interface ConfigInstanceMBean

Parameters:

aEventHandlerName - the name of the EventHandler to start.

Returns:

ObjectName generated from the name and the unique code of the given EventHandler.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

public javax.management.ObjectName startEventHandler(String aEventHandlerName,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified EventHandler.

Specified by:

startEventHandler in interface ConfigInstanceMBean

Parameters:

aEventHandlerName - the name of the EventHandler to start.

aSync - when true the EventHandler is started synchronously, when false the EventHandler is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given EventHandler.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

public javax.management.ObjectName startEventHandler(String aEventHandlerName,
                                                     EventHandlerListener aListener,
                                                     Boolean aGetLogs,
                                                     Boolean aRecordEvents)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified EventHandler asynchronously.

Specified by:

startEventHandler in interface ConfigInstanceMBean

Parameters:

aEventHandlerName - the name of the EventHandler to start.

aListener - The EventHandler listener to register for events.

aGetLogs - when true the EventHandlerListener delivers log messages, when false log messages are not delivered.

aRecordEvents - when true the EventHandler records all events.

Returns:

ObjectName generated from the name and the unique code of the given EventHandler.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

public javax.management.ObjectName startEventHandler(String aEventHandlerName,
                                                     EventHandlerListener aListener,
                                                     Boolean aGetLogs,
                                                     Boolean aRecordEvents,
                                                     Boolean aSync)
                                              throws DIException

Description copied from interface: ConfigInstanceMBean

Starts the specified EventHandler.

Specified by:

startEventHandler in interface ConfigInstanceMBean

Parameters:

aEventHandlerName - the name of the EventHandler to start.

aListener - The EventHandler listener to register for events.

aGetLogs - when true the EventHandlerListener delivers log messages, when false log messages are not delivered.

aRecordEvents - when true the EventHandler records all events.

aSync - when true the EventHandler is started synchronously, when false the EventHandler is started asynchronously.

Returns:

ObjectName generated from the name and the unique code of the given EventHandler.

Throws:

DIException - if an error occurs while starting the EventHandler.

reload

public void reload()
            throws DIException

Description copied from interface: ConfigInstanceMBean

Reloads the Config Instance with its current configuration.

Specified by:

reload in interface ConfigInstanceMBean

Throws:

DIException - if an error occurs while reloading the server.

stop

public void stop()
          throws DIException

Description copied from interface: ConfigInstanceMBean

Stops the Config Instance.

Specified by:

stop in interface ConfigInstanceMBean

Throws:

DIException - if an error occurs while stopping.

getALLogFileNames

public String[] getALLogFileNames(String aALName)
                           throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the names of all available log files for a given AssemblyLine.

Specified by:

getALLogFileNames in interface ConfigInstanceMBean

Parameters:

aALName - the name of the AssemblyLine.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log file names.

getALLastLogFileName

public String getALLastLogFileName(String aALName)
                            throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the name of the log file created on the last run of a given AssemblyLine.

Specified by:

getALLastLogFileName in interface ConfigInstanceMBean

Parameters:

aALName - the name of the AssemblyLine.

Returns:

the name of the log file created on the last AssemblyLine's run.

Throws:

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

getALLog

public String getALLog(String aALName,
                       String aLogFileName)
                throws DIException

Description copied from interface: ConfigInstanceMBean

Given an AssemblyLine name, and a log file name, retrieves the log of this AssemblyLine, stored in the specified file.

Specified by:

getALLog in interface ConfigInstanceMBean

Parameters:

aALName - the name of the AssemblyLine.

aLogFileName - the name of the log file; no file path should be specified - just the file name.

Returns:

the sepcified log of the AssemblyLine.

Throws:

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

getALLogLastChunk

public String getALLogLastChunk(String aALName,
                                String aLogFileName,
                                Integer aKilobytes)
                         throws DIException

Description copied from interface: ConfigInstanceMBean

Retrieves the last chunk from a specified AssemblyLine's log file.

Specified by:

getALLogLastChunk in interface ConfigInstanceMBean

Parameters:

aALName - the name of the AssemblyLine.

aLogFileName - the name of the log file; no file path should be specified - just the file name.

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

Returns:

the last chunk of the specified AssemblyLine's log.

Throws:

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

getEHLogFileNames

public String[] getEHLogFileNames(String aEHName)
                           throws DIException

Description copied from interface: ConfigInstanceMBean

Rreturns the names of all available log files for a given EventHandler.

Specified by:

getEHLogFileNames in interface ConfigInstanceMBean

Parameters:

aEHName - the name of the EventHandler.

Returns:

a String array, each of its elements specifying the name of a log file.

Throws:

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

getEHLastLogFileName

public String getEHLastLogFileName(String aEHName)
                            throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the name of the log file created on the last run of a given EventHandler.

Specified by:

getEHLastLogFileName in interface ConfigInstanceMBean

Parameters:

aEHName - the name of the EventHandler.

Returns:

the name of the log file created on the last EventHandler's run.

Throws:

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

getEHLog

public String getEHLog(String aEHName,
                       String aLogFileName)
                throws DIException

Description copied from interface: ConfigInstanceMBean

Given an EventHandler name, and a log file name, retrieves the log of this EventHandler, stored in the specified file.

Specified by:

getEHLog in interface ConfigInstanceMBean

Parameters:

aEHName - the name of the EventHandler.

aLogFileName - the name of the log file; no file path should be specified - just the file name.

Returns:

the specified log of the EventHandler.

Throws:

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

getEHLogLastChunk

public String getEHLogLastChunk(String aEHName,
                                String aLogFileName,
                                Integer aKilobytes)
                         throws DIException

Description copied from interface: ConfigInstanceMBean

Retrieves the last chunk from a specified EventHandler's log file.

Specified by:

getEHLogLastChunk in interface ConfigInstanceMBean

Parameters:

aEHName - the name of the EventHandler.

aLogFileName - the name of the log file; no file path should be specified - just the file name.

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

Returns:

the last chunk of the specified EventHandler's log.

Throws:

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

getInstanceBootTime

public Date getInstanceBootTime()
                         throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the Instance boot time.

Specified by:

getInstanceBootTime in interface ConfigInstanceMBean

Returns:

a java.util.Date specifying the date and time the instance was started.

Throws:

DIException - if an error occurs while retrieving instance's boot time.

genObjectName

public static javax.management.ObjectName genObjectName(String aConfigInstanceName)
                                                 throws DIException

Throws:

DIException

getGlobalUniqueID

public String getGlobalUniqueID()
                         throws DIException

Description copied from interface: ConfigInstanceMBean

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

Specified by:

getGlobalUniqueID in interface ConfigInstanceMBean

Returns:

The Config Instance GUID value.

Throws:

DIException - if an error occurs while retrieving GlobalUniqueID.

getConnectorPoolNames

public String[] getConnectorPoolNames()
                               throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the names of all Connector Pools in the Config Instance.

Specified by:

getConnectorPoolNames in interface ConfigInstanceMBean

Returns:

String array containing the Connector Pool names.

Throws:

DIException - if an error occurs while retrieving Connector Pool names.

getConnectorPoolSize

public int getConnectorPoolSize(String aConnectorPoolName)
                         throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the size of the specified Connector Pool.

Specified by:

getConnectorPoolSize in interface ConfigInstanceMBean

Parameters:

aConnectorPoolName - the name of the Connector Pool.

Returns:

The current size of the specified Connector Pool.

Throws:

DIException - if an error occurs while retrieving Connector Pool size.

getConnectorPoolFreeNum

public int getConnectorPoolFreeNum(String aConnectorPoolName)
                            throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the number of free Connectors in the specified Connector Pool.

Specified by:

getConnectorPoolFreeNum in interface ConfigInstanceMBean

Parameters:

aConnectorPoolName - the name of the Connector Pool.

Returns:

The number of free Connectors in the specified Connector Pool.

Throws:

DIException - if an error occurs while retrieving Connector Pool free Connectors.

getConnectorPoolConfig

public PoolDefConfig getConnectorPoolConfig(String aConnectorPoolName)
                                     throws DIException

Description copied from interface: ConfigInstanceMBean

Returns the Connector Pool configuration object.

Specified by:

getConnectorPoolConfig in interface ConfigInstanceMBean

Parameters:

aConnectorPoolName - the name of the Connector Pool.

Returns:

The configuration object for the specified Connector Pool.

Throws:

DIException - if an error occurs while retrieving Connector Pool configuration object.

purgeConnectorPool

public int purgeConnectorPool(String aConnectorPoolName)
                       throws DIException

Description copied from interface: ConfigInstanceMBean

Unused Connectors will be released so that the Pool is shrunk to its minimum size.

Specified by:

purgeConnectorPool in interface ConfigInstanceMBean

Parameters:

aConnectorPoolName - the name of the Connector Pool.

Returns:

The size of the Connector Pool after shrinking.

Throws:

DIException - if an error occurs while shrinking the Connector Pool to its minimum size.

getTDIProperties

public javax.management.ObjectName getTDIProperties()
                                             throws Exception

Description copied from interface: ConfigInstanceMBean

Access to the TDIProperies for the particular config.

Specified by:

getTDIProperties in interface ConfigInstanceMBean

Returns:

ObjectName containing the TDI Properties of the Config.

Throws:

Exception - if an error occurs while getting TDI Properties