| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JMXConnectorServerMBean
MBean interface for connector servers. A JMX API connector server is attached to an MBean server, and establishes connections to that MBean server for remote clients.
A newly-created connector server is inactive, and does not yet listen for connections. Only when its {@link #start start} method has been called does it start listening for connections.
Method Summary | |
---|---|
JMXServiceURL |
The address of this connector server. |
Map |
The attributes for this connector server. |
String[] |
The list of IDs for currently-open connections to this connector server. |
boolean |
isActive() Determines whether the connector server is active. |
void |
Adds an object that intercepts requests for the MBean server that arrive through this connector server. |
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 env) Returns a client stub for this connector server. |
Method Detail |
---|
public JMXServiceURL getAddress()
The address of this connector server.
public Map getAttributes()
The attributes for this connector server.
public String[] getConnectionIds()
The list of IDs for currently-open connections to this connector server.
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.
public 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
{@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
.
mbsf
- the new MBeanServerForwarder
.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 {@link IOException}.
IOException
- if it is not possible to start listening
or if the connector server has been stopped.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 {@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.
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 JMXConnector toJMXConnector(Map env) throws IOException
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).
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.IOException
- if a communications problem means that a
stub cannot be created.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |