gov.va.med.vistalink.console

Interface IServerHelper

All Known Implementing Classes:

ServerHelperAbstract, ServerHelperWebLogic

public interface IServerHelper

Abstracts the concept of a J2EE "server", to support building multi-server-aware admin consoles. Hides vendor-specific implementation details. Provides information needed to identify a given server (for JMX queries, and for end-users), as well support for making JMX remoting calls to the server.

The key information used to instantiate IServerHelper objects is the vendor-specific ObjectName fragment used by the vendor to filter MBean queries to retrieve MBeans from a single server.

Method Summary

Modifier and Type	Method and Description
String	getDisplayNameFullyLocationQualified() Return a display name for the server that includes all of the location qualifiers (e.g., cell/node/server for WebSphere, server for WebLogic, etc.) in a format appropriate to display to an end-user (e.g., for a web page list of servers to select from).
JMXConnector	getJmxConnector() Return a JSR-160 compliant JMX connector to the specified server.
String	getServerHelperConstructorProperties()

Method Detail

getDisplayNameFullyLocationQualified

String getDisplayNameFullyLocationQualified()

Return a display name for the server that includes all of the location qualifiers (e.g., cell/node/server for WebSphere, server for WebLogic, etc.) in a format appropriate to display to an end-user (e.g., for a web page list of servers to select from).

Returns:

Server display name, including all qualifiers needed to describe the server location appropriately its the vendor-specific context, to an end-user

getServerHelperConstructorProperties

String getServerHelperConstructorProperties()

Returns:

the object name fragment representing the information needed for the ServerHelper object to construct itself to represent a particular server on the J2EE platform being used

getJmxConnector

JMXConnector getJmxConnector()
                      throws ServerHelperNotRunningException,
                             ServerHelperException,
                             IOException

Return a JSR-160 compliant JMX connector to the specified server. Remember to close the connector when you are done.

Returns:

JSR-160 connection to server

Throws:

gov.va.med.vistalink.console.ServerHelperNotRunningException, - gov.va.med.vistalink.console.ServerHelperException, java.io.IOException

ServerHelperNotRunningException

ServerHelperException

IOException