org.ow2.proactive.jmx.provider.ro

Class ROConnectorServer

java.lang.Object

javax.management.NotificationBroadcasterSupport

javax.management.remote.JMXConnectorServer

org.ow2.proactive.jmx.provider.ro.ROConnectorServer

All Implemented Interfaces:

MBeanRegistration, NotificationBroadcaster, NotificationEmitter, JMXAddressable, JMXConnectorServerMBean

public final class ROConnectorServer
extends JMXConnectorServer

A JMX API connector server that creates Remote Object 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 ROServerImpl object.

Field Summary

Fields inherited from class javax.management.remote.JMXConnectorServer

AUTHENTICATOR

Constructor Summary

Constructors

Constructor and Description
ROConnectorServer(JMXServiceURL url, Map<String,?> environment) Creates a ROConnectorServer
ROConnectorServer(JMXServiceURL url, Map<String,?> environment, MBeanServer mbeanServer) Creates a ROConnectorServer
ROConnectorServer(JMXServiceURL url, Map<String,?> environment, ROServerImpl roServer, MBeanServer mbeanServer) Creates a ROConnectorServer

Method Summary

Modifier and Type	Method and Description
JMXServiceURL	getAddress() The address of this connector server.
Map<String,Object>	getAttributes() Returns the attributes of this connector.
boolean	isActive() Determines whether the connector server is active.
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.

Methods inherited from class javax.management.remote.JMXConnectorServer

connectionClosed, connectionFailed, connectionOpened, getConnectionIds, getMBeanServer, getNotificationInfo, postDeregister, postRegister, preDeregister, preRegister, setMBeanServerForwarder, toJMXConnector

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

ROConnectorServer

public ROConnectorServer(JMXServiceURL url,
                         Map<String,?> environment)
                  throws IOException

Creates a ROConnectorServer

Parameters:

url - The connector URL

environment - the connector environment, i.e., the package location of the ServerProvider

Throws:

IOException

ROConnectorServer

public ROConnectorServer(JMXServiceURL url,
                         Map<String,?> environment,
                         MBeanServer mbeanServer)
                  throws IOException

Creates a ROConnectorServer

Parameters:

url - The connector URL

environment - the connector environment, i.e., the package location of the ServerProvider

mbeanServer - the MBean server bound with the connector

Throws:

IOException

ROConnectorServer

public ROConnectorServer(JMXServiceURL url,
                         Map<String,?> environment,
                         ROServerImpl roServer,
                         MBeanServer mbeanServer)
                  throws IOException

Creates a ROConnectorServer

Parameters:

url - The connector URL

environment - the connector environment, i.e., the package location of the ServerProvider

roServer - the Remote Object JMX Server

mbeanServer - the MBean server bound with the connector

Throws:

IOException

Method Detail

start

public void start()
           throws IOException

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 ROServerImpl is required, to export the connector server through Remote Objects: If an ROServerImpl was supplied to the constructor, it is used.

Throws:

IOException

stop

public void stop()
          throws IOException

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.

Throws:

IOException

isActive

public boolean isActive()

Determines whether the connector server is active. A connector server starts being active when its start method returns successfully and remains active until either its stop method is called or the connector server fails.

getAddress

public JMXServiceURL getAddress()

The address of this connector server.

getAttributes

public Map<String,Object> getAttributes()

Returns the attributes of this connector.