public class

RMIConnectorServer

extends JMXConnectorServer
java.lang.Object
   ↳ javax.management.NotificationBroadcasterSupport
     ↳ javax.management.remote.JMXConnectorServer
       ↳ javax.management.remote.rmi.RMIConnectorServer

Class Overview

A JMX API connector server that creates RMI-based connections from remote clients. Usually, such connector servers are made using JMXConnectorServerFactory. However, specialized applications can use this class directly, for example with an RMIServerImpl object.

Summary

Constants
String JNDI_REBIND_ATTRIBUTE

Name of the attribute that specifies whether the RMIServer stub that represents an RMI connector server should override an existing stub at the same address.
String RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE

Name of the attribute that specifies the RMIClientSocketFactory for the RMI objects created in conjunction with this connector.
String RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE

Name of the attribute that specifies the RMIServerSocketFactory for the RMI objects created in conjunction with this connector.
[Expand]
Inherited Constants
From class javax.management.remote.JMXConnectorServer
Public Constructors
RMIConnectorServer(JMXServiceURL url, Map<String, ?> environment)

Makes an RMIConnectorServer.

RMIConnectorServer(JMXServiceURL url, Map<String, ?> environment, MBeanServer mbeanServer)

Makes an RMIConnectorServer for the given MBean server.

RMIConnectorServer(JMXServiceURL url, Map<String, ?> environment, RMIServerImpl rmiServerImpl, MBeanServer mbeanServer)

Makes an RMIConnectorServer for the given MBean server.

Public Methods
JMXServiceURL getAddress()
Map<String, ?> getAttributes()
synchronized boolean isActive()
synchronized void setMBeanServerForwarder(MBeanServerForwarder mbsf)

Adds an object that intercepts requests for the MBean server that arrive through this connector server.

synchronized void start()

Activates the connector server, that is starts listening for client connections.

void stop()

Deactivates the connector server, that is, stops listening for client connections.

JMXConnector toJMXConnector(Map<String, ?> env)

Returns a client stub for this connector server.

Protected Methods
void connectionClosed(String connectionId, String message, Object userData)

Called by a subclass when a client connection is closed normally.

void connectionFailed(String connectionId, String message, Object userData)

Called by a subclass when a client connection fails.

void connectionOpened(String connectionId, String message, Object userData)

Called by a subclass when a new client connection is opened.

[Expand]
Inherited Methods
From class javax.management.remote.JMXConnectorServer
From class javax.management.NotificationBroadcasterSupport
From class java.lang.Object
From interface javax.management.MBeanRegistration
From interface javax.management.NotificationBroadcaster
From interface javax.management.NotificationEmitter
From interface javax.management.remote.JMXAddressable
From interface javax.management.remote.JMXConnectorServerMBean

Constants

public static final String JNDI_REBIND_ATTRIBUTE

Name of the attribute that specifies whether the RMIServer stub that represents an RMI connector server should override an existing stub at the same address. The value associated with this attribute, if any, should be a string that is equal, ignoring case, to "true" or "false". The default value is false.

Constant Value: "jmx.remote.jndi.rebind"

public static final String RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE

Name of the attribute that specifies the RMIClientSocketFactory for the RMI objects created in conjunction with this connector. The value associated with this attribute must be of type RMIClientSocketFactory and can only be specified in the Map argument supplied when creating a connector server.

Constant Value: "jmx.remote.rmi.client.socket.factory"

public static final String RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE

Name of the attribute that specifies the RMIServerSocketFactory for the RMI objects created in conjunction with this connector. The value associated with this attribute must be of type RMIServerSocketFactory and can only be specified in the Map argument supplied when creating a connector server.

Constant Value: "jmx.remote.rmi.server.socket.factory"

Public Constructors

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

Makes an RMIConnectorServer. This is equivalent to calling RMIConnectorServer(directoryURL,environment,null,null)

Parameters
url the URL defining how to create the connector server. Cannot be null.
environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
Throws
IllegalArgumentException if url is null.
MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.
IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.

public RMIConnectorServer (JMXServiceURL url, Map<String, ?> environment, MBeanServer mbeanServer)

Makes an RMIConnectorServer for the given MBean server. This is equivalent to calling RMIConnectorServer(directoryURL,environment,null,mbeanServer)

Parameters
url the URL defining how to create the connector server. Cannot be null.
environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
mbeanServer the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.
Throws
IllegalArgumentException if url is null.
MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.
IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.

public RMIConnectorServer (JMXServiceURL url, Map<String, ?> environment, RMIServerImpl rmiServerImpl, MBeanServer mbeanServer)

Makes an RMIConnectorServer for the given MBean server.

Parameters
url the URL defining how to create the connector server. Cannot be null.
environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
rmiServerImpl An implementation of the RMIServer interface, consistent with the protocol type specified in url. If this parameter is non null, the protocol type specified by url is not constrained, and is assumed to be valid. Otherwise, only "rmi" and "iiop" will be recognized.
mbeanServer the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.
Throws
IllegalArgumentException if url is null.
MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are recognized when rmiServerImpl is null.
IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.
See Also

Public Methods

public JMXServiceURL getAddress ()

public Map<String, ?> getAttributes ()

public synchronized boolean isActive ()

public synchronized void setMBeanServerForwarder (MBeanServerForwarder mbsf)

Adds an object that intercepts requests for the MBean server that arrive through this connector server. This object will be supplied as the MBeanServer for any new connection created by this connector server. Existing connections are unaffected.

If this connector server is already associated with an MBeanServer object, then that object is given to mbsf.setMBeanServer. If doing so produces an exception, this method throws the same exception without any other effect.

If this connector is not already associated with an MBeanServer object, or if the mbsf.setMBeanServer call just mentioned succeeds, then mbsf becomes this connector server's MBeanServer.

Parameters
mbsf the new MBeanServerForwarder.

public synchronized void start ()

Activates the connector server, that is starts listening for client connections. Calling this method when the connector server is already active has no effect. Calling this method when the connector server has been stopped will generate an IOException.

The behavior of this method when called for the first time depends on the parameters that were supplied at construction, as described below.

First, an object of a subclass of RMIServerImpl is required, to export the connector server through RMI:

  • If an RMIServerImpl was supplied to the constructor, it is used.
  • Otherwise, if the protocol part of the JMXServiceURL supplied to the constructor was iiop, an object of type RMIIIOPServerImpl is created.
  • Otherwise, if the JMXServiceURL was null, or its protocol part was rmi, an object of type RMIJRMPServerImpl is created.
  • Otherwise, the implementation can create an implementation-specific RMIServerImpl or it can throw MalformedURLException.

If the given address includes a JNDI directory URL as specified in the package documentation for javax.management.remote.rmi, then this RMIConnectorServer will bootstrap by binding the RMIServerImpl to the given address.

If the URL path part of the JMXServiceURL was empty or a single slash (/), then the RMI object will not be bound to a directory. Instead, a reference to it will be encoded in the URL path of the RMIConnectorServer address (returned by getAddress()). The encodings for rmi and iiop are described in the package documentation for javax.management.remote.rmi.

The behavior when the URL path is neither empty nor a JNDI directory URL, or when the protocol is neither rmi nor iiop, is implementation defined, and may include throwing MalformedURLException when the connector server is created or when it is started.

Throws
IllegalStateException if the connector server has not been attached to an MBean server.
IOException if the connector server cannot be started.

public void stop ()

Deactivates the connector server, that is, stops listening for client connections. Calling this method will also close all client connections that were made by this server. After this method returns, whether normally or with an exception, the connector server will not create any new client connections.

Once a connector server has been stopped, it cannot be started again.

Calling this method when the connector server has already been stopped has no effect. Calling this method when the connector server has not yet been started will disable the connector server object permanently.

If closing a client connection produces an exception, that exception is not thrown from this method. A JMXConnectionNotification is emitted from this MBean with the connection ID of the connection that could not be closed.

Closing a connector server is a potentially slow operation. For example, if a client machine with an open connection 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.

This method calls the method close on the connector server's RMIServerImpl object.

If the RMIServerImpl was bound to a JNDI directory by the start method, it is unbound from the directory by this method.

Throws
IOException if the server cannot be closed cleanly, or if the RMIServerImpl cannot be unbound from the directory. When this exception is thrown, the server has already attempted to close all client connections, if appropriate; to call close(); and to unbind the RMIServerImpl from its directory, if appropriate. All client connections are closed except possibly those that generated exceptions when the server attempted to close them.

public JMXConnector toJMXConnector (Map<String, ?> env)

Returns a client stub for this connector server. A client stub is a serializable object whose connect method can be used to make one new connection to this connector server.

Parameters
env client connection parameters of the same sort that could be provided to JMXConnector.connect(Map). Can be null, which is equivalent to an empty map.
Returns
  • a client stub that can be used to make a new connection to this connector server.
Throws
UnsupportedOperationException if this connector server does not support the generation of client stubs.
IllegalStateException if the JMXConnectorServer is not started (see isActive()).
IOException if a communications problem means that a stub cannot be created.

Protected Methods

protected void connectionClosed (String connectionId, String message, Object userData)

Called by a subclass when a client connection is closed normally. Removes connectionId from the list returned by getConnectionIds(), then emits a JMXConnectionNotification with type CLOSED.

Parameters
connectionId the ID of the closed connection.
message the message for the emitted JMXConnectionNotification. Can be null. See Notification#getMessage().
userData the userData for the emitted JMXConnectionNotification. Can be null. See Notification#getUserData().

protected void connectionFailed (String connectionId, String message, Object userData)

Called by a subclass when a client connection fails. Removes connectionId from the list returned by getConnectionIds(), then emits a JMXConnectionNotification with type FAILED.

Parameters
connectionId the ID of the failed connection.
message the message for the emitted JMXConnectionNotification. Can be null. See Notification#getMessage().
userData the userData for the emitted JMXConnectionNotification. Can be null. See Notification#getUserData().

protected void connectionOpened (String connectionId, String message, Object userData)

Called by a subclass when a new client connection is opened. Adds connectionId to the list returned by getConnectionIds(), then emits a JMXConnectionNotification with type OPENED.

Parameters
connectionId the ID of the new connection. This must be different from the ID of any connection previously opened by this connector server.
message the message for the emitted JMXConnectionNotification. Can be null. See Notification#getMessage().
userData the userData for the emitted JMXConnectionNotification. Can be null. See Notification#getUserData().