-
- All Superinterfaces:
- AutoCloseable, Closeable
- All Known Implementing Classes:
- RMIConnector
public interface JMXConnector extends Closeable
The client end of a JMX API connector. An object of this type can be used to establish a connection to a connector server.
A newly-created object of this type is unconnected. Its
connect
method must be called before it can be used. However, objects created byJMXConnectorFactory.connect
are already connected.- Since:
- 1.5
-
-
Field Summary
Fields Modifier and Type Field and Description static String
CREDENTIALS
Name of the attribute that specifies the credentials to send to the connector server during connection.
-
Method Summary
Methods Modifier and Type Method and Description 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<String,?> env)
Establishes the connection to the connector server.String
getConnectionId()
Gets this connection's ID from the connector server.MBeanServerConnection
getMBeanServerConnection()
Returns anMBeanServerConnection
object representing a remote MBean server.MBeanServerConnection
getMBeanServerConnection(Subject delegationSubject)
Returns anMBeanServerConnection
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 l, NotificationFilter f, Object handback)
Removes a listener from the list to be informed of changes in status.
-
-
-
Field Detail
-
CREDENTIALS
static final String CREDENTIALS
Name of the attribute that specifies the credentials to send to the connector server during connection. The value associated with this attribute, if any, is a serializable object of an appropriate type for the server's
JMXAuthenticator
.- See Also:
- Constant Field Values
-
-
Method Detail
-
connect
void connect() throws IOException
Establishes the connection to the connector server. This method is equivalent to
connect(null)
.- Throws:
IOException
- if the connection could not be made because of a communication problem.SecurityException
- if the connection could not be made for security reasons.
-
connect
void connect(Map<String,?> env) throws IOException
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,close()
was called afterconnect
, the newconnect
will throw anIOException
.Otherwise, either
connect
has never been called on this object, or it has been called but produced an exception. Then callingconnect
will attempt to establish a connection to the connector server.- Parameters:
env
- the properties of the connection. Properties in this map override properties in the map specified when theJMXConnector
was created, if any. This parameter can be null, which is equivalent to an empty map.- Throws:
IOException
- if the connection could not be made because of a communication problem.SecurityException
- if the connection could not be made for security reasons.
-
getMBeanServerConnection
MBeanServerConnection getMBeanServerConnection() throws IOException
Returns an
MBeanServerConnection
object representing a remote MBean server. For a givenJMXConnector
, two successful calls to this method will usually return the sameMBeanServerConnection
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 anException
, the sameException
is seen by the client. If the MBean server method, or the attempt to call it, produces anError
, theError
is wrapped in aJMXServerErrorException
, 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 theMBeanServerConnection
must use the authenticated subject, if any.- Returns:
- an object that implements the
MBeanServerConnection
interface by forwarding its methods to the remote MBean server. - Throws:
IOException
- if a validMBeanServerConnection
cannot be created, for instance because the connection to the remote MBean server has not yet been established (with theconnect
method), or it has been closed, or it has broken.
-
getMBeanServerConnection
MBeanServerConnection getMBeanServerConnection(Subject delegationSubject) throws IOException
Returns an
MBeanServerConnection
object representing a remote MBean server on which operations are performed on behalf of the supplied delegation subject. For a givenJMXConnector
andSubject
, two successful calls to this method will usually return the sameMBeanServerConnection
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 anException
, the sameException
is seen by the client. If the MBean server method, or the attempt to call it, produces anError
, theError
is wrapped in aJMXServerErrorException
, which is seen by the client.- Parameters:
delegationSubject
- theSubject
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.- Returns:
- an object that implements the
MBeanServerConnection
interface by forwarding its methods to the remote MBean server on behalf of a given delegation subject. - Throws:
IOException
- if a validMBeanServerConnection
cannot be created, for instance because the connection to the remote MBean server has not yet been established (with theconnect
method), or it has been closed, or it has broken.
-
close
void close() throws IOException
Closes the client connection to its server. Any ongoing or new request using the MBeanServerConnection returned by
getMBeanServerConnection()
will get anIOException
.If
close
has already been called successfully on this object, calling it again has no effect. Ifclose
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 caseclose
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.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
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.
-
addConnectionNotificationListener
void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
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.- Parameters:
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.- Throws:
NullPointerException
- iflistener
is null.- See Also:
removeConnectionNotificationListener(javax.management.NotificationListener)
,NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
-
removeConnectionNotificationListener
void removeConnectionNotificationListener(NotificationListener listener) throws ListenerNotFoundException
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.
- Parameters:
listener
- a listener to receive connection status notifications.- Throws:
NullPointerException
- iflistener
is null.ListenerNotFoundException
- if the listener is not registered with thisJMXConnector
.- See Also:
removeConnectionNotificationListener(NotificationListener, NotificationFilter, Object)
,addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
,NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
-
removeConnectionNotificationListener
void removeConnectionNotificationListener(NotificationListener l, NotificationFilter f, Object handback) throws ListenerNotFoundException
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.
- Parameters:
l
- a listener to receive connection status notifications.f
- 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.- Throws:
ListenerNotFoundException
- if the listener is not registered with thisJMXConnector
, or is not registered with the given filter and handback.- See Also:
removeConnectionNotificationListener(NotificationListener)
,addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
,NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
-
getConnectionId
String getConnectionId() throws IOException
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.
- Returns:
- the unique ID of this connection. This is the same as
the ID that the connector server includes in its
JMXConnectionNotification
s. Thepackage description
describes the conventions for connection IDs. - Throws:
IOException
- if the connection ID cannot be obtained, for instance because the connection is closed or broken.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/management/remote/JMXConnector.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.