com.ibm.di.api.jmx.mbeans
Class ServerInfo

java.lang.Object
  com.ibm.di.api.jmx.mbeans.BaseAdmin
      com.ibm.di.api.jmx.mbeans.ServerInfo

All Implemented Interfaces:

BaseAdminMBean, BaseMBean, ServerInfoMBean

public class ServerInfo
extends BaseAdmin
implements ServerInfoMBean

Field Summary

static String

MBEAN_TYPE

Constructor Summary

ServerInfo(ServerInfo aServerInfo)

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.
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.
String	getId() Reads attribute "Id".
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.
String	getType() Reads attribute "Type".

Methods inherited from class com.ibm.di.api.jmx.mbeans.BaseAdmin

getCurrentUserId, getKeyPropertyList

Methods inherited from class java.lang.Object

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

Field Detail

MBEAN_TYPE

public static final String MBEAN_TYPE

See Also:

Constant Field Values

Constructor Detail

ServerInfo

public ServerInfo(ServerInfo aServerInfo)

Method Detail

getType

public String getType()

Description copied from interface: BaseMBean

Reads attribute "Type".

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getType in interface BaseMBean

Returns:

the type of this MBean.

getId

public String getId()
             throws DIException

Description copied from interface: BaseMBean

Reads attribute "Id". The "Id" value should be different for different MBeans of the same type.

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getId in interface BaseMBean

Returns:

the Id of this MBean.

Throws:

DIException - if an error occurs while obtaining MBean's Id.

getServerVersion

public String getServerVersion()
                        throws DIException

Description copied from interface: ServerInfoMBean

Returns Server version.

Specified by:

getServerVersion in interface ServerInfoMBean

Returns:

the version of the server.

Throws:

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

getIPAddress

public String getIPAddress()
                    throws DIException

Description copied from interface: ServerInfoMBean

Returns Server machine IP address.

Specified by:

getIPAddress in interface ServerInfoMBean

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 String getHostName()
                   throws DIException

Description copied from interface: ServerInfoMBean

Returns Server machine host name.

Specified by:

getHostName in interface ServerInfoMBean

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 String getOperatingSystem()
                          throws DIException

Description copied from interface: ServerInfoMBean

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

Specified by:

getOperatingSystem in interface ServerInfoMBean

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 Date getServerBootTime()
                       throws DIException

Description copied from interface: ServerInfoMBean

Returns the Server boot time.

Specified by:

getServerBootTime in interface ServerInfoMBean

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.

getInstalledConnectors

public Hashtable[] getInstalledConnectors()
                                   throws DIException

Description copied from interface: ServerInfoMBean

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 ServerInfoMBean

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 String[] getInstalledConnectorsNames()
                                     throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the names of all Connectors installed on the Server.

Specified by:

getInstalledConnectorsNames in interface ServerInfoMBean

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 String getConnectorDescription(String aConnectorName)
                               throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the description of a Connector installed on the Server.

Specified by:

getConnectorDescription in interface ServerInfoMBean

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 String getConnectorVersionInfo(String aConnectorName)
                               throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the version of a Connector installed on the Server.

Specified by:

getConnectorVersionInfo in interface ServerInfoMBean

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.

getInstalledEventHandlers

public Hashtable[] getInstalledEventHandlers()
                                      throws DIException

Description copied from interface: ServerInfoMBean

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 ServerInfoMBean

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.

getInstalledEventHandlersNames

public String[] getInstalledEventHandlersNames()
                                        throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the names of all EventHandlers installed on the Server.

Specified by:

getInstalledEventHandlersNames in interface ServerInfoMBean

Returns:

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

Throws:

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

getEventHandlerDescription

public String getEventHandlerDescription(String aEventHandlerName)
                                  throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the description of an EventHandler installed on the Server.

Specified by:

getEventHandlerDescription in interface ServerInfoMBean

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.

getEventHandlerAutoStart

public Boolean getEventHandlerAutoStart(String aEventHandlerName)
                                 throws DIException

Description copied from interface: ServerInfoMBean

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

Specified by:

getEventHandlerAutoStart in interface ServerInfoMBean

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.

getEventHandlerVersionInfo

public String getEventHandlerVersionInfo(String aEventHandlerName)
                                  throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the version of an EventHandler installed on the Server.

Specified by:

getEventHandlerVersionInfo in interface ServerInfoMBean

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.

getInstalledParsers

public Hashtable[] getInstalledParsers()
                                throws DIException

Description copied from interface: ServerInfoMBean

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 ServerInfoMBean

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 String[] getInstalledParsersNames()
                                  throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the names of all Parsers installed on the Server.

Specified by:

getInstalledParsersNames in interface ServerInfoMBean

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 String getParserDescription(String aParserName)
                            throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the description of a Parser installed on the Server.

Specified by:

getParserDescription in interface ServerInfoMBean

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 String getParserVersionInfo(String aParserName)
                            throws DIException

Description copied from interface: ServerInfoMBean

Retrieves the version of a Parser installed on the Server.

Specified by:

getParserVersionInfo in interface ServerInfoMBean

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 Hashtable[] getInstalledFunctionComponents()
                                           throws DIException

Description copied from interface: ServerInfoMBean

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 ServerInfoMBean

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 String[] getInstalledFunctionComponentsNames()
                                             throws DIException

Description copied from interface: ServerInfoMBean

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

Specified by:

getInstalledFunctionComponentsNames in interface ServerInfoMBean

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 String getFunctionComponentDescription(String aFunctionComponentName)
                                       throws DIException

Description copied from interface: ServerInfoMBean

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

Specified by:

getFunctionComponentDescription in interface ServerInfoMBean

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 String getFunctionComponentVersionInfo(String aFunctionComponentName)
                                       throws DIException

Description copied from interface: ServerInfoMBean

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

Specified by:

getFunctionComponentVersionInfo in interface ServerInfoMBean

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 Vector getPasswordParameterNames(String aJavaClassName)
                                 throws DIException

Description copied from interface: ServerInfoMBean

Returns password parameters names for specified class.

Specified by:

getPasswordParameterNames in interface ServerInfoMBean

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.