|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.management.remote.generic.GenericConnector
A client connection to a remote JMX API server. This class can
use a MessageConnection
object to specify the transport for
communicating with the server.
User code does not usually instantiate this class. Instead, a
JMXConnectorProvider
should be added to the JMXConnectorFactory
so that users can implicitly instantiate the
GenericConnector (or a subclass of it) through the JMXServiceURL
provided when connecting.
The specific connector protocol to be used by an instance of
this class is specified by attributes in the Map
passed to the constructor or the connect
method. The attribute MESSAGE_CONNECTION
is the standard
way to define the transport. An implementation can recognize other
attributes to define the transport differently.
Field Summary | |
static String |
MESSAGE_CONNECTION
Name of the attribute that specifies how this connector sends messages to its connector server. |
static String |
OBJECT_WRAPPING
Name of the attribute that specifies the object wrapping for parameters whose deserialization requires special treatment. |
Fields inherited from interface javax.management.remote.JMXConnector |
CREDENTIALS |
Constructor Summary | |
GenericConnector()
Default no-arg constructor. |
|
GenericConnector(Map env)
Constructor specifying connection attributes. |
Method Summary | |
void |
addConnectionNotificationListener(NotificationListener listener,
NotificationFilter filter,
Object handback)
Adds a listener to be informed of changes in connection status. |
void |
close()
Closes the client connection to its server. |
void |
connect()
Establishes the connection to the connector server. |
void |
connect(Map env)
Establishes the connection to the connector server. |
String |
getConnectionId()
Gets this connection's ID from the connector server. |
MBeanServerConnection |
getMBeanServerConnection()
Returns an MBeanServerConnection object
representing a remote MBean server. |
MBeanServerConnection |
getMBeanServerConnection(Subject delegationSubject)
Returns an MBeanServerConnection object representing
a remote MBean server on which operations are performed on behalf of
the supplied delegation subject. |
void |
removeConnectionNotificationListener(NotificationListener listener)
Removes a listener from the list to be informed of changes in status. |
void |
removeConnectionNotificationListener(NotificationListener listener,
NotificationFilter filter,
Object handback)
Removes a listener from the list to be informed of changes in status. |
protected void |
sendNotification(Notification n)
Send a notification to the connection listeners. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String OBJECT_WRAPPING
Name of the attribute that specifies the object wrapping for
parameters whose deserialization requires special treatment.
The value associated with this attribute, if any, must be an
object that implements the interface ObjectWrapping
.
public static final String MESSAGE_CONNECTION
Name of the attribute that specifies how this connector
sends messages to its connector server. The value associated
with this attribute, if any, must be an object that implements
the interface MessageConnection
.
Constructor Detail |
public GenericConnector()
Default no-arg constructor.
public GenericConnector(Map env)
Constructor specifying connection attributes.
env
- the attributes of the connection.Method Detail |
public void connect() throws IOException
JMXConnector
Establishes the connection to the connector server. This
method is equivalent to connect(null)
.
connect
in interface JMXConnector
IOException
- if the connection could not be made
because of a communication problem.public void connect(Map env) throws IOException
JMXConnector
Establishes the connection to the connector server.
If connect
has already been called successfully
on this object, calling it again has no effect. If, however,
JMXConnector.close()
was called after connect
, the new
connect
will throw an IOException
.
Otherwise, either connect
has never been called
on this object, or it has been called but produced an
exception. Then calling connect
will attempt to
establish a connection to the connector server.
connect
in interface JMXConnector
env
- the properties of the connection. Properties in
this map override properties in the map specified when the
JMXConnector
was created, if any. This parameter
can be null, which is equivalent to an empty map.
IOException
- if the connection could not be made
because of a communication problem.public String getConnectionId() throws IOException
JMXConnector
Gets this connection's ID from the connector server. For a given connector server, every connection will have a unique id which does not change during the lifetime of the connection.
getConnectionId
in interface JMXConnector
JMXConnectionNotification
s. The package description
describes the
conventions for connection IDs.
IOException
- if the connection ID cannot be obtained,
for instance because the connection is closed or broken.public MBeanServerConnection getMBeanServerConnection() throws IOException
JMXConnector
Returns an MBeanServerConnection
object
representing a remote MBean server. For a given
JMXConnector
, two successful calls to this method
will usually return the same MBeanServerConnection
object, though this is not required.
For each method in the returned
MBeanServerConnection
, calling the method causes
the corresponding method to be called in the remote MBean
server. The value returned by the MBean server method is the
value returned to the client. If the MBean server method
produces an Exception
, the same
Exception
is seen by the client. If the MBean
server method, or the attempt to call it, produces an
Error
, the Error
is wrapped in a
JMXServerErrorException
, which is seen by the
client.
Calling this method is equivalent to calling
getMBeanServerConnection(null)
meaning that no delegation subject is specified and that all the
operations called on the MBeanServerConnection
must
use the authenticated subject, if any.
getMBeanServerConnection
in interface JMXConnector
MBeanServerConnection
interface by forwarding its
methods to the remote MBean server.
IOException
- if a valid
MBeanServerConnection
cannot be created, for
instance because the connection to the remote MBean server has
not yet been established (with the connect
method), or it has been closed, or it has broken.public MBeanServerConnection getMBeanServerConnection(Subject delegationSubject) throws IOException
JMXConnector
Returns an MBeanServerConnection
object representing
a remote MBean server on which operations are performed on behalf of
the supplied delegation subject. For a given JMXConnector
and Subject
, two successful calls to this method will
usually return the same MBeanServerConnection
object,
though this is not required.
For each method in the returned
MBeanServerConnection
, calling the method causes
the corresponding method to be called in the remote MBean
server on behalf of the given delegation subject instead of the
authenticated subject. The value returned by the MBean server
method is the value returned to the client. If the MBean server
method produces an Exception
, the same
Exception
is seen by the client. If the MBean
server method, or the attempt to call it, produces an
Error
, the Error
is wrapped in a
JMXServerErrorException
, which is seen by the
client.
getMBeanServerConnection
in interface JMXConnector
delegationSubject
- the Subject
on behalf of
which requests will be performed. Can be null, in which case
requests will be performed on behalf of the authenticated
Subject, if any.
MBeanServerConnection
interface by forwarding its methods to the remote MBean server on behalf
of a given delegation subject.
IOException
- if a valid MBeanServerConnection
cannot be created, for instance because the connection to the remote
MBean server has not yet been established (with the connect
method), or it has been closed, or it has broken.public void close() throws IOException
JMXConnector
Closes the client connection to its server. Any ongoing or new
request using the MBeanServerConnection returned by JMXConnector.getMBeanServerConnection()
will get an
IOException
.
If close
has already been called successfully
on this object, calling it again has no effect. If
close
has never been called, or if it was called
but produced an exception, an attempt will be made to close the
connection. This attempt can succeed, in which case
close
will return normally, or it can generate an
exception.
Closing a connection is a potentially slow operation. For example, if the server 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.
close
in interface JMXConnector
IOException
- if the connection cannot be closed
cleanly. If this exception is thrown, it is not known whether
the server end of the connection has been cleanly closed.public void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
JMXConnector
Adds a listener to be informed of changes in connection
status. The listener will receive notifications of type JMXConnectionNotification
. An implementation can send other
types of notifications too.
Any number of listeners can be added with this method. The
same listener can be added more than once with the same or
different values for the filter and handback. There is no
special treatment of a duplicate entry. For example, if a
listener is registered twice with no filter, then its
handleNotification
method will be called twice for
each notification.
addConnectionNotificationListener
in interface JMXConnector
listener
- a listener to receive connection status
notifications.filter
- a filter to select which notifications are to be
delivered to the listener, or null if all notifications are to
be delivered.handback
- an object to be given to the listener along
with each notification. Can be null.JMXConnector.removeConnectionNotificationListener(javax.management.NotificationListener)
,
NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
public void removeConnectionNotificationListener(NotificationListener listener) throws ListenerNotFoundException
JMXConnector
Removes a listener from the list to be informed of changes in status. The listener must previously have been added. If there is more than one matching listener, all are removed.
removeConnectionNotificationListener
in interface JMXConnector
listener
- a listener to receive connection status
notifications.
ListenerNotFoundException
- if the listener is not
registered with this JMXConnector
.JMXConnector.removeConnectionNotificationListener(NotificationListener,
NotificationFilter, Object)
,
JMXConnector.addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
,
NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
public void removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException
JMXConnector
Removes a listener from the list to be informed of changes in status. The listener must previously have been added with the same three parameters. If there is more than one matching listener, only one is removed.
removeConnectionNotificationListener
in interface JMXConnector
listener
- a listener to receive connection status notifications.filter
- a filter to select which notifications are to be
delivered to the listener. Can be null.handback
- an object to be given to the listener along
with each notification. Can be null.
ListenerNotFoundException
- if the listener is not
registered with this JMXConnector
, or is not
registered with the given filter and handback.JMXConnector.removeConnectionNotificationListener(NotificationListener)
,
JMXConnector.addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
,
NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
protected void sendNotification(Notification n)
Send a notification to the connection listeners. The
notification will be sent to every listener added with addConnectionNotificationListener
that was not subsequently
removed by a removeConnectionNotificationListener
,
provided the corresponding NotificationFilter
matches.
n
- the notification to send. This will usually be a
JMXConnectionNotification
, but an implementation can
send other notifications as well.
|
JMX Remote API Specification 1.0 Final Release Generated from RI build jmxremote-1_0_1_03-b57.1 2005.02.08_17:20:23_MET |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |