public class

RMIConnector

extends Object
implements Serializable JMXAddressable JMXConnector
java.lang.Object
   ↳ javax.management.remote.rmi.RMIConnector

Class Overview

A connection to a remote RMI connector. Usually, such connections are made using JMXConnectorFactory. However, specialized applications can use this class directly, for example with an RMIServer stub obtained without going through JNDI.

Summary

[Expand]
Inherited Constants
From interface javax.management.remote.JMXConnector
Public Constructors
RMIConnector(JMXServiceURL url, Map<String, ?> environment)

Constructs an RMIConnector that will connect the RMI connector server with the given address.

RMIConnector(RMIServer rmiServer, Map<String, ?> environment)

Constructs an RMIConnector using the given RMI stub.

Public Methods
void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)

Adds a listener to be informed of changes in connection status.

synchronized void close()

Closes the client connection to its server.

void connect()

Establishes the connection to the connector server.

synchronized void connect(Map<String, ?> environment)

Establishes the connection to the connector server.

JMXServiceURL getAddress()

The address of this connector.

synchronized String getConnectionId()

Gets this connection's ID from the connector server.

synchronized MBeanServerConnection getMBeanServerConnection(Subject delegationSubject)

Returns an MBeanServerConnection object representing a remote MBean server on which operations are performed on behalf of the supplied delegation subject.

synchronized MBeanServerConnection getMBeanServerConnection()

Returns an MBeanServerConnection object representing a remote MBean server.

void removeConnectionNotificationListener(NotificationListener listener)

Removes a listener from the list to be informed of changes in status.

void removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)

Removes a listener from the list to be informed of changes in status.

String toString()

Returns a string representation of this object.

[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable
From interface javax.management.remote.JMXAddressable
From interface javax.management.remote.JMXConnector

Public Constructors

public RMIConnector (JMXServiceURL url, Map<String, ?> environment)

Constructs an RMIConnector that will connect the RMI connector server with the given address.

The address can refer directly to the connector server, using one of the following syntaxes:

 service:jmx:rmi://[host[:port]]/stub/encoded-stub
 service:jmx:iiop://[host[:port]]/ior/encoded-IOR

(Here, the square brackets [] are not part of the address but indicate that the host and port are optional.)

The address can instead indicate where to find an RMI stub through JNDI, using one of the following syntaxes:

 service:jmx:rmi://[host[:port]]/jndi/jndi-name
 service:jmx:iiop://[host[:port]]/jndi/jndi-name

An implementation may also recognize additional address syntaxes, for example:

 service:jmx:iiop://[host[:port]]/stub/encoded-stub

Parameters
url the address of the RMI connector server.
environment additional attributes specifying how to make the connection. For JNDI-based addresses, these attributes can usefully include JNDI attributes recognized by InitialContext. This parameter can be null, which is equivalent to an empty Map.
Throws
IllegalArgumentException if url is null.

public RMIConnector (RMIServer rmiServer, Map<String, ?> environment)

Constructs an RMIConnector using the given RMI stub.

Parameters
rmiServer an RMI stub representing the RMI connector server.
environment additional attributes specifying how to make the connection. This parameter can be null, which is equivalent to an empty Map.
Throws
IllegalArgumentException if rmiServer is null.

Public Methods

public void addConnectionNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback)

Adds a listener to be informed of changes in connection status. The listener will receive notifications of type JMXConnectionNotification. An implementation can send other types of notifications too.

Any number of listeners can be added with this method. The same listener can be added more than once with the same or different values for the filter and handback. There is no special treatment of a duplicate entry. For example, if a listener is registered twice with no filter, then its handleNotification method will be called twice for each notification.

Parameters
listener a listener to receive connection status notifications.
filter a filter to select which notifications are to be delivered to the listener, or null if all notifications are to be delivered.
handback an object to be given to the listener along with each notification. Can be null.

public synchronized void close ()

Closes the client connection to its server. Any ongoing or new request using the MBeanServerConnection returned by getMBeanServerConnection() will get an IOException.

If close has already been called successfully on this object, calling it again has no effect. If close has never been called, or if it was called but produced an exception, an attempt will be made to close the connection. This attempt can succeed, in which case close will return normally, or it can generate an exception.

Closing a connection is a potentially slow operation. For example, if the server has crashed, the close operation might have to wait for a network protocol timeout. Callers that do not want to block in a close operation should do it in a separate thread.

Throws
IOException

public void connect ()

Establishes the connection to the connector server. This method is equivalent to connect(null).

Throws
IOException

public synchronized void connect (Map<String, ?> environment)

Establishes the connection to the connector server.

If connect has already been called successfully on this object, calling it again has no effect. If, however, close() was called after connect, the new connect will throw an IOException.

Otherwise, either connect has never been called on this object, or it has been called but produced an exception. Then calling connect will attempt to establish a connection to the connector server.

Parameters
environment the properties of the connection. Properties in this map override properties in the map specified when the JMXConnector was created, if any. This parameter can be null, which is equivalent to an empty map.
Throws
IOException

public JMXServiceURL getAddress ()

The address of this connector.

Returns
  • the address of this connector, or null if it does not have one.

public synchronized String getConnectionId ()

Gets this connection's ID from the connector server. For a given connector server, every connection will have a unique id which does not change during the lifetime of the connection.

Returns
Throws
IOException

public synchronized MBeanServerConnection getMBeanServerConnection (Subject delegationSubject)

Returns an MBeanServerConnection object representing a remote MBean server on which operations are performed on behalf of the supplied delegation subject. For a given JMXConnector and Subject, two successful calls to this method will usually return the same MBeanServerConnection object, though this is not required.

For each method in the returned MBeanServerConnection, calling the method causes the corresponding method to be called in the remote MBean server on behalf of the given delegation subject instead of the authenticated subject. The value returned by the MBean server method is the value returned to the client. If the MBean server method produces an Exception, the same Exception is seen by the client. If the MBean server method, or the attempt to call it, produces an Error, the Error is wrapped in a JMXServerErrorException, which is seen by the client.

Parameters
delegationSubject the Subject on behalf of which requests will be performed. Can be null, in which case requests will be performed on behalf of the authenticated Subject, if any.
Returns
  • an object that implements the MBeanServerConnection interface by forwarding its methods to the remote MBean server on behalf of a given delegation subject.
Throws
IOException

public synchronized MBeanServerConnection getMBeanServerConnection ()

Returns an MBeanServerConnection object representing a remote MBean server. For a given JMXConnector, two successful calls to this method will usually return the same MBeanServerConnection object, though this is not required.

For each method in the returned MBeanServerConnection, calling the method causes the corresponding method to be called in the remote MBean server. The value returned by the MBean server method is the value returned to the client. If the MBean server method produces an Exception, the same Exception is seen by the client. If the MBean server method, or the attempt to call it, produces an Error, the Error is wrapped in a JMXServerErrorException, which is seen by the client.

Calling this method is equivalent to calling getMBeanServerConnection(null) meaning that no delegation subject is specified and that all the operations called on the MBeanServerConnection must use the authenticated subject, if any.

Returns
  • an object that implements the MBeanServerConnection interface by forwarding its methods to the remote MBean server.
Throws
IOException

public void removeConnectionNotificationListener (NotificationListener listener)

Removes a listener from the list to be informed of changes in status. The listener must previously have been added. If there is more than one matching listener, all are removed.

Parameters
listener a listener to receive connection status notifications.
Throws
ListenerNotFoundException

public void removeConnectionNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback)

Removes a listener from the list to be informed of changes in status. The listener must previously have been added with the same three parameters. If there is more than one matching listener, only one is removed.

Parameters
listener a listener to receive connection status notifications.
filter a filter to select which notifications are to be delivered to the listener. Can be null.
handback an object to be given to the listener along with each notification. Can be null.
Throws
ListenerNotFoundException

public String toString ()

Returns a string representation of this object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read.

Returns
  • a String representation of this object.