gov.va.med.vistalink.console

Class ServerHelperFactory

Object

ServerHelperFactory

public class ServerHelperFactory
extends Object

Constructs IServerHelper objects representing particular J2EE servers.

Method Summary

Modifier and Type	Method and Description
static IServerHelper	getLocalServerHelper() Returns an IServerHelper object representing the current JVM (local) J2EE server.
static IServerHelper	getServerHelper(String platformSpecificServerIdentifier) Returns an IServerHelper object representing the specified J2EE server.

Methods inherited from class Object

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

Method Detail

getServerHelper

public static IServerHelper getServerHelper(String platformSpecificServerIdentifier)

Returns an IServerHelper object representing the specified J2EE server. The key information used to instantiate an IServerHelper object for specific server is the vendor-specific ObjectName fragment used by the vendor to filter MBean queries to retrieve MBeans from that single server.

Typically you would obtain this information for a given server you want to perform MBean operations on, by

1. Use the IJmxHelper getSortedDomainServers method to return a complete set of IServerHelpers for each server in the domain.
2. Prompt the user to select a single server from the set of servers (for example in a web page UI). The web page UI would include, as a state key between requests, the object name fragment from each IServerHelpers' getServerObjectNamePropertiesForMBeanServer() method, e.g., submitted as a form parameter.
3. When the user has selected a server, re-instantiate an IServerHelper object for the selected server by using the state key saved between requests.
4. Use other methods on the selected IServerHelper as necessary to perform MBean operations on the selected server.

Parameters:

platformSpecificServerIdentifier - Implementation-specific location identifier (an ObjectName fragment) identifying the server to get a helper for.

Returns:

IServerHelper object for the identified server.

getLocalServerHelper

public static IServerHelper getLocalServerHelper()

Returns an IServerHelper object representing the current JVM (local) J2EE server.

Returns:

IServerHelper object representing local server.