Home » openjdk-7 » javax » management » remote » [javadoc | source]
abstract public class: JMXConnectorServer [javadoc | source]

All Implemented Interfaces:
    JMXAddressable, MBeanRegistration, JMXConnectorServerMBean, NotificationEmitter

Direct Known Subclasses:

Superclass of every connector server. A connector server is attached to an MBean server. It listens for client connection requests and creates a connection for each one.

A connector server is associated with an MBean server either by registering it in that MBean server, or by passing the MBean server to its constructor.

A connector server is inactive when created. It only starts listening for client connections when the start method is called. A connector server stops listening for client connections when the stop method is called or when the connector server is unregistered from its MBean server.

Stopping a connector server does not unregister it from its MBean server. A connector server once stopped cannot be restarted.

Each time a client connection is made or broken, a notification of class JMXConnectionNotification is emitted.

Field Summary
public static final  String AUTHENTICATOR   

Name of the attribute that specifies the authenticator for a connector server. The value associated with this attribute, if any, must be an object that implements the interface JMXAuthenticator .

 public JMXConnectorServer() 
 public JMXConnectorServer(MBeanServer mbeanServer) 

    Constructs a connector server that is attached to the given MBean server. A connector server that is created in this way can be registered in a different MBean server, or not registered in any MBean server.

    mbeanServer - the MBean server that this connector server is attached to. Null if this connector server will be attached to an MBean server by being registered in it.
Method from javax.management.remote.JMXConnectorServer Summary:
connectionClosed,   connectionFailed,   connectionOpened,   getConnectionIds,   getMBeanServer,   getNotificationInfo,   postDeregister,   postRegister,   preDeregister,   preRegister,   setMBeanServerForwarder,   toJMXConnector
Methods from javax.management.NotificationBroadcasterSupport:
addNotificationListener,   getNotificationInfo,   handleNotification,   removeNotificationListener,   removeNotificationListener,   sendNotification
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.remote.JMXConnectorServer Detail:
 protected  void connectionClosed(String connectionId,
    String message,
    Object userData) 
 protected  void connectionFailed(String connectionId,
    String message,
    Object userData) 
 protected  void connectionOpened(String connectionId,
    String message,
    Object userData) 
 public String[] getConnectionIds() 
 public synchronized MBeanServer getMBeanServer() 

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

 public MBeanNotificationInfo[] getNotificationInfo() 

    Returns an array indicating the notifications that this MBean sends. The implementation in JMXConnectorServer returns an array with one element, indicating that it can emit notifications of class JMXConnectionNotification with the types defined in that class. A subclass that can emit other notifications should return an array that contains this element plus descriptions of the other notifications.

 public  void postDeregister() 
 public  void postRegister(Boolean registrationDone) 
 public synchronized  void preDeregister() throws Exception 

    Called by an MBean server when this connector server is unregistered from that MBean server. If this connector server was attached to that MBean server by being registered in it, and if the connector server is still active, then unregistering it will call the stop method. If the stop method throws an exception, the unregistration attempt will fail. It is recommended to call the stop method explicitly before unregistering the MBean.

 public synchronized ObjectName preRegister(MBeanServer mbs,
    ObjectName name) 

    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 #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.

 public synchronized  void setMBeanServerForwarder(MBeanServerForwarder mbsf) 
 public JMXConnector toJMXConnector(Map<String, ?> env) throws IOException 

    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.

    A given connector need not support the generation of client stubs. However, the connectors specified by the JMX Remote API do (JMXMP Connector and RMI Connector).

    The default implementation of this method uses #getAddress and JMXConnectorFactory to generate the stub, with code equivalent to the following:

    JMXServiceURL addr = getAddress() ;
    return Map)
             env) ;

    A connector server for which this is inappropriate must override this method so that it either implements the appropriate logic or throws UnsupportedOperationException .