- java.lang.Object
-
- javax.management.remote.rmi.RMIConnector
-
- All Implemented Interfaces:
- Closeable, Serializable, AutoCloseable, JMXAddressable, JMXConnector
public class RMIConnector extends Object implements JMXConnector, Serializable, JMXAddressable
A connection to a remote RMI connector. Usually, such connections are made using
JMXConnectorFactory
. However, specialized applications can use this class directly, for example with anRMIServer
stub obtained without going through JNDI.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface javax.management.remote.JMXConnector
CREDENTIALS
-
-
Constructor Summary
Constructors Constructor and Description RMIConnector(JMXServiceURL url, Map<String,?> environment)
Constructs anRMIConnector
that will connect the RMI connector server with the given address.RMIConnector(RMIServer rmiServer, Map<String,?> environment)
Constructs anRMIConnector
using the given RMI stub.
-
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,?> environment)
Establishes the connection to the connector server.JMXServiceURL
getAddress()
The address of this connector.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 listener, NotificationFilter filter, Object handback)
Removes a listener from the list to be informed of changes in status.String
toString()
Returns a string representation of this object.
-
-
-
Constructor Detail
-
RMIConnector
public RMIConnector(JMXServiceURL url, Map<String,?> environment)
Constructs an
RMIConnector
that will connect the RMI connector server with the given address.The address can refer directly to the connector server, using one of the following syntaxes:
service:jmx:rmi://[host[:port]]/stub/encoded-stub service:jmx:iiop://[host[:port]]/ior/encoded-IOR
(Here, the square brackets
[]
are not part of the address but indicate that the host and port are optional.)The address can instead indicate where to find an RMI stub through JNDI, using one of the following syntaxes:
service:jmx:rmi://[host[:port]]/jndi/jndi-name service:jmx:iiop://[host[:port]]/jndi/jndi-name
An implementation may also recognize additional address syntaxes, for example:
service:jmx:iiop://[host[:port]]/stub/encoded-stub
- Parameters:
url
- the address of the RMI connector server.environment
- additional attributes specifying how to make the connection. For JNDI-based addresses, these attributes can usefully include JNDI attributes recognized byInitialContext
. This parameter can be null, which is equivalent to an empty Map.- Throws:
IllegalArgumentException
- ifurl
is null.
-
RMIConnector
public RMIConnector(RMIServer rmiServer, Map<String,?> environment)
Constructs an
RMIConnector
using the given RMI stub.- Parameters:
rmiServer
- an RMI stub representing the RMI connector server.environment
- additional attributes specifying how to make the connection. This parameter can be null, which is equivalent to an empty Map.- Throws:
IllegalArgumentException
- ifrmiServer
is null.
-
-
Method Detail
-
toString
public String toString()
Returns a string representation of this object. In general, the
toString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read.
-
getAddress
public JMXServiceURL getAddress()
The address of this connector.
- Specified by:
getAddress
in interfaceJMXAddressable
- Returns:
- the address of this connector, or null if it does not have one.
- Since:
- 1.6
-
connect
public void connect() throws IOException
Description copied from interface:JMXConnector
Establishes the connection to the connector server. This method is equivalent to
connect(null)
.- Specified by:
connect
in interfaceJMXConnector
- Throws:
IOException
- if the connection could not be made because of a communication problem, or in the case of theiiop
protocol, that RMI/IIOP is not supported
-
connect
public void connect(Map<String,?> environment) throws IOException
Description copied from interface: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 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.- Specified by:
connect
in interfaceJMXConnector
- Parameters:
environment
- 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, or in the case of theiiop
protocol, that RMI/IIOP is not supported
-
getConnectionId
public String getConnectionId() throws IOException
Description copied from interface: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.
- Specified by:
getConnectionId
in interfaceJMXConnector
- 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.
-
getMBeanServerConnection
public MBeanServerConnection getMBeanServerConnection() throws IOException
Description copied from interface:JMXConnector
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.- Specified by:
getMBeanServerConnection
in interfaceJMXConnector
- 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
public MBeanServerConnection getMBeanServerConnection(Subject delegationSubject) throws IOException
Description copied from interface:JMXConnector
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.- Specified by:
getMBeanServerConnection
in interfaceJMXConnector
- 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.
-
addConnectionNotificationListener
public void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
Description copied from interface: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.- Specified by:
addConnectionNotificationListener
in interfaceJMXConnector
- 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.- See Also:
JMXConnector.removeConnectionNotificationListener(javax.management.NotificationListener)
,NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
-
removeConnectionNotificationListener
public void removeConnectionNotificationListener(NotificationListener listener) throws ListenerNotFoundException
Description copied from interface: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.
- Specified by:
removeConnectionNotificationListener
in interfaceJMXConnector
- Parameters:
listener
- a listener to receive connection status notifications.- Throws:
ListenerNotFoundException
- if the listener is not registered with thisJMXConnector
.- See Also:
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)
-
removeConnectionNotificationListener
public void removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException
Description copied from interface: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.
- Specified by:
removeConnectionNotificationListener
in interfaceJMXConnector
- Parameters:
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.- Throws:
ListenerNotFoundException
- if the listener is not registered with thisJMXConnector
, or is not registered with the given filter and handback.- See Also:
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)
-
close
public void close() throws IOException
Description copied from interface:JMXConnector
Closes the client connection to its server. Any ongoing or new request using the MBeanServerConnection returned by
JMXConnector.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 interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceJMXConnector
- 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.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
25/11/2024 05:10:13 Cette version de la page est en cache (à la date du 25/11/2024 05:10:13) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 07/12/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/management/remote/rmi/RMIConnector.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.