public class RMIConnectionImpl extends Objectimplements RMIConnection , Unreferenced
Implementation of the RMIConnection interface. User code will not usually reference this class.
| Constructor and Description |
|---|
RMIConnectionImpl(RMIServerImpl
Constructs a new
RMIConnection.
|
public RMIConnectionImpl(RMIServerImplrmiServer, String connectionId, ClassLoader defaultClassLoader, Subject subject, Map <String ,?> env)
RMIConnection. This connection can be used with either the JRMP or IIOP transport. This object does not export itself: it is the responsibility of the caller to export it appropriately (see
RMIJRMPServerImpl.makeClient(String,Subject) and
RMIIIOPServerImpl.makeClient(String,Subject) .
rmiServer - The RMIServerImpl object for which this connection is created. The behavior is unspecified if this parameter is null.
connectionId - The ID for this connection. The behavior is unspecified if this parameter is null.
defaultClassLoader - The default ClassLoader to be used when deserializing marshalled objects. Can be null, to signify the bootstrap class loader.
subject - the authenticated subject to be used for authorization. Can be null, to signify that no subject has been authenticated.
env - the environment containing attributes for the new
RMIServerImpl. Can be null, equivalent to an empty map.
public StringgetConnectionId() throws IOException
RMIConnection
Returns the connection ID. This string is different for every open connection to a given RMI connector server.
getConnectionId in interface
RMIConnection
IOException - if a general communication exception occurred.
RMIConnector.connect
public void close()
throws IOException
RMIConnection
Closes this connection. On return from this method, the RMI object implementing this interface is unexported, so further remote calls to it will fail.
close in interface
Closeable
close in interface
AutoCloseable
close in interface
RMIConnection
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.
public void unreferenced()
Unreferenced
public ObjectInstancecreateMBean(String className, ObjectName name, Subject delegationSubject) throws ReflectionException , InstanceAlreadyExistsException , MBeanRegistrationException , MBeanException , NotCompliantMBeanException , IOException
RMIConnection
MBeanServerConnection.createMBean(String, ObjectName) .
createMBean in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public ObjectInstancecreateMBean(String className, ObjectName name, ObjectName loaderName, Subject delegationSubject) throws ReflectionException , InstanceAlreadyExistsException , MBeanRegistrationException , MBeanException , NotCompliantMBeanException , InstanceNotFoundException , IOException
RMIConnection
MBeanServerConnection.createMBean(String, ObjectName, ObjectName) .
createMBean in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public ObjectInstancecreateMBean(String className, ObjectName name, MarshalledObject params, String [] signature, Subject delegationSubject) throws ReflectionException , InstanceAlreadyExistsException , MBeanRegistrationException , MBeanException , NotCompliantMBeanException , IOException
RMIConnection
MBeanServerConnection.createMBean(String, ObjectName, Object[], String[]) . The
Object[] parameter is wrapped in a
MarshalledObject.
createMBean in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public ObjectInstancecreateMBean(String className, ObjectName name, ObjectName loaderName, MarshalledObject params, String [] signature, Subject delegationSubject) throws ReflectionException , InstanceAlreadyExistsException , MBeanRegistrationException , MBeanException , NotCompliantMBeanException , InstanceNotFoundException , IOException
RMIConnection
MBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[]) . The
Object[] parameter is wrapped in a
MarshalledObject.
createMBean in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public void unregisterMBean(ObjectNamename, Subject delegationSubject) throws InstanceNotFoundException , MBeanRegistrationException , IOException
RMIConnection
MBeanServerConnection.unregisterMBean(ObjectName) .
unregisterMBean in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public ObjectInstancegetObjectInstance(ObjectName name, Subject delegationSubject) throws InstanceNotFoundException , IOException
RMIConnection
MBeanServerConnection.getObjectInstance(ObjectName) .
getObjectInstance in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public Set<ObjectInstance > queryMBeans(ObjectName name, MarshalledObject query, Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.queryMBeans(ObjectName, QueryExp) . The
QueryExp is wrapped in a
MarshalledObject.
queryMBeans in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public Set<ObjectName > queryNames(ObjectName name, MarshalledObject query, Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.queryNames(ObjectName, QueryExp) . The
QueryExp is wrapped in a
MarshalledObject.
queryNames in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public boolean isRegistered(ObjectNamename, Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.isRegistered(ObjectName) .
isRegistered in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public IntegergetMBeanCount(Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.getMBeanCount() .
getMBeanCount in interface
RMIConnection
delegationSubject - The
Subject containing the delegation principals or
null if the authentication principal is used instead.
IOException - if a general communication exception occurred.
public ObjectgetAttribute(ObjectName name, String attribute, Subject delegationSubject) throws MBeanException , AttributeNotFoundException , InstanceNotFoundException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.getAttribute(ObjectName, String) .
getAttribute in interface
RMIConnection
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.
MBeanException - Wraps an exception thrown by the MBean's getter.
AttributeNotFoundException - The attribute specified is not accessible in the MBean.
InstanceNotFoundException - The MBean specified is not registered in the MBean server.
ReflectionException - Wraps a
java.lang.Exception thrown when trying to invoke the getter.
IOException - if a general communication exception occurred.
RMIConnection.setAttribute(javax.management.ObjectName, java.rmi.MarshalledObject, javax.security.auth.Subject)
public AttributeListgetAttributes(ObjectName name, String [] attributes, Subject delegationSubject) throws InstanceNotFoundException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.getAttributes(ObjectName, String[]) .
getAttributes in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.setAttributes(javax.management.ObjectName, java.rmi.MarshalledObject, javax.security.auth.Subject)
public void setAttribute(ObjectNamename, MarshalledObject attribute, Subject delegationSubject) throws InstanceNotFoundException , AttributeNotFoundException , InvalidAttributeValueException , MBeanException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.setAttribute(ObjectName, Attribute) . The
Attribute parameter is wrapped in a
MarshalledObject.
setAttribute in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.getAttribute(javax.management.ObjectName, java.lang.String, javax.security.auth.Subject)
public AttributeListsetAttributes(ObjectName name, MarshalledObject attributes, Subject delegationSubject) throws InstanceNotFoundException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.setAttributes(ObjectName, AttributeList) . The
AttributeList parameter is wrapped in a
MarshalledObject.
setAttributes in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.getAttributes(javax.management.ObjectName, java.lang.String[], javax.security.auth.Subject)
public Objectinvoke(ObjectName name, String operationName, MarshalledObject params, String [] signature, Subject delegationSubject) throws InstanceNotFoundException , MBeanException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.invoke(ObjectName, String, Object[], String[]) . The
Object[] parameter is wrapped in a
MarshalledObject.
invoke in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public StringgetDefaultDomain(Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.getDefaultDomain() .
getDefaultDomain in interface
RMIConnection
delegationSubject - The
Subject containing the delegation principals or
null if the authentication principal is used instead.
IOException - if a general communication exception occurred.
public String[] getDomains(Subject delegationSubject) throws IOException
RMIConnection
MBeanServerConnection.getDomains() .
getDomains in interface
RMIConnection
delegationSubject - The
Subject containing the delegation principals or
null if the authentication principal is used instead.
IOException - if a general communication exception occurred.
public MBeanInfogetMBeanInfo(ObjectName name, Subject delegationSubject) throws InstanceNotFoundException , IntrospectionException , ReflectionException , IOException
RMIConnection
MBeanServerConnection.getMBeanInfo(ObjectName) .
getMBeanInfo in interface
RMIConnection
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.
InstanceNotFoundException - The MBean specified was not found.
IntrospectionException - An exception occurred during introspection.
ReflectionException - An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.
IOException - if a general communication exception occurred.
public boolean isInstanceOf(ObjectNamename, String className, Subject delegationSubject) throws InstanceNotFoundException , IOException
RMIConnection
MBeanServerConnection.isInstanceOf(ObjectName, String) .
isInstanceOf in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public Integer[] addNotificationListeners(ObjectName [] names, MarshalledObject [] filters, Subject [] delegationSubjects) throws InstanceNotFoundException , IOException
RMIConnection
Handles the method MBeanServerConnection.
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.
addNotificationListeners in interface
RMIConnection
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.
InstanceNotFoundException - if one of the
names does not correspond to any registered MBean.
IOException - if a general communication exception occurred.
public void addNotificationListener(ObjectNamename, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) throws InstanceNotFoundException , IOException
RMIConnection
MBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) . The
NotificationFilter parameter is wrapped in a
MarshalledObject. The
Object (handback) parameter is also wrapped in a
MarshalledObject.
addNotificationListener in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.removeNotificationListener(ObjectName, ObjectName, Subject) ,
RMIConnection.removeNotificationListener(ObjectName, ObjectName, MarshalledObject, MarshalledObject, Subject)
public void removeNotificationListeners(ObjectNamename, Integer [] listenerIDs, Subject delegationSubject) throws InstanceNotFoundException , ListenerNotFoundException , IOException
RMIConnection
Handles the removeNotificationListener(ObjectName, NotificationListener) and removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object) methods.
This method removes one or more NotificationListeners from a given MBean in the MBean server.
The NotificationListeners are identified by the IDs which were returned by the RMIConnection method.
removeNotificationListeners in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
public void removeNotificationListener(ObjectNamename, ObjectName listener, Subject delegationSubject) throws InstanceNotFoundException , ListenerNotFoundException , IOException
RMIConnection
MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName) .
removeNotificationListener in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.addNotificationListener(javax.management.ObjectName, javax.management.ObjectName, java.rmi.MarshalledObject, java.rmi.MarshalledObject, javax.security.auth.Subject)
public void removeNotificationListener(ObjectNamename, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) throws InstanceNotFoundException , ListenerNotFoundException , IOException
RMIConnection
MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) . The
NotificationFilter parameter is wrapped in a
MarshalledObject. The
Object parameter is also wrapped in a
MarshalledObject.
removeNotificationListener in interface
RMIConnection
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.
IOException - if a general communication exception occurred.
RMIConnection.addNotificationListener(javax.management.ObjectName, javax.management.ObjectName, java.rmi.MarshalledObject, java.rmi.MarshalledObject, javax.security.auth.Subject)
public NotificationResultfetchNotifications(long clientSequenceNumber, int maxNotifications, long timeout) throws IOException
RMIConnection
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 RMIConnection.
fetchNotifications in interface
RMIConnection
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.
public StringtoString()
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.