com.ibm.di.api.jmx.mbeans
Interface ServerInfoMBean

All Superinterfaces:
BaseAdminMBean, BaseMBean
All Known Implementing Classes:
ServerInfo

public interface ServerInfoMBean
extends BaseAdminMBean

This interface provides various methods for getting server information.


Method Summary
 String getConnectorDescription(String aConnectorName)
          Retrieves the description of a Connector installed on the Server.
 String getConnectorVersionInfo(String aConnectorName)
          Retrieves the version of a Connector installed on the Server.
 String getFunctionComponentDescription(String aFunctionComponentName)
          Retrieves the description of a Function Component installed on the Server.
 String getFunctionComponentVersionInfo(String aFunctionComponentName)
          Retrieves the version of a Function Component installed on the Server.
 String getHostName()
          Returns Server machine host name.
 Hashtable[] getInstalledConnectors()
          Retrieves information for all Connectors installed on the Server.
 String[] getInstalledConnectorsNames()
          Retrieves the names of all Connectors installed on the Server.
 Hashtable[] getInstalledFunctionComponents()
          Retrieves information for all Function Components installed on the Server.
 String[] getInstalledFunctionComponentsNames()
          Retrieves the names of all Function Components installed on the Server.
 Hashtable[] getInstalledParsers()
          Retrieves information for all Parsers installed on the Server.
 String[] getInstalledParsersNames()
          Retrieves the names of all Parsers installed on the Server.
 String getIPAddress()
          Returns Server machine IP address.
 String getOperatingSystem()
          Returns the name of the operating system where the Server is running.
 String getParserDescription(String aParserName)
          Retrieves the description of a Parser installed on the Server.
 String getParserVersionInfo(String aParserName)
          Retrieves the version of a Parser installed on the Server.
 Vector getPasswordParameterNames(String aJavaClassName)
          Returns password parameters names for specified class.
 Date getServerBootTime()
          Returns the Server boot time.
 String getServerID()
          Returns the server unique identifier.
 String getServerVersion()
          Returns Server version.
 
Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean
getId, getType
 

Method Detail

getServerVersion

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

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

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

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

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

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

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:

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

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

String getConnectorDescription(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

String getConnectorVersionInfo(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

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:

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

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

String getParserDescription(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

String getParserVersionInfo(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

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:

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

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

String getFunctionComponentDescription(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

String getFunctionComponentVersionInfo(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

Vector getPasswordParameterNames(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.