Package com.ibm.di.api.jmx.mbeans

Interface DIServerMBean

  • All Superinterfaces:
    BaseAdminMBean, BaseMBean
    All Known Implementing Classes:
    DIServer
    public interface DIServerMBean
extends BaseAdminMBean
    DIServerMBean interface that defines public methods exposed through JMX layer for manipulating TDI Server.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      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.
      javax.management.ObjectName createNewConfigInstance​(java.lang.String aConfigUrl, java.lang.String aPassword)
      Deprecated.
      Not for public use in the future.
      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.

    • Method Detail

      • startConfigInstance

        javax.management.ObjectName startConfigInstance​(java.lang.String aConfigUrl)
                                         throws DIException
        Starts a new Config Instance on the Server with the configuration given.
        Parameters:
        aConfigUrl - The URL where the configuration file is loaded from.
        Returns:
        ObjectName generated from the configuration ID.
        Throws:
        DIException - if an error occurs on starting the new Config Instance.

      • startConfigInstance

        javax.management.ObjectName startConfigInstance​(java.lang.String aConfigUrl,
                                                java.lang.Boolean aKeepAlive,
                                                java.lang.String aPassword)
                                         throws DIException
        Starts a new Config Instance on the Server with the configuration given.
        Parameters:
        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.
        Returns:
        ObjectName generated from the configuration ID.
        Throws:
        DIException - if an error occurs on starting the new Config Instance.

      • createNewConfigInstance

        javax.management.ObjectName createNewConfigInstance​(java.lang.String aConfigUrl)
                                             throws DIException
        Deprecated.
        Not for public use in the future. Creates and starts a new Config Instance with an empty configuration.
        Parameters:
        aConfigUrl - The URL of the new configuration file to be created.
        Throws:
        DIException - if an error occurs while creating the new Config Instance.

      • createNewConfigInstance

        javax.management.ObjectName createNewConfigInstance​(java.lang.String aConfigUrl,
                                                    java.lang.String aPassword)
                                             throws DIException
        Deprecated.
        Not for public use in the future. Creates and starts a new Config Instance with an empty configuration.
        Parameters:
        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.
        Throws:
        DIException - if an error occurs while creating the new Config Instance.

      • shutDownServer

        void shutDownServer()
             throws DIException
        Shuts down the TDI Server.
        Throws:
        DIException - if an error occurs while shutting down the server.

      • shutDownServer

        void shutDownServer​(java.lang.Integer aExitCode)
             throws DIException
        Shuts down the TDI Server with the specified exit code.
        Parameters:
        aExitCode - the exit code used to shut down TDI Server.
        Throws:
        DIException - if an error occurs while shutting down the server.

      • isSSLon

        boolean isSSLon()
         throws DIException
        Checks if the SSL on the server is turned on.
        Returns:
        true if SSL is enabled on server
        Throws:
        DIException - if an error occurs while retrieving the information.

      • releaseConfigurationLock

        boolean releaseConfigurationLock​(java.lang.String aRelativePath)
                          throws DIException
        Administratively releases the lock of the specified configuration. This call can be only executed by users with the admin role.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        Returns:
        true if the configuration lock has been release, false otherwise.
        Throws:
        DIException - If an error occurs during releasing the lock.

      • undoCheckOut

        boolean undoCheckOut​(java.lang.String aRelativePath)
              throws DIException
        Releases the lock on the specified configuration, thus aborting all changes being done. This call can only be executed from a user that has previously checked out the configuration and only if the configuration lock has not timed out.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        Returns:
        true if the undo operation is successful, false otherwise.
        Throws:
        DIException - If an error occurs during releasing the lock.

      • listConfigurations

        java.util.ArrayList listConfigurations​(java.lang.String aRelativePath)
                                throws DIException
        Returns a list of the file names of all configurations in the specified folder. The configurations file paths returned are relative to the Server configuration codebase folder.
        Parameters:
        aRelativePath - A folder relative to the Server configuration codebase folder.
        Returns:
        A list with the file names of all configurations in the specified folder.
        Throws:
        DIException - If an error occurs while retrieving configurations.

      • listFolders

        java.util.ArrayList listFolders​(java.lang.String aRelativePath)
                         throws DIException
        Returns a list of the child folders of the specified folder.
        Parameters:
        aRelativePath - A folder relative to the Server configuration codebase folder.
        Returns:
        A list of the child folders of the specified folder.
        Throws:
        DIException - If an error occurs while retrieving child folder.

      • listAllConfigurations

        java.util.ArrayList listAllConfigurations()
                                   throws DIException
        Returns a list of the file names of all configurations in the directory subtree of the Server configuration codebase folder. The configurations file paths returned are relative to the TDI Server configuration codebase folder.
        Returns:
        A list of the file names of all configurations from the whole configuration codebase directory subtree.
        Throws:
        DIException - If an error occurs while retrieving configurations.

      • checkOutConfiguration

        MetamergeConfig checkOutConfiguration​(java.lang.String aRelativePath)
                               throws DIException
        Checks out the specified configuration. Returns the MetamergeConfig object representing the configuration and locks that configuration on the Server.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        Returns:
        The MetamergeConfig object representing the specified configuration.
        Throws:
        DIException - If an error occurs while checking out the configuration.

      • checkOutConfiguration

        MetamergeConfig checkOutConfiguration​(java.lang.String aRelativePath,
                                      java.lang.String aPassword)
                               throws DIException
        Checks out the specified password protected configuration. Returns the MetamergeConfig object representing the configuration and locks that configuration on the Server.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        aPassword - Specify the password for password protected configurations.
        Returns:
        The MetamergeConfig object representing the specified configuration.
        Throws:
        DIException - If an error occurs while checking out the configuration.

      • checkOutConfigurationAndLoad

        javax.management.ObjectName checkOutConfigurationAndLoad​(java.lang.String aRelativePath,
                                                         java.lang.String aPassword)
                                                  throws DIException
        Checks out the specified configuration and starts a temporary Config Instance on the Server.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        aPassword - Specify the password for password protected configurations.
        Returns:
        The ConfigInstance Object Name for the temporary ConfigIsntance started on the Server.
        Throws:
        DIException - If an error occurs while checking out the configuration.

      • checkOutConfigurationAndLoad

        javax.management.ObjectName checkOutConfigurationAndLoad​(java.lang.String aRelativePath)
                                                  throws DIException
        Checks out the specified configuration and starts a temporary Config Instance on the Server.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        Returns:
        The ConfigInstance Object Name for the temporary ConfigIsntance started on the Server.
        Throws:
        DIException - If an error occurs while checking out the configuration.

      • checkInConfiguration

        void checkInConfiguration​(MetamergeConfig aConfiguration,
                          java.lang.String aRelativePath)
                   throws DIException
        Saves the specified configuration and releases the lock. If a temporary ConfigInstance has been started on check out, it will be stopped as well.
        Parameters:
        aConfiguration - The MetamergeConfig object representing the configuration to be checked in.
        aRelativePath - The path of the configuration relative to the Server configuration codebase folder.
        Throws:
        DIException - If an error occurs while checking in the configuration.

      • checkInConfiguration

        void checkInConfiguration​(MetamergeConfig aConfiguration,
                          java.lang.String aRelativePath,
                          boolean aEncrypt)
                   throws DIException
        Encrypts and saves the specified configuration and releases the lock. If a temporary Config Instance has been started on check out, it will be stopped as well.
        Parameters:
        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.
        Throws:
        DIException - If an error occurs while checking in the configuration.

      • checkInAndLeaveCheckedOut

        void checkInAndLeaveCheckedOut​(MetamergeConfig aConfiguration,
                               java.lang.String aRelativePath)
                        throws DIException
        Checks in the specified configuration and leaves it checked out. The timeout for the lock on the configuration is reset.
        Parameters:
        aConfiguration - The MetamergeConfig object representing the configuration to be checked in.
        aRelativePath - The path of the configuration relative to the Server configuration codebase folder.
        Throws:
        DIException - If an error occurs while checking in the configuration.

      • createNewConfiguration

        MetamergeConfig createNewConfiguration​(java.lang.String aRelativePath,
                                       boolean aOverwrite)
                                throws DIException
        Creates a new empty configuration and immediately checks it out. If a configuration with the specified path already exists and the aOverwrite parameter is set to false the operation will fail and an Exception will be thrown.
        Parameters:
        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.
        Returns:
        The MetamergeConfig object representing the newly created configuration.
        Throws:
        DIException - If an error occurs while creating the new configuration.

      • createNewConfigurationAndLoad

        javax.management.ObjectName createNewConfigurationAndLoad​(java.lang.String aRelativePath,
                                                          boolean aOverwrite)
                                                   throws DIException
        Creates a new empty configuration, immediately checks it out and loads a temporary Config Instance on the Server. If a configuration with the specified path already exists and the aOverwrite parameter is set to false the operation will fail and an Exception will be thrown.
        Parameters:
        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.
        Returns:
        The ConfigInstance Object Name for the temporary ConfigIsntance started on the Server.
        Throws:
        DIException - If an error occurs while creating the new configuration.

      • isConfigurationCheckedOut

        boolean isConfigurationCheckedOut​(java.lang.String aRelativePath)
                           throws DIException
        Checks if the specified configuration is checked out on the Server.
        Parameters:
        aRelativePath - The path to the configuration relative to the Server configuration codebase folder.
        Returns:
        true if the specified configuration is checked out, false otherwise.
        Throws:
        DIException - If an error occurs while checking the configuration.

      • sendCustomNotification

        void sendCustomNotification​(java.lang.String aType,
                            java.lang.String aId,
                            java.lang.Object aData)
                     throws DIException
        Sends a custom, user defined notification to all registered listeners.
        Parameters:
        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.
        Throws:
        DIException - If an error occurs while sending the notification.