com.ibm.di.api.remote
Interface ServerInfo

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
ServerInfoImpl

public interface ServerInfo
extends java.rmi.Remote

This interface provides various methods for getting server information.


Method Summary
 java.lang.String getConnectorDescription(java.lang.String aConnectorName)
          Retrieves the description of a Connector installed on the Server.
 java.lang.String getConnectorVersionInfo(java.lang.String aConnectorName)
          Retrieves the version of a Connector installed on the Server.
 java.lang.String getFunctionComponentDescription(java.lang.String aFunctionComponentName)
          Retrieves the description of a Function Component installed on the Server.
 java.lang.String getFunctionComponentVersionInfo(java.lang.String aFunctionComponentName)
          Retrieves the version of a Function Component installed on the Server.
 java.lang.String getHostName()
          Returns Server machine host name.
 ComponentDescriptor getInstalledComponentDescriptor(java.lang.String componentName)
          Returns the localized form information about a specific component as component descriptor object.
 java.util.Hashtable<?,?>[] getInstalledConnectors()
          Retrieves information for all Connectors installed on the Server.
 java.lang.String[] getInstalledConnectorsNames()
          Retrieves the names of all Connectors installed on the Server.
 java.util.Hashtable<?,?>[] getInstalledFunctionComponents()
          Retrieves information for all Function Components installed on the Server.
 java.lang.String[] getInstalledFunctionComponentsNames()
          Retrieves the names of all Function Components installed on the Server.
 java.util.Hashtable<?,?>[] getInstalledParsers()
          Retrieves information for all Parsers installed on the Server.
 java.lang.String[] getInstalledParsersNames()
          Retrieves the names of all Parsers installed on the Server.
 java.lang.String getIPAddress()
          Returns Server machine IP address.
 java.lang.String getOperatingSystem()
          Returns the name of the operating system where the Server is running.
 java.lang.String getParserDescription(java.lang.String aParserName)
          Retrieves the description of a Parser installed on the Server.
 java.lang.String getParserVersionInfo(java.lang.String aParserName)
          Retrieves the version of a Parser installed on the Server.
 java.util.Vector<java.lang.String> getPasswordParameterNames(java.lang.String aJavaClassName)
          Returns password parameters names for specified class.
 java.util.Date getServerBootTime()
          Returns the Server boot time.
 java.lang.String getServerID()
          Returns the server unique identifier.
 java.lang.String getServerVersion()
          Returns Server version.
 

Method Detail

getServerVersion

java.lang.String getServerVersion()
                                  throws DIException,
                                         java.rmi.RemoteException
Returns Server version.

Returns:
the version of the server.
Throws:
DIException - if an error occurs while retrieving server's data.
java.rmi.RemoteException - if a communication-related exception occurs.

getIPAddress

java.lang.String getIPAddress()
                              throws DIException,
                                     java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getHostName

java.lang.String getHostName()
                             throws DIException,
                                    java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getOperatingSystem

java.lang.String getOperatingSystem()
                                    throws DIException,
                                           java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getServerBootTime

java.util.Date getServerBootTime()
                                 throws DIException,
                                        java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getServerID

java.lang.String getServerID()
                             throws DIException,
                                    java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledConnectors

java.util.Hashtable<?,?>[] getInstalledConnectors()
                                                  throws DIException,
                                                         java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledConnectorsNames

java.lang.String[] getInstalledConnectorsNames()
                                               throws DIException,
                                                      java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getConnectorDescription

java.lang.String getConnectorDescription(java.lang.String aConnectorName)
                                         throws DIException,
                                                java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getConnectorVersionInfo

java.lang.String getConnectorVersionInfo(java.lang.String aConnectorName)
                                         throws DIException,
                                                java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledParsers

java.util.Hashtable<?,?>[] getInstalledParsers()
                                               throws DIException,
                                                      java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledParsersNames

java.lang.String[] getInstalledParsersNames()
                                            throws DIException,
                                                   java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getParserDescription

java.lang.String getParserDescription(java.lang.String aParserName)
                                      throws DIException,
                                             java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getParserVersionInfo

java.lang.String getParserVersionInfo(java.lang.String aParserName)
                                      throws DIException,
                                             java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledFunctionComponents

java.util.Hashtable<?,?>[] getInstalledFunctionComponents()
                                                          throws DIException,
                                                                 java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledFunctionComponentsNames

java.lang.String[] getInstalledFunctionComponentsNames()
                                                       throws DIException,
                                                              java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getFunctionComponentDescription

java.lang.String getFunctionComponentDescription(java.lang.String aFunctionComponentName)
                                                 throws DIException,
                                                        java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getFunctionComponentVersionInfo

java.lang.String getFunctionComponentVersionInfo(java.lang.String aFunctionComponentName)
                                                 throws DIException,
                                                        java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getPasswordParameterNames

java.util.Vector<java.lang.String> getPasswordParameterNames(java.lang.String aJavaClassName)
                                                             throws DIException,
                                                                    java.rmi.RemoteException
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.
java.rmi.RemoteException - if a communication-related exception occurs.

getInstalledComponentDescriptor

ComponentDescriptor getInstalledComponentDescriptor(java.lang.String componentName)
                                                    throws DIException,
                                                           java.rmi.RemoteException
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.