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

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.ServerInfoImpl

All Implemented Interfaces:

ServerInfo, Serializable, Remote

public class ServerInfoImpl
extends UnicastRemoteObject
implements ServerInfo

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Method Summary

static ServerInfoImpl	createInstance(ServerInfo aLocalServerInfo, SessionImpl aSession)
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.
Boolean	getEventHandlerAutoStart(String aEventHandlerName) Tells if the specified EventHandler will be automatically started when the Server is started.
String	getEventHandlerDescription(String aEventHandlerName) Retrieves the description of an EventHandler installed on the Server.
String	getEventHandlerVersionInfo(String aEventHandlerName) Retrieves the version of an EventHandler 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[]	getInstalledEventHandlers() Retrieves information for all EventHandlers installed on the Server.
String[]	getInstalledEventHandlersNames() Retrieves the names of all EventHandlers 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	getServerVersion() Returns Server version.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getServerVersion

public String getServerVersion()
                        throws DIException,
                               RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getIPAddress

public String getIPAddress()
                    throws DIException,
                           RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getHostName

public String getHostName()
                   throws DIException,
                          RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getOperatingSystem

public String getOperatingSystem()
                          throws DIException,
                                 RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getServerBootTime

public Date getServerBootTime()
                       throws DIException,
                              RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledConnectors

public Hashtable[] getInstalledConnectors()
                                   throws DIException,
                                          RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledConnectorsNames

public String[] getInstalledConnectorsNames()
                                     throws DIException,
                                            RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getConnectorDescription

public String getConnectorDescription(String aConnectorName)
                               throws DIException,
                                      RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getConnectorVersionInfo

public String getConnectorVersionInfo(String aConnectorName)
                               throws DIException,
                                      RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledEventHandlers

public Hashtable[] getInstalledEventHandlers()
                                      throws DIException,
                                             RemoteException

Description copied from interface: ServerInfo

Retrieves information for all EventHandlers installed on the Server. For each EventHandler a Hashtable object is constructed, containing the following elements:

• key "Name" - the value is the name of the EventHandler
• key "AutoStart" - the value is a Boolean that holds true if the EventHandler will be automatically started when the server is started, and false otherwise.
• key "Description" - the value is the description of the EventHandler
• key "Version" - the value is the EventHandler's version

Specified by:

getInstalledEventHandlers in interface ServerInfo

Returns:

a java.util.Hashtable array, each of its elements corresponding to a single EventHandler.

Throws:

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

RemoteException - if a communication-related exception occurs.

getInstalledEventHandlersNames

public String[] getInstalledEventHandlersNames()
                                        throws DIException,
                                               RemoteException

Description copied from interface: ServerInfo

Retrieves the names of all EventHandlers installed on the Server.

Specified by:

getInstalledEventHandlersNames in interface ServerInfo

Returns:

a String array, each of its elements specifying an EventHandler name.

Throws:

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

RemoteException - if a communication-related exception occurs.

getEventHandlerDescription

public String getEventHandlerDescription(String aEventHandlerName)
                                  throws DIException,
                                         RemoteException

Description copied from interface: ServerInfo

Retrieves the description of an EventHandler installed on the Server.

Specified by:

getEventHandlerDescription in interface ServerInfo

Parameters:

aEventHandlerName - the name of the EventHandler whose description will be retrieved.

Returns:

the description of the specified EventHandler.

Throws:

DIException - if an error occurs while obtaining EventHandler data.

RemoteException - if a communication-related exception occurs.

getEventHandlerAutoStart

public Boolean getEventHandlerAutoStart(String aEventHandlerName)
                                 throws DIException,
                                        RemoteException

Description copied from interface: ServerInfo

Tells if the specified EventHandler will be automatically started when the Server is started.

Specified by:

getEventHandlerAutoStart in interface ServerInfo

Parameters:

aEventHandlerName - the name of the EventHandler.

Returns:

a Boolean that holds true if the EventHandler will be automatically started, and false otherwise.

Throws:

DIException - if an error occurs while obtaining EventHandler data.

RemoteException - if a communication-related exception occurs.

getEventHandlerVersionInfo

public String getEventHandlerVersionInfo(String aEventHandlerName)
                                  throws DIException,
                                         RemoteException

Description copied from interface: ServerInfo

Retrieves the version of an EventHandler installed on the Server.

Specified by:

getEventHandlerVersionInfo in interface ServerInfo

Parameters:

aEventHandlerName - the name of the EventHandler whose version will be retrieved.

Returns:

the version of the specified EventHandler.

Throws:

DIException - if an error occurs while obtaining EventHandler data.

RemoteException - if a communication-related exception occurs.

getInstalledParsers

public Hashtable[] getInstalledParsers()
                                throws DIException,
                                       RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledParsersNames

public String[] getInstalledParsersNames()
                                  throws DIException,
                                         RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getParserDescription

public String getParserDescription(String aParserName)
                            throws DIException,
                                   RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getParserVersionInfo

public String getParserVersionInfo(String aParserName)
                            throws DIException,
                                   RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledFunctionComponents

public Hashtable[] getInstalledFunctionComponents()
                                           throws DIException,
                                                  RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getInstalledFunctionComponentsNames

public String[] getInstalledFunctionComponentsNames()
                                             throws DIException,
                                                    RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getFunctionComponentDescription

public String getFunctionComponentDescription(String aFunctionComponentName)
                                       throws DIException,
                                              RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

getFunctionComponentVersionInfo

public String getFunctionComponentVersionInfo(String aFunctionComponentName)
                                       throws DIException,
                                              RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.

createInstance

public static ServerInfoImpl createInstance(ServerInfo aLocalServerInfo,
                                            SessionImpl aSession)
                                     throws DIException,
                                            RemoteException

Throws:

DIException

RemoteException

getPasswordParameterNames

public Vector getPasswordParameterNames(String aJavaClassName)
                                 throws DIException,
                                        RemoteException

Description copied from interface: ServerInfo

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.

RemoteException - if a communication-related exception occurs.