org.apache.brooklyn.feed.jmx

Class JmxHelper

java.lang.Object

org.apache.brooklyn.feed.jmx.JmxHelper

public class JmxHelper
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	CLASSES
static java.lang.String	JMX_URL_FORMAT
static java.lang.String	JMXMP_URL_FORMAT
static java.lang.String	RMI_JMX_URL_FORMAT

Constructor Summary

Constructors

Constructor and Description
JmxHelper(Entity entity)
JmxHelper(java.lang.String url)
JmxHelper(java.lang.String url, Entity entity, java.lang.String user, java.lang.String password)
JmxHelper(java.lang.String url, java.lang.String user, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
void	addNotificationListener(javax.management.ObjectName objectName, javax.management.NotificationListener listener)
void	addNotificationListener(javax.management.ObjectName objectName, javax.management.NotificationListener listener, javax.management.NotificationFilter filter)
void	addNotificationListener(java.lang.String objectName, javax.management.NotificationListener listener)
void	addNotificationListener(java.lang.String objectName, javax.management.NotificationListener listener, javax.management.NotificationFilter filter)
void	assertMBeanExistsEventually(javax.management.ObjectName objectName, Duration timeout)
void	assertMBeanExistsEventually(javax.management.ObjectName objectName, long timeoutMillis)
void	assertMBeanExistsEventually(javax.management.ObjectName objectName, long timeout, java.util.concurrent.TimeUnit timeUnit)
void	assertMBeanExistsEventually(javax.management.ObjectName objectName, groovy.time.TimeDuration timeout) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
void	connect() attempts to connect immediately
boolean	connect(long timeoutMs) Continuously attempts to connect for at least the indicated amount of time; or indefinitely if -1.
static javax.management.ObjectName	createObjectName(java.lang.String name)
void	disconnect() A thread-safe version of disconnectNow().
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(javax.management.ObjectName objectName, Duration timeout)
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(javax.management.ObjectName objectName, long timeoutMillis)
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(javax.management.ObjectName objectName, long timeout, java.util.concurrent.TimeUnit timeUnit) returns set of beans found, with retry, empty set if none after timeout
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(javax.management.ObjectName objectName, groovy.time.TimeDuration timeout) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(java.lang.String objectName, Duration timeout)
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(java.lang.String objectName, long timeout, java.util.concurrent.TimeUnit timeUnit)
java.util.Set<javax.management.ObjectInstance>	doesMBeanExistsEventually(java.lang.String objectName, groovy.time.TimeDuration timeout) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
javax.management.ObjectInstance	findMBean(javax.management.ObjectName objectName)
java.util.Set<javax.management.ObjectInstance>	findMBeans(javax.management.ObjectName objectName)
java.lang.Object	getAttribute(javax.management.ObjectName objectName, java.lang.String attribute) Returns a specific attribute for a JMX ObjectName.
java.util.Map	getConnectionEnvVars()
<M> M	getProxyObject(javax.management.ObjectName objectName, java.lang.Class<M> mbeanInterface)
<M> M	getProxyObject(java.lang.String objectName, java.lang.Class<M> mbeanInterface)
java.lang.String	getUrl()
boolean	isConnected() Checks if the JmxHelper is connected.
static javax.management.remote.JMXConnector	newConnector(javax.management.remote.JMXServiceURL url, java.util.Map<java.lang.String,?> env) Handles loading the JMXConnector in OSGi, where we need to supply the classloader.
java.lang.Object	operation(javax.management.ObjectName objectName, java.lang.String method, java.lang.Object... arguments) Executes an operation on a JMX ObjectName.
java.lang.Object	operation(java.lang.String objectName, java.lang.String method, java.lang.Object... arguments)
void	reconnect()
void	reconnectWithRetryDampened() Reconnects.
void	removeNotificationListener(javax.management.ObjectName objectName, javax.management.NotificationListener listener)
void	removeNotificationListener(javax.management.ObjectName objectName, javax.management.NotificationListener listener, javax.management.NotificationFilter filter)
void	removeNotificationListener(java.lang.String objectName, javax.management.NotificationListener listener)
void	setAttribute(javax.management.ObjectName objectName, java.lang.String attribute, java.lang.Object val)
void	setAttribute(java.lang.String objectName, java.lang.String attribute, java.lang.Object val)
void	setMinTimeBetweenReconnectAttempts(int val)
void	terminate() Disconnects, preventing subsequent connections to be made.
static java.lang.String	toJmxmpUrl(java.lang.String host, java.lang.Integer jmxmpPort) constructs a JMXMP URL for connecting to the given host and port
static java.lang.String	toJmxUrl(Entity entity) constructs a JMX URL suitable for connecting to the given entity, being smart about JMX/RMI vs JMXMP
javax.management.ObjectName	toLiteralObjectName(javax.management.ObjectName objectName) Converts from an object name pattern to a real object name, by querying with findMBean; if no matching MBean can be found (or if more than one match found) then returns null.
static java.lang.String	toRmiJmxUrl(java.lang.String host, java.lang.Integer jmxRmiServerPort, java.lang.Integer rmiRegistryPort, java.lang.String context) constructs an RMI/JMX URL with the given inputs (where the RMI Registry Port should be non-null, and at least one must be non-null)

Methods inherited from class java.lang.Object

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

Field Detail

JMX_URL_FORMAT

public static final java.lang.String JMX_URL_FORMAT

See Also:

Constant Field Values

RMI_JMX_URL_FORMAT

public static final java.lang.String RMI_JMX_URL_FORMAT

See Also:

Constant Field Values

JMXMP_URL_FORMAT

public static final java.lang.String JMXMP_URL_FORMAT

See Also:

Constant Field Values

CLASSES

public static final java.util.Map<java.lang.String,java.lang.String> CLASSES

Constructor Detail

JmxHelper

public JmxHelper(Entity entity)

JmxHelper

public JmxHelper(java.lang.String url)

JmxHelper

public JmxHelper(java.lang.String url,
                 java.lang.String user,
                 java.lang.String password)

JmxHelper

public JmxHelper(java.lang.String url,
                 Entity entity,
                 java.lang.String user,
                 java.lang.String password)

Method Detail

toJmxUrl

public static java.lang.String toJmxUrl(Entity entity)

constructs a JMX URL suitable for connecting to the given entity, being smart about JMX/RMI vs JMXMP

toRmiJmxUrl

public static java.lang.String toRmiJmxUrl(java.lang.String host,
                                           java.lang.Integer jmxRmiServerPort,
                                           java.lang.Integer rmiRegistryPort,
                                           java.lang.String context)

constructs an RMI/JMX URL with the given inputs (where the RMI Registry Port should be non-null, and at least one must be non-null)

toJmxmpUrl

public static java.lang.String toJmxmpUrl(java.lang.String host,
                                          java.lang.Integer jmxmpPort)

constructs a JMXMP URL for connecting to the given host and port

setMinTimeBetweenReconnectAttempts

public void setMinTimeBetweenReconnectAttempts(int val)

getUrl

public java.lang.String getUrl()

isConnected

public boolean isConnected()

Checks if the JmxHelper is connected. Returned value could be stale as soon as it is received. This method is thread safe.

Returns:

true if connected, false otherwise.

reconnectWithRetryDampened

public void reconnectWithRetryDampened()
                                throws java.io.IOException

Reconnects. If it already is connected, it disconnects first.

Throws:

java.io.IOException

reconnect

public void reconnect()
               throws java.io.IOException

Throws:

java.io.IOException

connect

public void connect()
             throws java.io.IOException

attempts to connect immediately

Throws:

java.io.IOException

newConnector

public static javax.management.remote.JMXConnector newConnector(javax.management.remote.JMXServiceURL url,
                                                                java.util.Map<java.lang.String,?> env)
                                                         throws java.io.IOException

Handles loading the JMXConnector in OSGi, where we need to supply the classloader.

Throws:

java.io.IOException

getConnectionEnvVars

public java.util.Map getConnectionEnvVars()

connect

public boolean connect(long timeoutMs)

Continuously attempts to connect for at least the indicated amount of time; or indefinitely if -1. This method is useful when you are not sure if the system you are trying to connect to already is up and running. This method doesn't throw an Exception, but returns true on success, false otherwise. TODO: What happens if already connected?

Parameters:

timeoutMs -

Returns:

disconnect

public void disconnect()

A thread-safe version of disconnectNow(). This method is threadsafe.

terminate

public void terminate()

Disconnects, preventing subsequent connections to be made. Method doesn't throw an exception. Can safely be called if already disconnected. This method is not threadsafe, but will thus not block if another thread is taking a long time for connections to timeout. Any concurrent requests will likely get an IOException - see http://docs.oracle.com/javase/7/docs/api/javax/management/remote/JMXConnector.html#close().

toLiteralObjectName

public javax.management.ObjectName toLiteralObjectName(javax.management.ObjectName objectName)

Converts from an object name pattern to a real object name, by querying with findMBean; if no matching MBean can be found (or if more than one match found) then returns null. If the supplied object name is not a pattern then just returns that. If the

findMBeans

public java.util.Set<javax.management.ObjectInstance> findMBeans(javax.management.ObjectName objectName)

findMBean

public javax.management.ObjectInstance findMBean(javax.management.ObjectName objectName)

doesMBeanExistsEventually

public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(javax.management.ObjectName objectName,
                                                                                Duration timeout)

doesMBeanExistsEventually

@Deprecated
public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(javax.management.ObjectName objectName,
                                                                                            groovy.time.TimeDuration timeout)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

doesMBeanExistsEventually

public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(javax.management.ObjectName objectName,
                                                                                long timeoutMillis)

doesMBeanExistsEventually

public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(java.lang.String objectName,
                                                                                Duration timeout)

doesMBeanExistsEventually

@Deprecated
public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(java.lang.String objectName,
                                                                                            groovy.time.TimeDuration timeout)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

doesMBeanExistsEventually

public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(java.lang.String objectName,
                                                                                long timeout,
                                                                                java.util.concurrent.TimeUnit timeUnit)

doesMBeanExistsEventually

public java.util.Set<javax.management.ObjectInstance> doesMBeanExistsEventually(javax.management.ObjectName objectName,
                                                                                long timeout,
                                                                                java.util.concurrent.TimeUnit timeUnit)

returns set of beans found, with retry, empty set if none after timeout

assertMBeanExistsEventually

public void assertMBeanExistsEventually(javax.management.ObjectName objectName,
                                        Duration timeout)

assertMBeanExistsEventually

@Deprecated
public void assertMBeanExistsEventually(javax.management.ObjectName objectName,
                                                    groovy.time.TimeDuration timeout)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

assertMBeanExistsEventually

public void assertMBeanExistsEventually(javax.management.ObjectName objectName,
                                        long timeoutMillis)

assertMBeanExistsEventually

public void assertMBeanExistsEventually(javax.management.ObjectName objectName,
                                        long timeout,
                                        java.util.concurrent.TimeUnit timeUnit)

getAttribute

public java.lang.Object getAttribute(javax.management.ObjectName objectName,
                                     java.lang.String attribute)

Returns a specific attribute for a JMX ObjectName.

setAttribute

public void setAttribute(java.lang.String objectName,
                         java.lang.String attribute,
                         java.lang.Object val)

setAttribute

public void setAttribute(javax.management.ObjectName objectName,
                         java.lang.String attribute,
                         java.lang.Object val)

operation

public java.lang.Object operation(java.lang.String objectName,
                                  java.lang.String method,
                                  java.lang.Object... arguments)

See Also:

#operation(ObjectName, String, Object ...)

operation

public java.lang.Object operation(javax.management.ObjectName objectName,
                                  java.lang.String method,
                                  java.lang.Object... arguments)

Executes an operation on a JMX ObjectName.

addNotificationListener

public void addNotificationListener(java.lang.String objectName,
                                    javax.management.NotificationListener listener)

addNotificationListener

public void addNotificationListener(java.lang.String objectName,
                                    javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter)

addNotificationListener

public void addNotificationListener(javax.management.ObjectName objectName,
                                    javax.management.NotificationListener listener)

addNotificationListener

public void addNotificationListener(javax.management.ObjectName objectName,
                                    javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter)

removeNotificationListener

public void removeNotificationListener(java.lang.String objectName,
                                       javax.management.NotificationListener listener)

removeNotificationListener

public void removeNotificationListener(javax.management.ObjectName objectName,
                                       javax.management.NotificationListener listener)

removeNotificationListener

public void removeNotificationListener(javax.management.ObjectName objectName,
                                       javax.management.NotificationListener listener,
                                       javax.management.NotificationFilter filter)

getProxyObject

public <M> M getProxyObject(java.lang.String objectName,
                            java.lang.Class<M> mbeanInterface)

getProxyObject

public <M> M getProxyObject(javax.management.ObjectName objectName,
                            java.lang.Class<M> mbeanInterface)

createObjectName

public static javax.management.ObjectName createObjectName(java.lang.String name)