Package com.ibm.di.api.local

Interface ServerInfo

  • All Known Implementing Classes:
    ServerInfoImpl
    public interface ServerInfo
    This interface provides various methods for getting server information.

    • Method Detail

      • getServerVersion

        java.lang.String getServerVersion()
                           throws DIException
        Returns Server version.
        Returns:
        the version of the server.
        Throws:
        DIException - if an error occurs while retrieving server's data.

      • getIPAddress

        java.lang.String getIPAddress()
                       throws DIException
        Returns Server machine IP address.
        Returns:
        the IP address of the machine where the server is running.
        Throws:
        DIException - if an error occurs while retrieving server's data.

      • getHostName

        java.lang.String getHostName()
                      throws DIException
        Returns Server machine host name.
        Returns:
        the host name of the machine where the server is running.
        Throws:
        DIException - if an error occurs while retrieving server's data.

      • getOperatingSystem

        java.lang.String getOperatingSystem()
                             throws DIException
        Returns the name of the operating system where the Server is running.
        Returns:
        the operating system of the machine where the server is running.
        Throws:
        DIException - if an error occurs while retrieving server's data.

      • getServerBootTime

        java.util.Date getServerBootTime()
                          throws DIException
        Returns the Server boot time.
        Returns:
        a java.util.Date specifying the date and time the server was started.
        Throws:
        DIException - if an error occurs while retrieving server's boot time.

      • getServerID

        java.lang.String getServerID()
                      throws DIException
        Returns the server unique identifier.
        Returns:
        String - the value of the property com.ibm.di.server.id
        Throws:
        DIException - if an error occurs while retrieving server's ID.

      • getInstalledConnectors

        java.util.Hashtable<?,​?>[] getInstalledConnectors()
                                                 throws DIException
        Retrieves information for all Connectors installed on the Server. For each Connector a Hashtable object is constructed, containing the following elements:
        • key "Name" - the value is the name of the Connector
        • key "Description" - the value is the description of the Connector
        • key "Version" - the value is the Connector's version
        Returns:
        a java.util.Hashtable array, each of its elements corresponding to a single Connector.
        Throws:
        DIException - if an error occurs while obtaining installed Connectors' data.

      • getInstalledConnectorsNames

        java.lang.String[] getInstalledConnectorsNames()
                                        throws DIException
        Retrieves the names of all Connectors installed on the Server.
        Returns:
        a String array, each of its elements specifying a Connector name.
        Throws:
        DIException - if an error occurs while obtaining installed Connectors' data.

      • getConnectorDescription

        java.lang.String getConnectorDescription​(java.lang.String aConnectorName)
                                  throws DIException
        Retrieves the description of a Connector installed on the Server.
        Parameters:
        aConnectorName - the name of the Connector whose description will be retrieved.
        Returns:
        the description of the specified Connector.
        Throws:
        DIException - if an error occurs while obtaining Connector data.

      • getConnectorVersionInfo

        java.lang.String getConnectorVersionInfo​(java.lang.String aConnectorName)
                                  throws DIException
        Retrieves the version of a Connector installed on the Server.
        Parameters:
        aConnectorName - the name of the Connector whose version will be retrieved.
        Returns:
        the version of the specified Connector.
        Throws:
        DIException - if an error occurs while obtaining Connector data.

      • getInstalledParsers

        java.util.Hashtable<?,​?>[] getInstalledParsers()
                                              throws DIException
        Retrieves information for all Parsers installed on the Server. For each Parser a Hashtable object is constructed, containing the following elements:
        • key "Name" - the value is the name of the Parser
        • key "Description" - the value is the description of the Parser
        • key "Version" - the value is the Parser's version
        Returns:
        a java.util.Hashtable array, each of its elements corresponding to a single Parser.
        Throws:
        DIException - if an error occurs while obtaining installed Parsers' data.

      • getInstalledParsersNames

        java.lang.String[] getInstalledParsersNames()
                                     throws DIException
        Retrieves the names of all Parsers installed on the Server.
        Returns:
        a String array, each of its elements specifying a Parser name.
        Throws:
        DIException - if an error occurs while obtaining installed Parsers' data.

      • getParserDescription

        java.lang.String getParserDescription​(java.lang.String aParserName)
                               throws DIException
        Retrieves the description of a Parser installed on the Server.
        Parameters:
        aParserName - the name of the Parser whose description will be retrieved.
        Returns:
        the description of the specified Parser.
        Throws:
        DIException - if an error occurs while obtaining Parser data.

      • getParserVersionInfo

        java.lang.String getParserVersionInfo​(java.lang.String aParserName)
                               throws DIException
        Retrieves the version of a Parser installed on the Server.
        Parameters:
        aParserName - the name of the Parser whose version will be retrieved.
        Returns:
        the version of the specified Parser.
        Throws:
        DIException - if an error occurs while obtaining Parser data.

      • getInstalledFunctionComponents

        java.util.Hashtable<?,​?>[] getInstalledFunctionComponents()
                                                         throws DIException
        Retrieves information for all Function Components installed on the Server. For each Function Component a Hashtable object is constructed, containing the following elements:
        • key "Name" - the name of the Function Component
        • key "Description" - the description of the Function Component
        • key "Version" - the Function Component's version
        Returns:
        a java.util.Hashtable array, each of its elements corresponding to a single Function Component.
        Throws:
        DIException - if an error occurs while obtaining installed Function Components' data.

      • getInstalledFunctionComponentsNames

        java.lang.String[] getInstalledFunctionComponentsNames()
                                                throws DIException
        Retrieves the names of all Function Components installed on the Server.
        Returns:
        a String array, each of its elements specifying a Function Component's name.
        Throws:
        DIException - if an error occurs while obtaining installed Function Components' data.

      • getFunctionComponentDescription

        java.lang.String getFunctionComponentDescription​(java.lang.String aFunctionComponentName)
                                          throws DIException
        Retrieves the description of a Function Component installed on the Server.
        Parameters:
        aFunctionComponentName - the name of the Function Component whose description will be retrieved.
        Returns:
        the description of the specified Function Component.
        Throws:
        DIException - if an error occurs while obtaining Function Component data.

      • getFunctionComponentVersionInfo

        java.lang.String getFunctionComponentVersionInfo​(java.lang.String aFunctionComponentName)
                                          throws DIException
        Retrieves the version of a Function Component installed on the Server.
        Parameters:
        aFunctionComponentName - the name of the Function Component whose version will be retrieved.
        Returns:
        the version of the specified Function Component.
        Throws:
        DIException - if an error occurs while obtaining Function Component data.

      • getPasswordParameterNames

        java.util.Vector<java.lang.String> getPasswordParameterNames​(java.lang.String aJavaClassName)
                                                      throws DIException
        Returns password parameters names for specified class.
        Parameters:
        aJavaClassName - Java class name from which password parameters names will be taken.
        Returns:
        Vector object with elements the password parameters names of the given class.
        Throws:
        DIException - if an error occurs while retrieving password parameters names.

      • getInstalledComponentDescriptor

        ComponentDescriptor getInstalledComponentDescriptor​(java.lang.String componentName)
                                             throws DIException
        Returns the localized form information about a specific component as component descriptor object.

        This method is experimental. It is intended for internal use only. Backward compatibility is not guaranteed.

        Parameters:
        componentName - The name of the component (e.g. ibmdi.LDAP or system:/Connectors/ibmdi.LDAP)
        Returns:
        the corresponding component descriptor object.
        Throws:
        DIException - if an error occurs while obtaining component data.
        java.rmi.RemoteException - if a communication-related exception occurs.