|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DIServerMBean
DIServerMBean interface that defines public methods exposed through JMX layer for manipulating TDI Server.
Method Summary | |
---|---|
void |
checkInAndLeaveCheckedOut(MetamergeConfig aConfiguration,
java.lang.String aRelativePath)
Checks in the specified configuration and leaves it checked out. |
void |
checkInConfiguration(MetamergeConfig aConfiguration,
java.lang.String aRelativePath)
Saves the specified configuration and releases the lock. |
void |
checkInConfiguration(MetamergeConfig aConfiguration,
java.lang.String aRelativePath,
boolean aEncrypt)
Encrypts and saves the specified configuration and releases the lock. |
MetamergeConfig |
checkOutConfiguration(java.lang.String aRelativePath)
Checks out the specified configuration. |
MetamergeConfig |
checkOutConfiguration(java.lang.String aRelativePath,
java.lang.String aPassword)
Checks out the specified password protected configuration. |
javax.management.ObjectName |
checkOutConfigurationAndLoad(java.lang.String aRelativePath)
Checks out the specified configuration and starts a temporary Config Instance on the Server. |
javax.management.ObjectName |
checkOutConfigurationAndLoad(java.lang.String aRelativePath,
java.lang.String aPassword)
Checks out the specified configuration and starts a temporary Config Instance on the Server. |
javax.management.ObjectName |
createNewConfigInstance(java.lang.String aConfigUrl)
Deprecated. Not for public use in the future. Creates and starts a new Config Instance with an empty configuration. |
javax.management.ObjectName |
createNewConfigInstance(java.lang.String aConfigUrl,
java.lang.String aPassword)
Deprecated. Not for public use in the future. Creates and starts a new Config Instance with an empty configuration. |
MetamergeConfig |
createNewConfiguration(java.lang.String aRelativePath,
boolean aOverwrite)
Creates a new empty configuration and immediately checks it out. |
javax.management.ObjectName |
createNewConfigurationAndLoad(java.lang.String aRelativePath,
boolean aOverwrite)
Creates a new empty configuration, immediately checks it out and loads a temporary Config Instance on the Server. |
boolean |
isConfigurationCheckedOut(java.lang.String aRelativePath)
Checks if the specified configuration is checked out on the Server. |
boolean |
isSSLon()
Checks if the SSL on the server is turned on. |
java.util.ArrayList |
listAllConfigurations()
Returns a list of the file names of all configurations in the directory subtree of the Server configuration codebase folder. |
java.util.ArrayList |
listConfigurations(java.lang.String aRelativePath)
Returns a list of the file names of all configurations in the specified folder. |
java.util.ArrayList |
listFolders(java.lang.String aRelativePath)
Returns a list of the child folders of the specified folder. |
boolean |
releaseConfigurationLock(java.lang.String aRelativePath)
Administratively releases the lock of the specified configuration. |
void |
sendCustomNotification(java.lang.String aType,
java.lang.String aId,
java.lang.Object aData)
Sends a custom, user defined notification to all registered listeners. |
void |
shutDownServer()
Shuts down the TDI Server. |
void |
shutDownServer(java.lang.Integer aExitCode)
Shuts down the TDI Server with the specified exit code. |
javax.management.ObjectName |
startConfigInstance(java.lang.String aConfigUrl)
Starts a new Config Instance on the Server with the configuration given. |
javax.management.ObjectName |
startConfigInstance(java.lang.String aConfigUrl,
java.lang.Boolean aKeepAlive,
java.lang.String aPassword)
Starts a new Config Instance on the Server with the configuration given. |
boolean |
undoCheckOut(java.lang.String aRelativePath)
Releases the lock on the specified configuration, thus aborting all changes being done. |
Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean |
---|
getId, getType |
Method Detail |
---|
javax.management.ObjectName startConfigInstance(java.lang.String aConfigUrl) throws DIException
aConfigUrl
- The URL where the configuration file is loaded from.
DIException
- if an error occurs on starting the new Config Instance.javax.management.ObjectName startConfigInstance(java.lang.String aConfigUrl, java.lang.Boolean aKeepAlive, java.lang.String aPassword) throws DIException
aConfigUrl
- The URL where the configuration file is loaded from.aKeepAlive
- When true
the Config Instance will stay alive
even when no threads are running, when false
the Config Instance will automatically terminate when its last
thread terminates.aPassword
- Specify the password of the configuration when it is
password-protected; specify null
when the
configuration is not password-protected.
DIException
- if an error occurs on starting the new Config Instance.javax.management.ObjectName createNewConfigInstance(java.lang.String aConfigUrl) throws DIException
aConfigUrl
- The URL of the new configuration file to be created.
DIException
- if an error occurs while creating the new Config Instance.javax.management.ObjectName createNewConfigInstance(java.lang.String aConfigUrl, java.lang.String aPassword) throws DIException
aConfigUrl
- The URL of the new configuration file to be created.aPassword
- If this parameter is not null
, the new
configuration will be protected with the given password.
DIException
- if an error occurs while creating the new Config Instance.void shutDownServer() throws DIException
DIException
- if an error occurs while shutting down the server.void shutDownServer(java.lang.Integer aExitCode) throws DIException
aExitCode
- the exit code used to shut down TDI Server.
DIException
- if an error occurs while shutting down the server.boolean isSSLon() throws DIException
DIException
- if an error occurs while retrieving the information.boolean releaseConfigurationLock(java.lang.String aRelativePath) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs during releasing the lock.boolean undoCheckOut(java.lang.String aRelativePath) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs during releasing the lock.java.util.ArrayList listConfigurations(java.lang.String aRelativePath) throws DIException
aRelativePath
- A folder relative to the Server configuration codebase folder.
DIException
- If an error occurs while retrieving configurations.java.util.ArrayList listFolders(java.lang.String aRelativePath) throws DIException
aRelativePath
- A folder relative to the Server configuration codebase folder.
DIException
- If an error occurs while retrieving child folder.java.util.ArrayList listAllConfigurations() throws DIException
DIException
- If an error occurs while retrieving configurations.MetamergeConfig checkOutConfiguration(java.lang.String aRelativePath) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs while checking out the configuration.MetamergeConfig checkOutConfiguration(java.lang.String aRelativePath, java.lang.String aPassword) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.aPassword
- Specify the password for password protected configurations.
DIException
- If an error occurs while checking out the configuration.javax.management.ObjectName checkOutConfigurationAndLoad(java.lang.String aRelativePath, java.lang.String aPassword) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.aPassword
- Specify the password for password protected configurations.
DIException
- If an error occurs while checking out the configuration.javax.management.ObjectName checkOutConfigurationAndLoad(java.lang.String aRelativePath) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs while checking out the configuration.void checkInConfiguration(MetamergeConfig aConfiguration, java.lang.String aRelativePath) throws DIException
aConfiguration
- The MetamergeConfig object representing the configuration to
be checked in.aRelativePath
- The path of the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs while checking in the configuration.void checkInConfiguration(MetamergeConfig aConfiguration, java.lang.String aRelativePath, boolean aEncrypt) throws DIException
aConfiguration
- The MetamergeConfig object representing the configuration to
be checked in.aRelativePath
- The path of the configuration relative to the Server
configuration codebase folder.aEncrypt
- If set to true, the configuration will be encrypted on the
Server.
DIException
- If an error occurs while checking in the configuration.void checkInAndLeaveCheckedOut(MetamergeConfig aConfiguration, java.lang.String aRelativePath) throws DIException
aConfiguration
- The MetamergeConfig object representing the configuration to
be checked in.aRelativePath
- The path of the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs while checking in the configuration.MetamergeConfig createNewConfiguration(java.lang.String aRelativePath, boolean aOverwrite) throws DIException
aRelativePath
- The path of the new configuration file relative to the Server
configuration codebase folder.aOverwrite
- Specify whether to overwrite or not an already existing
configuration file.
DIException
- If an error occurs while creating the new configuration.javax.management.ObjectName createNewConfigurationAndLoad(java.lang.String aRelativePath, boolean aOverwrite) throws DIException
aRelativePath
- The path of the new configuration file relative to the Server
configuration codebase folder.aOverwrite
- Specify whether to overwrite or not an already existing
configuration file.
DIException
- If an error occurs while creating the new configuration.boolean isConfigurationCheckedOut(java.lang.String aRelativePath) throws DIException
aRelativePath
- The path to the configuration relative to the Server
configuration codebase folder.
DIException
- If an error occurs while checking the configuration.void sendCustomNotification(java.lang.String aType, java.lang.String aId, java.lang.Object aData) throws DIException
aType
- Notification type, will be automatically prefixed with "user."aId
- Notification ID, usually identifies the object this event
originated from.aData
- Custom user data. Make sure the object passed is serializable
if you want to send this event notification in a remote
context.
DIException
- If an error occurs while sending the notification.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |