com.ibm.di.api.remote.impl
Class ConfigInstanceImpl

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.ConfigInstanceImpl

All Implemented Interfaces:

ConfigInstance, Serializable, Remote

public class ConfigInstanceImpl
extends UnicastRemoteObject
implements ConfigInstance

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Method Summary

static ConfigInstanceImpl	createInstance(ConfigInstance aLocalConfigInstance, SessionImpl aSession)
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() Returns the TDIProperties object associated with the current configuration.
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)
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.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getConfigId

public String getConfigId()
                   throws DIException,
                          RemoteException

Description copied from interface: ConfigInstance

Returns the configuration ID generated by the server.

Specified by:

getConfigId in interface ConfigInstance

Returns:

String object representing the configuration ID.

Throws:

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

RemoteException - if a communication-related exception occurs.

getConfiguration

public MetamergeConfig getConfiguration()
                                 throws DIException,
                                        RemoteException

Description copied from interface: ConfigInstance

Returns configuration instance representing this configuration.

Specified by:

getConfiguration in interface ConfigInstance

Returns:

MetamergeConfig object representing this configuration.

Throws:

DIException - if an error occurs while getting the configuration.

RemoteException - if a communication-related exception occurs.

setConfiguration

public void setConfiguration(MetamergeConfig aConfiguration)
                      throws DIException,
                             RemoteException

Description copied from interface: ConfigInstance

Sets given configuration to this configuration.

Specified by:

setConfiguration in interface ConfigInstance

Parameters:

aConfiguration - The new configuration.

Throws:

DIException - if an error occurs while setting the configuration.

RemoteException - if a communication-related exception occurs.

getAssemblyLinesNames

public String[] getAssemblyLinesNames()
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Returns the AssemblyLines’ names.

Specified by:

getAssemblyLinesNames in interface ConfigInstance

Returns:

String array each value representing AssemblyLine name.

Throws:

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

RemoteException - if a communication-related exception occurs.

getAssemblyLineInputParameters

public SchemaConfig getAssemblyLineInputParameters(String aAssemblyLineName)
                                            throws DIException,
                                                   RemoteException

Description copied from interface: ConfigInstance

Returns the AssemblyLine’s input parameters.

Specified by:

getAssemblyLineInputParameters in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getAssemblyLineOutputParameters

public SchemaConfig getAssemblyLineOutputParameters(String aAssemblyLineName)
                                             throws DIException,
                                                    RemoteException

Description copied from interface: ConfigInstance

Returns the AssemblyLine’s output parameters.

Specified by:

getAssemblyLineOutputParameters in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getEventHandlersNames

public String[] getEventHandlersNames()
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Returns the EventHandlers’ names.

Specified by:

getEventHandlersNames in interface ConfigInstance

Returns:

String array each value representing EventHandler name.

Throws:

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

RemoteException - if a communication-related exception occurs.

getAssemblyLines

public AssemblyLine[] getAssemblyLines()
                                throws DIException,
                                       RemoteException

Description copied from interface: ConfigInstance

Returns currently started AssemblyLines of the configuration instance.

Specified by:

getAssemblyLines in interface ConfigInstance

Returns:

AssemblyLine array object each value represents currently started AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLines.

RemoteException - if a communication-related exception occurs.

getEventHandlers

public EventHandler[] getEventHandlers()
                                throws DIException,
                                       RemoteException

Description copied from interface: ConfigInstance

Returns currently started EventHandlers of the configuration instance.

Specified by:

getEventHandlers in interface ConfigInstance

Returns:

EventHandler array object each value represents currently started EventHandler.

Throws:

DIException - if an error occurs while getting the EventHandlers.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

public AssemblyLine startAssemblyLine(String aAssemblyLineName)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts the specified AssemblyLine asynchronously.

Specified by:

startAssemblyLine in interface ConfigInstance

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

Returns:

the AssemblyLine object.

Throws:

DIException - if an error occurs when starting the AssemblyLine.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

public AssemblyLine startAssemblyLine(String aAssemblyLineName,
                                      boolean aSync)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts the specified AssemblyLine.

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

public AssemblyLine startAssemblyLine(String aAssemblyLineName,
                                      Entry aInputData)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts the specified AssemblyLine with the given input data asynchronously.

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

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

Description copied from interface: ConfigInstance

Starts the specified AssemblyLine with the given input data.

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

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

Description copied from interface: ConfigInstance

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

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

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

Description copied from interface: ConfigInstance

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

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLineManual

public AssemblyLineHandler startAssemblyLineManual(String aAssemblyLineName,
                                                   Entry aInputData)
                                            throws DIException,
                                                   RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

startAssemblyLineManual in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

public AssemblyLine startAssemblyLine(String aAssemblyLineName,
                                      TaskCallBlock aTcb)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts asynchronously the specified AssemblyLine with the given TaskCallBlock.

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startAssemblyLine

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

Description copied from interface: ConfigInstance

Starts the specified AssemblyLine with the given TaskCallBlock.

Specified by:

startAssemblyLine in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

startEventHandler

public EventHandler startEventHandler(String aEventHandlerName)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts the specified EventHandler asynchronously.

Specified by:

startEventHandler in interface ConfigInstance

Parameters:

aEventHandlerName - the name of the EventHandler to start.

Throws:

DIException - if an error occurs while starting the EventHandler.

RemoteException - if a communication-related exception occurs.

startEventHandler

public EventHandler startEventHandler(String aEventHandlerName,
                                      boolean aSync)
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

Starts the specified EventHandler.

Specified by:

startEventHandler in interface ConfigInstance

Parameters:

aEventHandlerName - the name of the EventHandler to start.

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

Throws:

DIException - if an error occurs while starting the EventHandler.

RemoteException - if a communication-related exception occurs.

startEventHandler

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

Description copied from interface: ConfigInstance

Starts the specified EventHandler asynchronously.

Specified by:

startEventHandler in interface ConfigInstance

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.

Throws:

DIException - if an error occurs while starting the EventHandler.

RemoteException - if a communication-related exception occurs.

startEventHandler

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

Description copied from interface: ConfigInstance

Starts the specified EventHandler.

Specified by:

startEventHandler in interface ConfigInstance

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.

Throws:

DIException - if an error occurs while starting the EventHandler.

RemoteException - if a communication-related exception occurs.

reload

public void reload()
            throws DIException,
                   RemoteException

Description copied from interface: ConfigInstance

Reloads the Config Instance with its current configuration.

Specified by:

reload in interface ConfigInstance

Throws:

DIException - if an error occurs while reloading the server.

RemoteException - if a communication-related exception occurs.

stop

public void stop()
          throws DIException,
                 RemoteException

Description copied from interface: ConfigInstance

Stops the Config Instance.

Specified by:

stop in interface ConfigInstance

Throws:

DIException - if an error occurs while stopping.

RemoteException - if a communication-related exception occurs.

getALLogFileNames

public String[] getALLogFileNames(String aALName)
                           throws DIException,
                                  RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getALLogFileNames in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getALLastLogFileName

public String getALLastLogFileName(String aALName)
                            throws DIException,
                                   RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getALLastLogFileName in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getALLog

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

Description copied from interface: ConfigInstance

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 ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getALLogLastChunk

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

Description copied from interface: ConfigInstance

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

Specified by:

getALLogLastChunk in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getEHLogFileNames

public String[] getEHLogFileNames(String aEHName)
                           throws DIException,
                                  RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getEHLogFileNames in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getEHLastLogFileName

public String getEHLastLogFileName(String aEHName)
                            throws DIException,
                                   RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getEHLastLogFileName in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getEHLog

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

Description copied from interface: ConfigInstance

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 ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getEHLogLastChunk

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

Description copied from interface: ConfigInstance

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

Specified by:

getEHLogLastChunk in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getInstanceBootTime

public Date getInstanceBootTime()
                         throws DIException,
                                RemoteException

Description copied from interface: ConfigInstance

Returns the Instance boot time.

Specified by:

getInstanceBootTime in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

saveConfiguration

public void saveConfiguration()
                       throws DIException,
                              RemoteException

Specified by:

saveConfiguration in interface ConfigInstance

Throws:

DIException

RemoteException

saveConfiguration

public void saveConfiguration(boolean aEncrypt)
                       throws DIException,
                              RemoteException

Specified by:

saveConfiguration in interface ConfigInstance

Throws:

DIException

RemoteException

getExternalProperties

public ExternalPropertiesConfig getExternalProperties()
                                               throws DIException,
                                                      RemoteException

Description copied from interface: ConfigInstance

Returns the external properties of the configuration.

Specified by:

getExternalProperties in interface ConfigInstance

Returns:

ExternalPropertiesConfig object representing the configuration’s external properties.

Throws:

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

RemoteException - if a communication-related exception occurs.

getExternalProperties

public ExternalPropertiesConfig getExternalProperties(String aKey)
                                               throws DIException,
                                                      RemoteException

Description copied from interface: ConfigInstance

Returns the ExternalPropertiesConfig object for the named external properties object.

Specified by:

getExternalProperties in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getExternalPropertiesKeys

public String[] getExternalPropertiesKeys()
                                   throws DIException,
                                          RemoteException

Description copied from interface: ConfigInstance

Returns the external properties object names.

Specified by:

getExternalPropertiesKeys in interface ConfigInstance

Returns:

String array each value representing one external property object name.

Throws:

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

RemoteException - if a communication-related exception occurs.

setExternalProperties

public void setExternalProperties(ExternalPropertiesConfig aExPropConfig)
                           throws DIException,
                                  RemoteException

Specified by:

setExternalProperties in interface ConfigInstance

Throws:

DIException

RemoteException

setExternalProperties

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

Specified by:

setExternalProperties in interface ConfigInstance

Throws:

DIException

RemoteException

saveExternalProperties

public void saveExternalProperties()
                            throws DIException,
                                   RemoteException

Specified by:

saveExternalProperties in interface ConfigInstance

Throws:

DIException

RemoteException

createInstance

public static ConfigInstanceImpl createInstance(ConfigInstance aLocalConfigInstance,
                                                SessionImpl aSession)
                                         throws DIException,
                                                RemoteException

Throws:

DIException

RemoteException

getGlobalUniqueID

public String getGlobalUniqueID()
                         throws DIException,
                                RemoteException

Description copied from interface: ConfigInstance

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 ConfigInstance

Returns:

The Config Instance GUID value.

Throws:

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

RemoteException - if a communication-related exception occurs.

getConnectorPoolNames

public String[] getConnectorPoolNames()
                               throws DIException,
                                      RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getConnectorPoolNames in interface ConfigInstance

Returns:

String array containing the Connector Pool names.

Throws:

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

RemoteException - if a communication-related exception occurs.

getConnectorPoolSize

public int getConnectorPoolSize(String aConnectorPoolName)
                         throws DIException,
                                RemoteException

Description copied from interface: ConfigInstance

Returns the size of the specified Connector Pool.

Specified by:

getConnectorPoolSize in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getConnectorPoolFreeNum

public int getConnectorPoolFreeNum(String aConnectorPoolName)
                            throws DIException,
                                   RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

getConnectorPoolFreeNum in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getConnectorPoolConfig

public PoolDefConfig getConnectorPoolConfig(String aConnectorPoolName)
                                     throws DIException,
                                            RemoteException

Description copied from interface: ConfigInstance

Returns the Connector Pool configuration object.

Specified by:

getConnectorPoolConfig in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

purgeConnectorPool

public int purgeConnectorPool(String aConnectorPoolName)
                       throws DIException,
                              RemoteException

Description copied from interface: ConfigInstance

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

Specified by:

purgeConnectorPool in interface ConfigInstance

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.

RemoteException - if a communication-related exception occurs.

getTDIProperties

public TDIProperties getTDIProperties()
                               throws Exception,
                                      RemoteException

Description copied from interface: ConfigInstance

Returns the TDIProperties object associated with the current configuration. The TDIProperties can then be used to obtain list of property stores, get/set/remove property values,etc.

Specified by:

getTDIProperties in interface ConfigInstance

Returns:

TDIProperties object associated with the current configuration.

Throws:

Exception - if an error occurs while retrieving TDIProperties object.

RemoteException - if a communication-related exception occurs.