File	Doc	Category	Size	Date	Package
JMXConnectorServerMBean.java	API Doc	Java SE 5 API	7091	Fri Aug 26 14:57:38 BST 2005	javax.management.remote

JMXConnectorServerMBean

Fields Summary

Constructors Summary

Methods Summary
public javax.management.remote.JMXServiceURL	getAddress() The address of this connector server. return the address of this connector server, or null if it does not have one.
public java.util.Map	getAttributes() The attributes for this connector server. return a read-only map containing the attributes for this connector server. Attributes whose values are not serializable are omitted from this map. If there are no serializable attributes, the returned map is empty.
public java.lang.String[]	getConnectionIds() The list of IDs for currently-open connections to this connector server. return a new string array containing the list of IDs. If there are no currently-open connections, this array will be empty.
public boolean	isActive() Determines whether the connector server is active. A connector server starts being active when its {@link #start start} method returns successfully and remains active until either its {@link #stop stop} method is called or the connector server fails. return true if the connector server is active.
public void	setMBeanServerForwarder(javax.management.remote.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 {@link MBeanServerForwarder#setMBeanServer 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. param mbsf the new MBeanServerForwarder. exception IllegalArgumentException if the call to {@link MBeanServerForwarder#setMBeanServer mbsf.setMBeanServer} fails with IllegalArgumentException. This includes the case where mbsf is null.
public 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 {@link IOException}. exception IOException if it is not possible to start listening or if the connector server has been stopped. exception IllegalStateException if the connector server has not been attached to an MBean server.
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 {@link JMXConnectionNotification} with type {@link JMXConnectionNotification#FAILED} 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. exception IOException if the server cannot be closed cleanly. When this exception is thrown, the server has already attempted to close all client connections. All client connections are closed except possibly those that generated exceptions when the server attempted to close them.
public javax.management.remote.JMXConnector	toJMXConnector(java.util.Map env) Returns a client stub for this connector server. A client stub is a serializable object whose {@link JMXConnector#connect(Map) 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). param env client connection parameters of the same sort that can be provided to {@link JMXConnector#connect(Map) JMXConnector.connect(Map)}. Can be null, which is equivalent to an empty map. return a client stub that can be used to make a new connection to this connector server. exception UnsupportedOperationException if this connector server does not support the generation of client stubs. exception IllegalStateException if the JMXConnectorServer is not started (see {@link JMXConnectorServerMBean#isActive()}). exception IOException if a communications problem means that a stub cannot be created.