org.ow2.proactive.jmx

Class JMXClientHelper

java.lang.Object

org.ow2.proactive.jmx.JMXClientHelper

public final class JMXClientHelper
extends Object

This helper class provides a way to establish a JMX connection over RMI. If it fails this helper will try over RO (Remote Object). It can be reused if each open connection is closed with disconnect() method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PA_JMX_CLIENT_PROTOCOL The name of the java property that defines the JMXTransportProtocol used by JMX client

Constructor Summary

Constructors

Constructor and Description
JMXClientHelper(Authentication auth, Map<String,Object> env) Creates a new instance of this helper.
JMXClientHelper(Authentication auth, Object[] creds) Creates a new instance of this helper and puts the credentials in the environment used by the JMXConnector.

Method Summary

Modifier and Type	Method and Description
boolean	connect() Establishes the connection to the connector server by calling connect(JMXTransportProtocol) using the JMXTransportProtocol specified by the PA_JMX_CLIENT_PROTOCOL property that can be JMXTransportProtocol.RMI or JMXTransportProtocol.RO.
boolean	connect(JMXTransportProtocol protocol) Establishes the connection to the connector server.
void	disconnect() Disconnects the connector of this helper.
JMXConnector	getConnector() Returns the connected JMXConnector.
Exception	getLastException() Returns the last happened exception.
boolean	isConnected() Returns true if this client is connected.
static JMXConnector	tryJMXoverRMI(Authentication auth, Map<String,Object> env) Tries to create a a JMXConnector over RMI, with a fall back solution over RO.
static JMXConnector	tryJMXoverRO(Authentication auth, Map<String,Object> env) Tries to create a a JMXConnector over RO.

Methods inherited from class java.lang.Object

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

Field Detail

PA_JMX_CLIENT_PROTOCOL

public static final String PA_JMX_CLIENT_PROTOCOL

The name of the java property that defines the JMXTransportProtocol used by JMX client

See Also:

Constant Field Values

Constructor Detail

JMXClientHelper

public JMXClientHelper(Authentication auth,
                       Object[] creds)

Creates a new instance of this helper and puts the credentials in the environment used by the JMXConnector.

Parameters:

auth - the authentication interface

creds - the array that contains credentials

JMXClientHelper

public JMXClientHelper(Authentication auth,
                       Map<String,Object> env)

Creates a new instance of this helper.

Parameters:

auth - the authentication interface

env - the environment used by the JMXConnector

Method Detail

connect

public boolean connect()

Establishes the connection to the connector server by calling connect(JMXTransportProtocol) using the JMXTransportProtocol specified by the PA_JMX_CLIENT_PROTOCOL property that can be JMXTransportProtocol.RMI or JMXTransportProtocol.RO. If the property is not defined the JMXTransportProtocol.RMI protocol is used.

Returns:

true if this helper is connected otherwise return false

connect

public boolean connect(JMXTransportProtocol protocol)

Establishes the connection to the connector server. Handles exception and returns boolean value if success or not.

Parameters:

protocol - the JMXTransportProtocol

Returns:

true if this helper is connected and false otherwise

isConnected

public boolean isConnected()

Returns true if this client is connected.

Returns:

true if this client helper is connected otherwise return false

disconnect

public void disconnect()

Disconnects the connector of this helper.

getConnector

public JMXConnector getConnector()

Returns the connected JMXConnector.

Returns:

the connected connector (may be null)

getLastException

public Exception getLastException()

Returns the last happened exception.

Returns:

the last exception occurred during precedent operation

tryJMXoverRMI

public static JMXConnector tryJMXoverRMI(Authentication auth,
                                         Map<String,Object> env)

Tries to create a a JMXConnector over RMI, with a fall back solution over RO.

Parameters:

auth - the authentication interface

env - the environment that may contains credentials

Returns:

a new connected JMXConnector

tryJMXoverRO

public static JMXConnector tryJMXoverRO(Authentication auth,
                                        Map<String,Object> env)

Tries to create a a JMXConnector over RO. Throws a RuntimeException in case of failure.

Parameters:

auth - the authentication interface

env - the environment that may contains credentials

Returns:

a new connected JMXConnector