javax.management.remote.rmi.RMIConnection |
![]() |
RMI object used to forward an MBeanServer request from a client to its MBeanServer implementation on the server side. There is one Remote object implementing this interface for each remote client connected to an RMI connector.
User code does not usually refer to this interface. It is specified as part of the public API so that different implementations of that API will interoperate.
To ensure that client parameters will be deserialized at the
server side with the correct classloader, client parameters such as
parameters used to invoke a method are wrapped in a MarshalledObject
. An implementation of this interface must first
get the appropriate class loader for the operation and its target,
then deserialize the marshalled parameters with this classloader.
Except as noted, a parameter that is a
MarshalledObject
or MarshalledObject[]
must not be null; the behavior is unspecified if it is.
Class loading aspects are detailed in the JMX Specification, version 1.4 PDF document.
Most methods in this interface parallel methods in the MBeanServerConnection
interface. Where an aspect of the behavior
of a method is not specified here, it is the same as in the
corresponding MBeanServerConnection
method.
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Handles the method addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
. The
NotificationFilter
parameter is wrapped in a
MarshalledObject
. The Object
(handback) parameter is also wrapped in a
MarshalledObject
.
name | The name of the MBean on which the listener should be added. |
---|---|
listener | The object name of the listener which will handle the notifications emitted by the registered MBean. |
filter | The filter object, encapsulated into a
MarshalledObject . If filter encapsulated in the
MarshalledObject has a null value, no filtering
will be performed before handling notifications. |
handback | The context to be sent to the listener when a
notification is emitted, encapsulated into a
MarshalledObject . |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans. |
---|---|
Wraps an IllegalArgumentException . The MBean named by
listener exists but does not implement the
NotificationListener interface,
or name or listener is null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
.
Register for notifications from the given MBeans that match
the given filters. The remote client can subsequently retrieve
the notifications using the fetchNotifications
method.
For each listener, the original
NotificationListener
and handback
are
kept on the client side; in order for the client to be able to
identify them, the server generates and returns a unique
listenerID
. This listenerID
is
forwarded with the Notifications
to the remote
client.
If any one of the given (name, filter) pairs cannot be registered, then the operation fails with an exception, and no names or filters are registered.
names | the ObjectNames identifying the
MBeans emitting the Notifications. |
---|---|
filters | an array of marshalled representations of the
NotificationFilters . Elements of this array can
be null. |
delegationSubjects | the Subjects on behalf
of which the listeners are being added. Elements of this array
can be null. Also, the delegationSubjects
parameter itself can be null, which is equivalent to an array
of null values with the same size as the names and
filters arrays. |
listenerIDs
identifying the
local listeners. This array has the same number of elements as
the parameters.IllegalArgumentException | if names or
filters is null, or if names contains
a null element, or if the three arrays do not all have the same
size. |
---|---|
ClassCastException | if one of the elements of
filters unmarshalls as a non-null object that is
not a NotificationFilter . |
InstanceNotFoundException | if one of the
names does not correspond to any registered MBean. |
SecurityException | if, for one of the MBeans, the client, or the delegated Subject if any, does not have permission to add a listener. |
IOException | if a general communication exception occurred. |
Closes this connection. On return from this method, the RMI object implementing this interface is unexported, so further remote calls to it will fail.
IOException | if the connection could not be closed, or the Remote object could not be unexported, or there was a communication failure when transmitting the remote close request. |
---|
Handles the method createMBean(String, ObjectName)
.
className | The class name of the MBean to be instantiated. |
---|---|
name | The object name of the MBean. May be null. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.ReflectionException | Wraps a
java.lang.ClassNotFoundException or a
java.lang.Exception that occurred
when trying to invoke the MBean's constructor. |
---|---|
InstanceAlreadyExistsException | The MBean is already under the control of the MBean server. |
MBeanRegistrationException | The
preRegister (MBeanRegistration
interface) method of the MBean has thrown an exception. The
MBean will not be registered. |
MBeanException | The constructor of the MBean has thrown an exception. |
NotCompliantMBeanException | This class is not a JMX compliant MBean. |
Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null, the ObjectName passed
in parameter contains a pattern or no ObjectName
is specified for the MBean. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method createMBean(String, ObjectName, ObjectName, Object[], String[])
. The
Object[]
parameter is wrapped in a
MarshalledObject
.
className | The class name of the MBean to be instantiated. |
---|---|
name | The object name of the MBean. May be null. |
loaderName | The object name of the class loader to be used. |
params | An array containing the parameters of the
constructor to be invoked, encapsulated into a
MarshalledObject . The encapsulated array can be
null, equivalent to an empty array. |
signature | An array containing the signature of the constructor to be invoked. Can be null, equivalent to an empty array. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.ReflectionException | Wraps a
java.lang.ClassNotFoundException or a
java.lang.Exception that occurred when trying to
invoke the MBean's constructor. |
---|---|
InstanceAlreadyExistsException | The MBean is already under the control of the MBean server. |
MBeanRegistrationException | The
preRegister (MBeanRegistration
interface) method of the MBean has thrown an exception. The
MBean will not be registered. |
MBeanException | The constructor of the MBean has thrown an exception. |
NotCompliantMBeanException | This class is not a JMX compliant MBean. |
InstanceNotFoundException | The specified class loader is not registered in the MBean server. |
Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null, the ObjectName passed
in parameter contains a pattern, or no ObjectName
is specified for the MBean. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method createMBean(String, ObjectName, ObjectName)
.
className | The class name of the MBean to be instantiated. |
---|---|
name | The object name of the MBean. May be null. |
loaderName | The object name of the class loader to be used. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.ReflectionException | Wraps a
java.lang.ClassNotFoundException or a
java.lang.Exception that occurred when trying to
invoke the MBean's constructor. |
---|---|
InstanceAlreadyExistsException | The MBean is already under the control of the MBean server. |
MBeanRegistrationException | The
preRegister (MBeanRegistration
interface) method of the MBean has thrown an exception. The
MBean will not be registered. |
MBeanException | The constructor of the MBean has thrown an exception. |
NotCompliantMBeanException | This class is not a JMX compliant MBean. |
InstanceNotFoundException | The specified class loader is not registered in the MBean server. |
Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null, the ObjectName passed
in parameter contains a pattern or no ObjectName
is specified for the MBean. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method createMBean(String, ObjectName, Object[], String[])
. The Object[]
parameter is wrapped in a MarshalledObject
.
className | The class name of the MBean to be instantiated. |
---|---|
name | The object name of the MBean. May be null. |
params | An array containing the parameters of the
constructor to be invoked, encapsulated into a
MarshalledObject . The encapsulated array can be
null, equivalent to an empty array. |
signature | An array containing the signature of the constructor to be invoked. Can be null, equivalent to an empty array. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.ReflectionException | Wraps a
java.lang.ClassNotFoundException or a
java.lang.Exception that occurred when trying to
invoke the MBean's constructor. |
---|---|
InstanceAlreadyExistsException | The MBean is already under the control of the MBean server. |
MBeanRegistrationException | The
preRegister (MBeanRegistration
interface) method of the MBean has thrown an exception. The
MBean will not be registered. |
MBeanException | The constructor of the MBean has thrown an exception. |
NotCompliantMBeanException | This class is not a JMX compliant MBean. |
Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null, the ObjectName passed
in parameter contains a pattern, or no ObjectName
is specified for the MBean. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Retrieves notifications from the connector server. This method can block until there is at least one notification or until the specified timeout is reached. The method can also return at any time with zero notifications.
A notification can be included in the result if its sequence
number is no less than clientSequenceNumber
and
this client has registered at least one listener for the MBean
generating the notification, with a filter that accepts the
notification. Each listener that is interested in the
notification is identified by an Integer ID that was returned
by addNotificationListeners(ObjectName[], MarshalledObject[], Subject[])
.
clientSequenceNumber | the first sequence number that the client is interested in. If negative, it is interpreted as meaning the sequence number that the next notification will have. |
---|---|
maxNotifications | the maximum number of different
notifications to return. The TargetedNotification
array in the returned NotificationResult can have
more elements than this if the same notification appears more
than once. The behavior is unspecified if this parameter is
negative. |
timeout | the maximum time in milliseconds to wait for a
notification to arrive. This can be 0 to indicate that the
method should not wait if there are no notifications, but
should return at once. It can be Long.MAX_VALUE
to indicate that there is no timeout. The behavior is
unspecified if this parameter is negative. |
NotificationResult
.IOException | if a general communication exception occurred. |
---|
Handles the method getAttribute(ObjectName, String)
.
name | The object name of the MBean from which the attribute is to be retrieved. |
---|---|
attribute | A String specifying the name of the attribute to be retrieved. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
AttributeNotFoundException | The attribute specified is not accessible in the MBean. |
---|---|
MBeanException | Wraps an exception thrown by the MBean's getter. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
ReflectionException | Wraps a
java.lang.Exception thrown when trying to invoke
the getter. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null or the attribute in parameter is
null. |
|
Wraps a runtime exception thrown by the MBean's getter. | |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method getAttributes(ObjectName, String[])
.
name | The object name of the MBean from which the attributes are retrieved. |
---|---|
attributes | A list of the attributes to be retrieved. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
ReflectionException | An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean. |
Wrap a
java.lang.IllegalArgumentException : The object
name in parameter is null or attributes in parameter is null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Returns the connection ID. This string is different for every open connection to a given RMI connector server.
IOException | if a general communication exception occurred. |
---|
Handles the method
getDefaultDomain()
.
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
---|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
---|---|
IOException | if a general communication exception occurred. |
Handles the method
getDomains()
.
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
---|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
---|---|
IOException | if a general communication exception occurred. |
Handles the method
getMBeanCount()
.
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
---|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
---|---|
IOException | if a general communication exception occurred. |
Handles the method
getMBeanInfo(ObjectName)
.
name | The name of the MBean to analyze |
---|---|
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
MBeanInfo
allowing the
retrieval of all attributes and operations of this MBean.IntrospectionException | An exception occurred during introspection. |
---|---|
InstanceNotFoundException | The MBean specified was not found. |
ReflectionException | An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean. |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null.
|
Handles the method
getObjectInstance(ObjectName)
.
name | The object name of the MBean. |
---|---|
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
associated with the MBean
specified by name. The contained ObjectName
is name
and the contained class name is
getMBeanInfo(name)
.getClassName()
.InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method invoke(ObjectName, String, Object[], String[])
. The Object[]
parameter is wrapped in a MarshalledObject
.
name | The object name of the MBean on which the method is to be invoked. |
---|---|
operationName | The name of the operation to be invoked. |
params | An array containing the parameters to be set when
the operation is invoked, encapsulated into a
MarshalledObject . The encapsulated array can be
null, equivalent to an empty array. |
signature | An array containing the signature of the operation. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the operation was invoked. Can be null, equivalent to an empty array. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
MBeanException | Wraps an exception thrown by the MBean's invoked method. |
ReflectionException | Wraps a
java.lang.Exception thrown while trying to invoke
the method. |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Wraps an IllegalArgumentException when name or
operationName is null.
|
Handles the method isInstanceOf(ObjectName, String)
.
name | The ObjectName of the MBean. |
---|---|
className | The name of the class. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null.
|
Handles the method
isRegistered(ObjectName)
.
name | The object name of the MBean to be checked. |
---|---|
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method queryMBeans(ObjectName, QueryExp)
. The QueryExp
is wrapped in a
MarshalledObject
.
name | The object name pattern identifying the MBeans to be retrieved. If null or no domain and key properties are specified, all the MBeans registered will be retrieved. |
---|---|
query | The query expression to be applied for selecting
MBeans, encapsulated into a MarshalledObject . If
the MarshalledObject encapsulates a null value no
query expression will be applied for selecting MBeans. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
ObjectInstance
objects for the selected MBeans. If no MBean satisfies the
query an empty list is returned.SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
---|---|
IOException | if a general communication exception occurred. |
Handles the method queryNames(ObjectName, QueryExp)
. The QueryExp
is wrapped in a
MarshalledObject
.
name | The object name pattern identifying the MBean names to be retrieved. If null or no domain and key properties are specified, the name of all registered MBeans will be retrieved. |
---|---|
query | The query expression to be applied for selecting
MBeans, encapsulated into a MarshalledObject . If
the MarshalledObject encapsulates a null value no
query expression will be applied for selecting MBeans. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
---|---|
IOException | if a general communication exception occurred. |
Handles the method removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
. The
NotificationFilter
parameter is wrapped in a
MarshalledObject
. The Object
parameter is also wrapped in a MarshalledObject
.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | A listener that was previously added to this MBean. |
filter | The filter that was specified when the listener
was added, encapsulated into a MarshalledObject . |
handback | The handback that was specified when the
listener was added, encapsulated into a MarshalledObject . |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean name provided does not match any of the registered MBeans. |
---|---|
ListenerNotFoundException | The listener is not registered in the MBean, or it is not registered with the given filter and handback. |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Wraps an IllegalArgumentException when name or
listener is null. |
Handles the method removeNotificationListener(ObjectName, ObjectName)
.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | The object name of the listener to be removed. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean name provided does not match any of the registered MBeans. |
---|---|
ListenerNotFoundException | The listener is not registered in the MBean. |
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Wraps an IllegalArgumentException when name or
listener is null. |
Handles the
removeNotificationListener(ObjectName, NotificationListener)
and
removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
methods.
This method removes one or more
NotificationListener
s from a given MBean in the
MBean server.
The NotificationListeners
are identified by the
IDs which were returned by the addNotificationListeners(ObjectName[], MarshalledObject[], Subject[])
method.
name | the ObjectName identifying the MBean
emitting the Notifications. |
---|---|
listenerIDs | the list of the IDs corresponding to the listeners to remove. |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | if the given
name does not correspond to any registered MBean. |
---|---|
ListenerNotFoundException | if one of the listeners was
not found on the server side. This exception can happen if the
MBean discarded a listener for some reason other than a call to
MBeanServer.removeNotificationListener . |
SecurityException | if the client, or the delegated Subject if any, does not have permission to remove the listeners. |
IOException | if a general communication exception occurred. |
IllegalArgumentException | if ObjectName or
listenerIds is null or if listenerIds
contains a null element.
|
Handles the method setAttribute(ObjectName, Attribute)
. The Attribute
parameter is wrapped
in a MarshalledObject
.
name | The name of the MBean within which the attribute is to be set. |
---|---|
attribute | The identification of the attribute to be set
and the value it is to be set to, encapsulated into a
MarshalledObject . |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
AttributeNotFoundException | The attribute specified is not accessible in the MBean. |
InvalidAttributeValueException | The value specified for the attribute is not valid. |
MBeanException | Wraps an exception thrown by the MBean's setter. |
ReflectionException | Wraps a
java.lang.Exception thrown when trying to invoke
the setter. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null or the attribute in parameter is
null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method setAttributes(ObjectName, AttributeList)
. The AttributeList
parameter is
wrapped in a MarshalledObject
.
name | The object name of the MBean within which the attributes are to be set. |
---|---|
attributes | A list of attributes: The identification of
the attributes to be set and the values they are to be set to,
encapsulated into a MarshalledObject . |
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
ReflectionException | An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null or attributes in parameter is null. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |
Handles the method
unregisterMBean(ObjectName)
.
name | The object name of the MBean to be unregistered. |
---|---|
delegationSubject | The Subject containing the
delegation principals or null if the authentication
principal is used instead. |
InstanceNotFoundException | The MBean specified is not registered in the MBean server. |
---|---|
MBeanRegistrationException | The preDeregister
((MBeanRegistration interface) method of the MBean
has thrown an exception. |
Wraps a
java.lang.IllegalArgumentException : The object
name in parameter is null or the MBean you are when trying to
unregister is the MBeanServerDelegate MBean. |
|
SecurityException | if the client, or the delegated Subject if any, does not have permission to perform this operation. |
IOException | if a general communication exception occurred. |