alma.acs.monitoring

Class RemoteThreadsClient

java.lang.Object

alma.acs.monitoring.RemoteThreadsClient

public class RemoteThreadsClient
extends java.lang.Object

Class used for connecting with a RemoteThreads MBean implementation. The connection can be done with a local process, as well as with a process running in a remote machine, with the RMI connector enabled on it.

For further details on the activation of the RMI connector, you can see http://java.sun.com/docs/books/tutorial/jmx/remote/jconsole.html

Since:

ACS 7.0

Author:

rtobar

Field Summary

Fields

Modifier and Type	Field and Description
static int	RMI_DEFAULT_PORT Default port used by the RMI client-side connector

Constructor Summary

Constructors

Constructor and Description
RemoteThreadsClient(java.net.InetAddress remoteHost) Gets a new RemoteThreadsClient ready to be connected to the remote JVM present in the given host address.
RemoteThreadsClient(java.net.InetAddress remoteHost, int remotePort) Gets a new RemoteThreadsClient ready to be connected to the remote JVM present in the given host address and port.
RemoteThreadsClient(int pid) Gets a new RemoteThreadsClient ready to be connected to the remote JVM indicated by the given PID
RemoteThreadsClient(java.lang.String className) Gets a new RemoteThreadsClient ready to be connected to the remote JVM indicated by the name of the launcher class (the one containing the public static void main(String[]) method).

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection with the remote MBeanServer.
boolean	connect() Connects the object instance to the remote JVM agent and gets a direct connection with the MBeanServer in order to be able to get the remote MBean.
RemoteThreadsMBean	getMBean() Returns an object representing the MBean registered on the remote JVM agent.

Methods inherited from class java.lang.Object

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

Field Detail

RMI_DEFAULT_PORT

public static final int RMI_DEFAULT_PORT

Default port used by the RMI client-side connector

See Also:

Constant Field Values

Constructor Detail

RemoteThreadsClient

public RemoteThreadsClient(java.lang.String className)
                    throws RemoteThreadsException

Gets a new RemoteThreadsClient ready to be connected to the remote JVM indicated by the name of the launcher class (the one containing the public static void main(String[]) method).

Parameters:

className - The name of the launcher class of the remote process

Throws:

RemoteThreadsException - Is thrown in the following cases:

• The given PID isn't present in the list of java processes, or it can't be retreived by the jps program.
• Cannot connect to the remote JVM or can't attach to it.
• Can't load the JMX agent on the remote JVM or can't initialize it (if it isn't already loaded).

RemoteThreadsClient

public RemoteThreadsClient(int pid)
                    throws RemoteThreadsException

Gets a new RemoteThreadsClient ready to be connected to the remote JVM indicated by the given PID

Parameters:

pid - The PID of the remote java process

Throws:

RemoteThreadsException - If:

• PID is less or equal to 0.
• Cannot connect to the remote JVM or can't attach to it.
• Can't load the JMX agent on the remote JVM or can't initialize it (if it isn't already loaded).

RemoteThreadsClient

public RemoteThreadsClient(java.net.InetAddress remoteHost)
                    throws RemoteThreadsException

Gets a new RemoteThreadsClient ready to be connected to the remote JVM present in the given host address. It uses the RMI_DEFAULT_PORT for connecting to the remote host.

Parameters:

remoteHost - The remote host where the remote JVM is placed

Throws:

RemoteThreadsException - If a malformed URL is produced with the given host address.

RemoteThreadsClient

public RemoteThreadsClient(java.net.InetAddress remoteHost,
                           int remotePort)
                    throws RemoteThreadsException

Gets a new RemoteThreadsClient ready to be connected to the remote JVM present in the given host address and port.

Parameters:

remoteHost - The remote host where the remote JVM is placed

remotePort - The port to be used for the RMI connection

Throws:

RemoteThreadsException - If a malformed URL is produced with the given host address and port.

Method Detail

connect

public boolean connect()

Connects the object instance to the remote JVM agent and gets a direct connection with the MBeanServer in order to be able to get the remote MBean.

Returns:

If the connection has been sucessful or not

close

public void close()
           throws RemoteThreadsException

Closes the connection with the remote MBeanServer.

Throws:

RemoteThreadsException - If the connection has not been opened.

getMBean

public RemoteThreadsMBean getMBean()
                            throws RemoteThreadsException

Returns an object representing the MBean registered on the remote JVM agent. If the MBean has not been registered, then it is registered and then retreived.

Returns:

A RemoteThreadsMBean object representing the MBean registered on the remote JVM agent.

Throws:

RemoteThreadsException - If:

• The MBean can't be registered on the remote JVM agent
• A local reference for this MBean can't be get