gov.va.med.vistalink.console

Class ServerHelperWebLogic

Object

ServerHelperAbstract

ServerHelperWebLogic

All Implemented Interfaces:

IServerHelper, Comparable

public final class ServerHelperWebLogic
extends ServerHelperAbstract
implements Comparable, IServerHelper

WebLogic-specific implementation of IServerHelper. Encapsulates app-server-specific mechanism for specifying server/JVM locations in domain-wide ObjectNames. Useful for app servers that support domain-wide MBean queries -- allows filtering of query based on server location, allowing queries to be targeted to a specific server location. This class is thread safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerHelperWebLogic() no-arg constructor used for local server helper only.
protected	ServerHelperWebLogic(String objectNameFragment) arg constructor may or may not be for local 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()
boolean	isLocalAndAdminServer() Special WebLogic-only function, not in interface.

Methods inherited from class ServerHelperAbstract

compareTo, equals, hashCode, keyPropertiesContainKey, keyPropertiesGetValue, toString

Methods inherited from class Object

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

Methods inherited from interface Comparable

compareTo

Constructor Detail

ServerHelperWebLogic

protected ServerHelperWebLogic()

no-arg constructor used for local server helper only.

ServerHelperWebLogic

protected ServerHelperWebLogic(String objectNameFragment)

arg constructor may or may not be for local server

Method Detail

getServerHelperConstructorProperties

public String getServerHelperConstructorProperties()

Specified by:

getServerHelperConstructorProperties in interface IServerHelper

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

getDisplayNameFullyLocationQualified

public String getDisplayNameFullyLocationQualified()

Description copied from interface: IServerHelper

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

Specified by:

getDisplayNameFullyLocationQualified in interface IServerHelper

Returns:

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

getJmxConnector

public JMXConnector getJmxConnector()
                             throws ServerHelperNotRunningException,
                                    ServerHelperException,
                                    IOException

Description copied from interface: IServerHelper

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

Specified by:

getJmxConnector in interface IServerHelper

Returns:

JSR-160 connection to server

Throws:

ServerHelperNotRunningException

ServerHelperException

IOException

isLocalAndAdminServer

public boolean isLocalAndAdminServer()
                              throws ServerHelperException

Special WebLogic-only function, not in interface. Saves some steps by checking if it's the admin server only if it already knows it's the local server (function is targeted for use *on* the admin server by admin consoles). WebLogic-specific clients can cast ServerHelper to ServerHelperWebLogic to access the function.

Returns:

true if the Server Object both a) represents both an admin server, and b) is the instantiated on the server it represents.

Throws:

ServerHelperException