com.ibm.di.api.local.impl
Class ServerInfoImpl

java.lang.Object
  com.ibm.di.api.local.impl.ServerInfoImpl

All Implemented Interfaces:

ServerInfo

public class ServerInfoImpl
extends java.lang.Object
implements ServerInfo

This class implements various methods for getting server information.

Constructor Summary

ServerInfoImpl(SessionImpl aSession)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerInfoImpl

public ServerInfoImpl(SessionImpl aSession)

Parameters:

aSession -

Method Detail

getServerVersion

public java.lang.String getServerVersion()
                                  throws DIException

Returns Server version.

Specified by:

getServerVersion in interface ServerInfo

Returns:

the version of the server.

Throws:

DIException - if an error occurs while retrieving server's data.

getIPAddress

public java.lang.String getIPAddress()
                              throws DIException

Returns Server machine IP address.

Specified by:

getIPAddress in interface ServerInfo

Returns:

the IP address of the machine where the server is running.

Throws:

DIException - if an error occurs while retrieving server's data.

getHostName

public java.lang.String getHostName()
                             throws DIException

Returns Server machine host name.

Specified by:

getHostName in interface ServerInfo

Returns:

the host name of the machine where the server is running.

Throws:

DIException - if an error occurs while retrieving server's data.

getOperatingSystem

public java.lang.String getOperatingSystem()
                                    throws DIException

Returns the name of the operating system where the Server is running.

Specified by:

getOperatingSystem in interface ServerInfo

Returns:

the operating system of the machine where the server is running.

Throws:

DIException - if an error occurs while retrieving server's data.

getServerBootTime

public java.util.Date getServerBootTime()
                                 throws DIException

Returns the Server boot time.

Specified by:

getServerBootTime in interface ServerInfo

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

public java.lang.String getServerID()

Returns the server unique identifier.

Specified by:

getServerID in interface ServerInfo

Returns:

String - the value of the property com.ibm.di.server.id

getInstalledConnectors

public 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

Specified by:

getInstalledConnectors in interface ServerInfo

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

public java.lang.String[] getInstalledConnectorsNames()
                                               throws DIException

Retrieves the names of all Connectors installed on the Server.

Specified by:

getInstalledConnectorsNames in interface ServerInfo

Returns:

a String array, each of its elements specifying a Connector name.

Throws:

DIException - if an error occurs while obtaining installed Connectors' data.

getConnectorDescription

public java.lang.String getConnectorDescription(java.lang.String aConnectorName)
                                         throws DIException

Retrieves the description of a Connector installed on the Server.

Specified by:

getConnectorDescription in interface ServerInfo

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

public java.lang.String getConnectorVersionInfo(java.lang.String aConnectorName)
                                         throws DIException

Retrieves the version of a Connector installed on the Server.

Specified by:

getConnectorVersionInfo in interface ServerInfo

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

public 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

Specified by:

getInstalledParsers in interface ServerInfo

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

public java.lang.String[] getInstalledParsersNames()
                                            throws DIException

Retrieves the names of all Parsers installed on the Server.

Specified by:

getInstalledParsersNames in interface ServerInfo

Returns:

a String array, each of its elements specifying a Parser name.

Throws:

DIException - if an error occurs while obtaining installed Parsers' data.

getParserDescription

public java.lang.String getParserDescription(java.lang.String aParserName)
                                      throws DIException

Retrieves the description of a Parser installed on the Server.

Specified by:

getParserDescription in interface ServerInfo

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

public java.lang.String getParserVersionInfo(java.lang.String aParserName)
                                      throws DIException

Retrieves the version of a Parser installed on the Server.

Specified by:

getParserVersionInfo in interface ServerInfo

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

public 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

Specified by:

getInstalledFunctionComponents in interface ServerInfo

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

public java.lang.String[] getInstalledFunctionComponentsNames()
                                                       throws DIException

Retrieves the names of all Function Components installed on the Server.

Specified by:

getInstalledFunctionComponentsNames in interface ServerInfo

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

public java.lang.String getFunctionComponentDescription(java.lang.String aFunctionComponentName)
                                                 throws DIException

Retrieves the description of a Function Component installed on the Server.

Specified by:

getFunctionComponentDescription in interface ServerInfo

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

public java.lang.String getFunctionComponentVersionInfo(java.lang.String aFunctionComponentName)
                                                 throws DIException

Retrieves the version of a Function Component installed on the Server.

Specified by:

getFunctionComponentVersionInfo in interface ServerInfo

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

public java.util.Vector<java.lang.String> getPasswordParameterNames(java.lang.String aJavaClassName)
                                                             throws DIException

Returns password parameters names for specified class.

Specified by:

getPasswordParameterNames in interface ServerInfo

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

public 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.

Specified by:

getInstalledComponentDescriptor in interface ServerInfo

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.