RMIConnectorServer JDK 1.6)

Constructors

public RMIConnectorServer (JMXServiceURL url, Map<String, Object> environment) throws IOException

Makes an RMIConnectorServer.

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 {@link #start() start} method will fail.

public RMIConnectorServer (JMXServiceURL url, Map<String, Object> environment, MBeanServer mbeanServer) throws IOException

Makes an RMIConnectorServer for the given MBean server.

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 {@link #start() start} method will fail.

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

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 {@link #start() start} method will fail.
See Also: RMIConnectorServer.start(),

Methods

Hide/Show inherited methods

public void addNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) [Inherited From NotificationBroadcasterSupport]

Adds a listener.

pack-private void bind (String jndiUrl, Hashtable attributes, RMIServer rmiServer, boolean rebind) throws NamingException MalformedURLException

Bind a stub to a registry.

Bind a stub to a registry.
Parameters:
- jndiUrl - URL of the stub in the registry, extracted from the JMXServiceURL.
- attributes - A Hashtable containing environment parameters, built from the Map specified at this object creation.
- rmiServer - The object to bind in the registry
- rebind - true if the object must be rebound.

protected void connectionClosed (String connectionId, String message, Object userData) [Overrides JMXConnectorServer]

protected void connectionFailed (String connectionId, String message, Object userData) [Overrides JMXConnectorServer]

protected void connectionOpened (String connectionId, String message, Object userData) [Overrides JMXConnectorServer]

pack-privatestatic String encodeIIOPStub (RMIServer rmiServer, Map env) throws IOException

pack-privatestatic String encodeJRMPStub (RMIServer rmiServer, Map env) throws IOException

pack-privatestatic String encodeStub (RMIServer rmiServer, Map env) throws IOException

Returns the IOR of the given rmiServer.

public JMXServiceURL getAddress ()

public Map<String, Object> getAttributes ()

public String getConnectionIds () [Inherited From JMXConnectorServer]

publicsynchronized MBeanServer getMBeanServer () [Inherited From JMXConnectorServer]

Returns the MBean server that this connector server is attached to.

public MBeanNotificationInfo getNotificationInfo () [Inherited From JMXConnectorServer]

Returns an array indicating the notifications that this MBean sends.

protected void handleNotification (NotificationListener listener, Notification notif, Object handback) [Inherited From NotificationBroadcasterSupport]

This method is called by sendNotification for each listener in order to send the notification to that listener.

This method is called by sendNotification for each listener in order to send the notification to that listener. It can be overridden in subclasses to change the behavior of notification delivery, for instance to deliver the notification in a separate thread.

The default implementation of this method is equivalent to

 listener.handleNotification(notif, handback);

Parameters:
- listener - the listener to which the notification is being delivered.
- notif - the notification being delivered to the listener.
- handback - the handback object that was supplied when the listener was added.

publicsynchronized boolean isActive ()

pack-privatestatic boolean isIiopURL (JMXServiceURL directoryURL, boolean strict) throws MalformedURLException

pack-private RMIServerImpl newServer () throws IOException

Creates a new RMIServerImpl.

public void postDeregister () [Inherited From JMXConnectorServer]

public void postRegister (Boolean registrationDone) [Inherited From JMXConnectorServer]

publicsynchronized void preDeregister () throws Exception [Inherited From JMXConnectorServer]

Called by an MBean server when this connector server is unregistered from that MBean server.

publicsynchronized ObjectName preRegister (MBeanServer mbs, ObjectName name) [Inherited From JMXConnectorServer]

Called by an MBean server when this connector server is registered in that MBean server.

Called by an MBean server when this connector server is registered in that MBean server. This connector server becomes attached to the MBean server and its JMXConnectorServer.getMBeanServer() method will return mbs.

If this connector server is already attached to an MBean server, this method has no effect. The MBean server it is attached to is not necessarily the one it is being registered in.

Returns: The name under which the MBean is to be registered.
Parameters:
- mbs - the MBean server in which this connection server is being registered.
- name - The object name of the MBean.
Throws:
- NullPointerException - if mbs or name is null.

public void removeNotificationListener (NotificationListener listener) throws ListenerNotFoundException [Inherited From NotificationBroadcasterSupport]

public void removeNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException [Inherited From NotificationBroadcasterSupport]

public void sendNotification (Notification notification) [Inherited From NotificationBroadcasterSupport]

Sends a notification.

Sends a notification.

If an Executor was specified in the constructor, it will be given one
task per selected listener to deliver the notification to that listener.
Parameters:
- notification - The notification to send.

publicsynchronized void setMBeanServerForwarder (MBeanServerForwarder mbsf) [Overrides JMXConnectorServer]

publicsynchronized void start () throws IOException

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

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 RMIConnectorServer.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 () throws IOException

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

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 {@link RMIServerImpl#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, Object> env) throws IOException [Overrides JMXConnectorServer]

Returns a client stub for this connector server.

Fields

Hide/Show inherited fields

publicfinalstatic String AUTHENTICATOR = "jmx.remote.authenticator" [Inherited From JMXConnectorServer]

Name of the attribute that specifies the authenticator for a connector server.

publicfinalstatic String JNDI_REBIND_ATTRIBUTE = "jmx.remote.jndi.rebind"

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.

publicfinalstatic String RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE = "jmx.remote.rmi.client.socket.factory"

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

publicfinalstatic String RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE = "jmx.remote.rmi.server.socket.factory"

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