org.rvpf.jmx

Class AgentSessionProxy

Object

SessionProxy

AgentSessionProxy

All Implemented Interfaces:

Remote, Session

public final class AgentSessionProxy
extends SessionProxy

Agent session proxy.

Wraps the access to a remote MBeanServer thru an AgentSession.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentSessionProxy.Builder Builder.

Nested classes/interfaces inherited from class SessionProxy

SessionProxy.Listener, SessionProxy.SessionConnectVetoException

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Method Summary

Modifier and Type	Method and Description
void	closeConnection() Closes the MBean server connection.
protected Session	createSession() Creates a session.
void	disconnect() Disconnects from the session.
MBeanServerConnection	getConnection() Gets the MBean server connection.
<T> T	getMBeanProxy(Class<T> objectClass) Gets a proxy to the MBean.
<T> T	getMBeanProxy(ObjectName objectName, Class<T> objectClass, boolean notificationBroadcaster) Gets a proxy to a MBean.
String	getObjectClassName(ObjectName objectName) Gets an object class name.
ObjectName	getObjectName() Gets the object name.
ObjectName[]	getObjectNames() Gets the object names.
static AgentSessionProxy.Builder	newBuilder() Returns a new builder.

Methods inherited from class SessionProxy

connect, getClientName, getConnectionMode, getContext, getContextUUID, getFactory, getServerName, getServerURI, getSession, getThisLogger, hasLoginInfo, isConnected, isPrivate, isRemote, lockConnect, lockConnectInterruptibly, login, logout, sessionException, sessionMode, tearDown, unlockConnect

Methods inherited from class Object

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

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static AgentSessionProxy.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

closeConnection

public void closeConnection()

Closes the MBean server connection.

disconnect

public void disconnect()

Disconnects from the session.

This method may be called redundantly.

Overrides:

disconnect in class SessionProxy

getConnection

@Nonnull
 @CheckReturnValue
public MBeanServerConnection getConnection()
                                                                  throws SessionException

Gets the MBean server connection.

Returns:

The MBean server connection.

Throws:

SessionException - When a connection is not available.

getMBeanProxy

@Nonnull
 @CheckReturnValue
public <T> T getMBeanProxy(@Nonnull
                                                         Class<T> objectClass)
                                                  throws SessionException

Gets a proxy to the MBean.

Type Parameters:

T - The type of the returned value.

Parameters:

objectClass - The MBean class.

Returns:

A proxy to the MBean.

Throws:

SessionException - When a connection is not available.

getMBeanProxy

@Nonnull
 @CheckReturnValue
public <T> T getMBeanProxy(@Nonnull
                                                         ObjectName objectName,
                                                         @Nonnull
                                                         Class<T> objectClass,
                                                         boolean notificationBroadcaster)
                                                  throws SessionException

Gets a proxy to a MBean.

Type Parameters:

T - The type of the returned value.

Parameters:

objectName - The object name.

objectClass - The MBean class.

notificationBroadcaster - Requests notification emission support.

Returns:

A proxy to the MBean.

Throws:

SessionException - When a connection is not available.

getObjectClassName

@Nonnull
 @CheckReturnValue
public String getObjectClassName(@Nonnull
                                                               ObjectName objectName)
                                                        throws SessionException

Gets an object class name.

Parameters:

objectName - The object name.

Returns:

The object class name.

Throws:

SessionException - On session exception.

getObjectName

@Nonnull
 @CheckReturnValue
public ObjectName getObjectName()

Gets the object name.

Returns:

The object name.

getObjectNames

@Nonnull
 @CheckReturnValue
public ObjectName[] getObjectNames()
                                                          throws SessionException

Gets the object names.

Returns:

The object names.

Throws:

SessionException - When a connection is not available.

createSession

protected Session createSession()
                         throws RemoteException,
                                SessionException

Creates a session.

Specified by:

createSession in class SessionProxy

Returns:

The session.

Throws:

RemoteException - From RMI.

SessionException - When session creation fails.