|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigInstance
ConfigInstance MBean inteface that defines public methods exposed through Server API remote session.
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()
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()
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 |
---|
String getConfigId() throws DIException, RemoteException
DIException
- if an error occurs while getting the configuration ID.
RemoteException
- if a communication-related exception occurs.MetamergeConfig getConfiguration() throws DIException, RemoteException
DIException
- if an error occurs while getting the configuration.
RemoteException
- if a communication-related exception occurs.void setConfiguration(MetamergeConfig aConfiguration) throws DIException, RemoteException
aConfiguration
- The new configuration.
DIException
- if an error occurs while setting the configuration.
RemoteException
- if a communication-related exception occurs.void saveConfiguration() throws DIException, RemoteException
DIException
RemoteException
void saveConfiguration(boolean aEncrypt) throws DIException, RemoteException
DIException
RemoteException
ExternalPropertiesConfig getExternalProperties() throws DIException, RemoteException
DIException
- if an error occurs while getting the external properties.
RemoteException
- if a communication-related exception occurs.ExternalPropertiesConfig getExternalProperties(String aKey) throws DIException, RemoteException
aKey
- The external property object name.
DIException
- if an error occurs while getting the external properties.
RemoteException
- if a communication-related exception occurs.String[] getExternalPropertiesKeys() throws DIException, RemoteException
DIException
- if an error occurs while getting the external properties names.
RemoteException
- if a communication-related exception occurs.void setExternalProperties(ExternalPropertiesConfig aExPropConfig) throws DIException, RemoteException
DIException
RemoteException
void setExternalProperties(String aKey, ExternalPropertiesConfig aExPropConfig) throws DIException, RemoteException
DIException
RemoteException
void saveExternalProperties() throws DIException, RemoteException
DIException
RemoteException
String[] getAssemblyLinesNames() throws DIException, RemoteException
DIException
- if an error occurs while getting the AssemblyLines’ names.
RemoteException
- if a communication-related exception occurs.SchemaConfig getAssemblyLineInputParameters(String aAssemblyLineName) throws DIException, RemoteException
aAssemblyLineName
- the name of the AssemblyLine.
DIException
- if an error occurs while getting the AssemblyLine's input parameters.
RemoteException
- if a communication-related exception occurs.SchemaConfig getAssemblyLineOutputParameters(String aAssemblyLineName) throws DIException, RemoteException
aAssemblyLineName
- the name of the AssemblyLine.
DIException
- if an error occurs while getting the AssemblyLine's output parameters.
RemoteException
- if a communication-related exception occurs.String[] getEventHandlersNames() throws DIException, RemoteException
DIException
- if an error occurs while getting the EventHandlers’ names.
RemoteException
- if a communication-related exception occurs.AssemblyLine[] getAssemblyLines() throws DIException, RemoteException
DIException
- if an error occurs while getting the AssemblyLines.
RemoteException
- if a communication-related exception occurs.EventHandler[] getEventHandlers() throws DIException, RemoteException
DIException
- if an error occurs while getting the EventHandlers.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName) throws DIException, RemoteException
aAssemblyLineName
- The name of the AssemblyLine.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, boolean aSync) throws DIException, RemoteException
aAssemblyLineName
- The name of the AssemblyLine.aSync
- when true
the AssemblyLine is started synchronously,
when false
the AssemblyLine is started asynchronously.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, Entry aInputData) throws DIException, RemoteException
aAssemblyLineName
- The name of the AssemblyLine.aInputData
- Initial Work Entry to run the AssemblyLine with.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, Entry aInputData, boolean aSync) throws DIException, RemoteException
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.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, boolean aGetLogs) throws DIException, RemoteException
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.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, Entry aInputData, AssemblyLineListener aListener, boolean aGetLogs, boolean aSync) throws DIException, RemoteException
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.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLineHandler startAssemblyLineManual(String aAssemblyLineName, Entry aInputData) throws DIException, RemoteException
aAssemblyLineName
- The name of the AssemblyLine.aInputData
- Initial Work Entry to run the AssemblyLine with.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb) throws DIException, RemoteException
aAssemblyLineName
- The name of the AssemblyLine.aTcb
- The TaskCallBlock object to start the AL with.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLine startAssemblyLine(String aAssemblyLineName, TaskCallBlock aTcb, boolean aSync) throws DIException, RemoteException
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.
DIException
- if an error occurs when starting the AssemblyLine.
RemoteException
- if a communication-related exception occurs.EventHandler startEventHandler(String aEventHandlerName) throws DIException, RemoteException
aEventHandlerName
- the name of the EventHandler to start.
DIException
- if an error occurs while starting the EventHandler.
RemoteException
- if a communication-related exception occurs.EventHandler startEventHandler(String aEventHandlerName, boolean aSync) throws DIException, RemoteException
aEventHandlerName
- the name of the EventHandler to start.aSync
- when true
the EventHandler is started synchronously,
when false
the EventHandler is started asynchronously.
DIException
- if an error occurs while starting the EventHandler.
RemoteException
- if a communication-related exception occurs.EventHandler startEventHandler(String aEventHandlerName, EventHandlerListener aListener, boolean aGetLogs, boolean aRecordEvents) throws DIException, RemoteException
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.
DIException
- if an error occurs while starting the EventHandler.
RemoteException
- if a communication-related exception occurs.EventHandler startEventHandler(String aEventHandlerName, EventHandlerListener aListener, boolean aGetLogs, boolean aRecordEvents, boolean aSync) throws DIException, RemoteException
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.
DIException
- if an error occurs while starting the EventHandler.
RemoteException
- if a communication-related exception occurs.void reload() throws DIException, RemoteException
DIException
- if an error occurs while reloading the server.
RemoteException
- if a communication-related exception occurs.void stop() throws DIException, RemoteException
DIException
- if an error occurs while stopping.
RemoteException
- if a communication-related exception occurs.String[] getALLogFileNames(String aALName) throws DIException, RemoteException
aALName
- the name of the AssemblyLine.
DIException
- if an error occurs while obtaining AssemblyLine's log file names.
RemoteException
- if a communication-related exception occurs.String getALLastLogFileName(String aALName) throws DIException, RemoteException
aALName
- the name of the AssemblyLine.
DIException
- if an error occurs while obtaining the log file name.
RemoteException
- if a communication-related exception occurs.String getALLog(String aALName, String aLogFileName) throws DIException, RemoteException
aALName
- the name of the AssemblyLine.aLogFileName
- the name of the log file; no file path should be specified - just the file name.
DIException
- if an error occurs while obtaining AssemblyLine's log.
RemoteException
- if a communication-related exception occurs.String getALLogLastChunk(String aALName, String aLogFileName, int aKilobytes) throws DIException, RemoteException
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.
DIException
- if an error occurs while obtaining AssemblyLine's log.
RemoteException
- if a communication-related exception occurs.String[] getEHLogFileNames(String aEHName) throws DIException, RemoteException
aEHName
- the name of the EventHandler.
DIException
- if an error occurs while obtaining EventHandler's log file names.
RemoteException
- if a communication-related exception occurs.String getEHLastLogFileName(String aEHName) throws DIException, RemoteException
aEHName
- the name of the EventHandler.
DIException
- if an error occurs while obtaining the log file name.
RemoteException
- if a communication-related exception occurs.String getEHLog(String aEHName, String aLogFileName) throws DIException, RemoteException
aEHName
- the name of the EventHandler.aLogFileName
- the name of the log file; no file path should be specified - just the file name.
DIException
- if an error occurs while obtaining EventHandler's log.
RemoteException
- if a communication-related exception occurs.String getEHLogLastChunk(String aEHName, String aLogFileName, int aKilobytes) throws DIException, RemoteException
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.
DIException
- if an error occurs while obtaining EventHandler's log.
RemoteException
- if a communication-related exception occurs.Date getInstanceBootTime() throws DIException, RemoteException
java.util.Date
specifying the date and time the instance
was started.
DIException
- if an error occurs while retrieving instance's boot time.
RemoteException
- if a communication-related exception occurs.String getGlobalUniqueID() throws DIException, RemoteException
DIException
- if an error occurs while retrieving Config Instance GUID value.
RemoteException
- if a communication-related exception occurs.String[] getConnectorPoolNames() throws DIException, RemoteException
DIException
- if an error occurs while retrieving Connector Pool names.
RemoteException
- if a communication-related exception occurs.int getConnectorPoolSize(String aConnectorPoolName) throws DIException, RemoteException
aConnectorPoolName
- the name of the Connector Pool.
DIException
- if an error occurs while retrieving the size of the specified Connector Pool.
RemoteException
- if a communication-related exception occurs.int getConnectorPoolFreeNum(String aConnectorPoolName) throws DIException, RemoteException
aConnectorPoolName
- the name of the Connector Pool.
DIException
- if an error occurs while retrieving the number of free Connectors in the specified Connector Pool.
RemoteException
- if a communication-related exception occurs.PoolDefConfig getConnectorPoolConfig(String aConnectorPoolName) throws DIException, RemoteException
aConnectorPoolName
- the name of the Connector Pool.
DIException
- if an error occurs while retrieving Connector Pool configuration object.
RemoteException
- if a communication-related exception occurs.int purgeConnectorPool(String aConnectorPoolName) throws DIException, RemoteException
aConnectorPoolName
- the name of the Connector Pool.
DIException
- if an error occurs while shrinking the Connector Pool.
RemoteException
- if a communication-related exception occurs.TDIProperties getTDIProperties() throws Exception, RemoteException
Exception
- if an error occurs while retrieving TDIProperties object.
RemoteException
- if a communication-related exception occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |