com.ibm.di.api.local
Interface ConfigInstance

All Known Implementing Classes:

ConfigInstanceImpl

public interface ConfigInstance

Represents a configuration instance and provides various methods for manipulating the configuration.

Method Summary

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, int 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.
AssemblyLine[]	getAssemblyLines() Returns currently started AssemblyLines of the configuration instance.
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, int aKilobytes) Retrieves the last chunk from a specified EventHandler's log file.
EventHandler[]	getEventHandlers() Returns currently started EventHandlers of the configuration instance.
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.
Date	getInstanceBootTime() Returns the Instance boot time.
TDIProperties	getTDIProperties() Used to obtain a reference to TDIProperties for managing properties / property stores.
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() Deprecated. Not supported.
void	saveConfiguration(boolean aEncrypt) Deprecated. Not supported.
void	saveExternalProperties() Deprecated. Not supported.
void	setConfiguration(MetamergeConfig aConfiguration) Sets given configuration to this configuration.
void	setExternalProperties(ExternalPropertiesConfig aExPropConfig) Deprecated. Not supported.
void	setExternalProperties(String aKey, ExternalPropertiesConfig aExPropConfig) Deprecated. Not supported.
AssemblyLine	startAssemblyLine(String aAssemblyLineName) Starts the specified AssemblyLine asynchronously.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, boolean aSync) Starts the specified AssemblyLine.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, Entry aInputData) Starts the specified AssemblyLine with the given input data asynchronously.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, boolean aGetLogs) Starts asynchronously the specified AssemblyLine with the given input data and results listener.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, boolean aGetLogs, boolean aSync) Starts the specified AssemblyLine with the given input data and results listener.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, Entry aInputData, boolean aSync) Starts the specified AssemblyLine with the given input data.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb) Starts asynchronously the specified AssemblyLine with the given TaskCallBlock.
AssemblyLine	startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb, boolean aSync) Starts the specified AssemblyLine with the given TaskCallBlock.
AssemblyLineHandler	startAssemblyLineManual(String aAssemblyLineName, Entry aInputData) Starts the specified AssemblyLine with the given input data in manual mode.
EventHandler	startEventHandler(String aEventHandlerName) Starts the specified EventHandler asynchronously.
EventHandler	startEventHandler(String aEventHandlerName, boolean aSync) Starts the specified EventHandler.
EventHandler	startEventHandler(String aEventHandlerName, EventHandlerListener aListener, boolean aGetLogs, boolean aRecordEvents) Starts the specified EventHandler asynchronously.
EventHandler	startEventHandler(String aEventHandlerName, EventHandlerListener aListener, boolean aGetLogs, boolean aRecordEvents, boolean aSync) Starts the specified EventHandler.
void	stop() Stops the Config Instance.

Method Detail

getConfigId

String getConfigId()
                   throws DIException

Returns the configuration ID generated by the server.

Returns:

String object representing the configuration ID.

Throws:

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

getConfiguration

MetamergeConfig getConfiguration()
                                 throws DIException

Returns configuration instance representing this configuration.

Returns:

MetamergeConfig object representing this configuration.

Throws:

DIException - if an error occurs while getting the configuration.

setConfiguration

void setConfiguration(MetamergeConfig aConfiguration)
                      throws DIException

Sets given configuration to this configuration.

Parameters:

aConfiguration - The new configuration.

Throws:

DIException - if an error occurs while setting the configuration.

saveConfiguration

void saveConfiguration()
                       throws DIException

Deprecated. Not supported.

Throws:

DIException

saveConfiguration

void saveConfiguration(boolean aEncrypt)
                       throws DIException

Deprecated. Not supported.

Throws:

DIException

getExternalProperties

ExternalPropertiesConfig getExternalProperties()
                                               throws DIException

Returns the external properties of the configuration.

Returns:

ExternalPropertiesConfig object representing the configuration’s external properties.

Throws:

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

getExternalProperties

ExternalPropertiesConfig getExternalProperties(String aKey)
                                               throws DIException

Returns the ExternalPropertiesConfig object for the named external properties object.

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

String[] getExternalPropertiesKeys()
                                   throws DIException

Returns the external properties object names.

Returns:

String array each value representing one external property object name.

Throws:

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

setExternalProperties

void setExternalProperties(ExternalPropertiesConfig aExPropConfig)
                           throws DIException

Deprecated. Not supported.

Throws:

DIException

setExternalProperties

void setExternalProperties(String aKey,
                           ExternalPropertiesConfig aExPropConfig)
                           throws DIException

Deprecated. Not supported.

Throws:

DIException

saveExternalProperties

void saveExternalProperties()
                            throws DIException

Deprecated. Not supported.

Throws:

DIException

getAssemblyLinesNames

String[] getAssemblyLinesNames()
                               throws DIException

Returns the AssemblyLines’ names.

Returns:

String array each value representing AssemblyLine name.

Throws:

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

getAssemblyLineInputParameters

SchemaConfig getAssemblyLineInputParameters(String aAssemblyLineName)
                                            throws DIException

Returns the AssemblyLine’s input parameters.

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

SchemaConfig getAssemblyLineOutputParameters(String aAssemblyLineName)
                                             throws DIException

Returns the AssemblyLine’s output parameters.

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

String[] getEventHandlersNames()
                               throws DIException

Returns the EventHandlers’ names.

Returns:

String array each value representing EventHandler name.

Throws:

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

getAssemblyLines

AssemblyLine[] getAssemblyLines()
                                throws DIException

Returns currently started AssemblyLines of the configuration instance.

Returns:

AssemblyLine array object each value represents currently started AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLines.

getEventHandlers

EventHandler[] getEventHandlers()
                                throws DIException

Returns currently started EventHandlers of the configuration instance.

Returns:

EventHandler array object each value represents currently started EventHandler.

Throws:

DIException - if an error occurs while getting the EventHandlers.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName)
                               throws DIException

Starts the specified AssemblyLine asynchronously.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

Returns:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               boolean aSync)
                               throws DIException

Starts the specified AssemblyLine.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

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

Returns:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               Entry aInputData)
                               throws DIException

Starts the specified AssemblyLine with the given input data asynchronously.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

Returns:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               Entry aInputData,
                               boolean aSync)
                               throws DIException

Starts the specified AssemblyLine with the given input data.

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:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               Entry aInputData,
                               AssemblyLineListener aListener,
                               boolean aGetLogs)
                               throws DIException

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

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:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               Entry aInputData,
                               AssemblyLineListener aListener,
                               boolean aGetLogs,
                               boolean aSync)
                               throws DIException

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

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:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLineManual

AssemblyLineHandler startAssemblyLineManual(String aAssemblyLineName,
                                            Entry aInputData)
                                            throws DIException

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

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aInputData - Initial Work Entry to run the AssemblyLine with.

Returns:

the AssemblyLineHandler object for AssemblyLine manipulation in manual mode.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               TaskCallBlock aTcb)
                               throws DIException

Starts asynchronously the specified AssemblyLine with the given TaskCallBlock.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aTcb - The TaskCallBlock object to start the AL with.

Returns:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startAssemblyLine

AssemblyLine startAssemblyLine(String aAssemblyLineName,
                               TaskCallBlock aTcb,
                               boolean aSync)
                               throws DIException

Starts the specified AssemblyLine with the given TaskCallBlock.

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:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

startEventHandler

EventHandler startEventHandler(String aEventHandlerName)
                               throws DIException

Starts the specified EventHandler asynchronously.

Parameters:

aEventHandlerName - the name of the EventHandler to start.

Returns:

the EventHandler object.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

EventHandler startEventHandler(String aEventHandlerName,
                               boolean aSync)
                               throws DIException

Starts the specified EventHandler.

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:

the EventHandler object.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

EventHandler startEventHandler(String aEventHandlerName,
                               EventHandlerListener aListener,
                               boolean aGetLogs,
                               boolean aRecordEvents)
                               throws DIException

Starts the specified EventHandler asynchronously.

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:

the EventHandler object.

Throws:

DIException - if an error occurs while starting the EventHandler.

startEventHandler

EventHandler startEventHandler(String aEventHandlerName,
                               EventHandlerListener aListener,
                               boolean aGetLogs,
                               boolean aRecordEvents,
                               boolean aSync)
                               throws DIException

Starts the specified EventHandler.

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:

the EventHandler object.

Throws:

DIException - if an error occurs while starting the EventHandler.

reload

void reload()
            throws DIException

Reloads the Config Instance with its current configuration.

Throws:

DIException - if an error occurs while reloading the server.

stop

void stop()
          throws DIException

Stops the Config Instance.

Throws:

DIException - if an error occurs while stopping.

getALLogFileNames

String[] getALLogFileNames(String aALName)
                           throws DIException

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

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

String getALLastLogFileName(String aALName)
                            throws DIException

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

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

String getALLog(String aALName,
                String aLogFileName)
                throws DIException

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

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

String getALLogLastChunk(String aALName,
                         String aLogFileName,
                         int aKilobytes)
                         throws DIException

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

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

String[] getEHLogFileNames(String aEHName)
                           throws DIException

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

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

String getEHLastLogFileName(String aEHName)
                            throws DIException

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

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

String getEHLog(String aEHName,
                String aLogFileName)
                throws DIException

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

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

String getEHLogLastChunk(String aEHName,
                         String aLogFileName,
                         int aKilobytes)
                         throws DIException

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

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

Date getInstanceBootTime()
                         throws DIException

Returns the Instance boot time.

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.

getGlobalUniqueID

String getGlobalUniqueID()
                         throws DIException

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

Returns:

The Config Instance GUID value.

Throws:

DIException - if an error occurs while retrieving the Config Instance GUID value.

getConnectorPoolNames

String[] getConnectorPoolNames()
                               throws DIException

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

Returns:

String array containing the Connector Pool names.

Throws:

DIException - if an error occurs while retrieving the names of all Connector Pools.

getConnectorPoolSize

int getConnectorPoolSize(String aConnectorPoolName)
                         throws DIException

Returns the size of the specified Connector Pool.

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 the size of the specified Connector Pool.

getConnectorPoolFreeNum

int getConnectorPoolFreeNum(String aConnectorPoolName)
                            throws DIException

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

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 the number of free Connectors in the specified Connector Pool.

getConnectorPoolConfig

PoolDefConfig getConnectorPoolConfig(String aConnectorPoolName)
                                     throws DIException

Returns the Connector Pool configuration object.

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 the Connector Pool configuration object.

purgeConnectorPool

int purgeConnectorPool(String aConnectorPoolName)
                       throws DIException

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

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.

getTDIProperties

TDIProperties getTDIProperties()
                               throws Exception

Used to obtain a reference to TDIProperties for managing properties / property stores.

Returns:

A reference to the TDIProperties interface.

Throws:

Exception - if an error occurs while obtaining a reference to TDIProperties.