com.sun.jdmk.comm
Class RmiConnectorClient

java.lang.Object
  com.sun.jdmk.comm.RmiConnectorClient

All Implemented Interfaces:

ClientNotificationHandler, HeartBeatClientHandler, RemoteMBeanServer, NotificationRegistration, ProxyHandler

Deprecated. The JMX Remote API should be used in preference to the legacy Java DMK connector classes. The legacy RMI connector, including this class, may be removed in a future version of Java DMK. See javax.management.remote.rmi and JdmkLegacyConnector.

public class RmiConnectorClient
extends Object
implements RemoteMBeanServer, HeartBeatClientHandler

Provides an implementation of the RemoteMBeanServer interface based on the Java remote method invocation (RMI) system.

Querying a Java Dynamic Management agent with this connector implies that an instance of RmiConnectorServer is running on the remote Java Dynamic Management agent. In order to identify the Java Dynamic Management agent the connector needs to communicate with, the method connect needs to be invoked with the RMI identity of the RMI Connector Server.

This class implements the ClientNotificationHandler interface to receive notifications from a remote MBean and the HeartBeatClientHandler interface to detect any problem that could be encountered in the connection with the RMI Connector Server

Field Summary

Fields inherited from interface com.sun.jdmk.comm.ClientNotificationHandler

DISCARD_NEW, DISCARD_OLD, NO_CACHE_LIMIT, PULL_MODE, PUSH_MODE

Constructor Summary

RmiConnectorClient()
Deprecated. Default constructor for RmiConnectorClient.

RmiConnectorClient(InetAddress addr)
Deprecated. Only used for a Client with Java DMK 5.0 to connect to a server with a Java DMK 4.2 or earlier version.

RmiConnectorClient(InetAddress add, int commTimeout)
Deprecated.

RmiConnectorClient(RMIClientSocketFactory csf)
Deprecated.

RmiConnectorClient(String addr)
Deprecated. Constructs an RmiConnectorClient.

Method Summary

void	addHeartBeatNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Deprecated. Adds the specified heartbeat listener to receive heartbeat notifications from this connector client.
void	addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) Deprecated. Adds a listener to a registered MBean.
void	clearCache() Deprecated. Clear the notification cache.
String	connect(ConnectorAddress MBeanServerAddress) Deprecated. Initializes the communication with the remote MBeanServer.
ObjectInstance	createMBean(String className, ObjectName name) Deprecated. Creates and registers an instance of an MBean in the remote object server.
ObjectInstance	createMBean(String className, ObjectName name, Object[] params, String[] signature) Deprecated. Creates and registers an instance of an MBean in the remote object server.
ObjectInstance	createMBean(String className, ObjectName name, ObjectName loaderName) Deprecated. Creates and registers an instance of an MBean in the remote object server.
ObjectInstance	createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature) Deprecated. Creates and registers an instance of an MBean in the remote object server.
void	disconnect() Deprecated. Terminates the communication with the MBeanServer.
void	disconnect(boolean local) Deprecated. Terminates the communication with the MBeanServer.
Object	getAttribute(ObjectName name, String attribute) Deprecated. Gets the value of a specific attribute of a named MBean.
AttributeList	getAttributes(ObjectName name, String[] attributes) Deprecated. Allows you to retrieve the values of several attributes of an MBean.
int	getCacheSize() Deprecated. Get the cache size of notifications waiting to be forwarded.
String	getClassForProxyMBean(ObjectInstance instance) Deprecated. Given the object name and the Java class name of the MBean (ObjectInstance), this method returns the name of the Java class of the corresponding Proxy MBean.
String	getDefaultDomain() Deprecated. Returns the default domain used for the MBean naming.
int	getHeartBeatPeriod() Deprecated. Gets the heartbeat period in milliseconds.
int	getHeartBeatRetries() Deprecated. Gets the number of retries.
Integer	getMBeanCount() Deprecated. Returns the number of MBeans controlled by the MBeanServer.
MBeanInfo	getMBeanInfo(ObjectName name) Deprecated. This method supplies the exposed attributes and actions of the MBean.
ConnectorAddress	getMBeanServerAddress() Deprecated. Returns the exact address of the MBeanServer to which the ConnectorClient is connected.
String	getMBeanServerId() Deprecated. Returns a string which represents the MBeanServer identification.
int	getMode() Deprecated. Gets the notification forwarding mode.
void	getNotifications() Deprecated. Retrieves all notifications in the cache.
ObjectInstance	getObjectInstance(ObjectName name) Deprecated. Gets the ObjectInstance for a given MBean registered with the MBeanServer.
OperationContext	getOperationContext() Deprecated. Get the OperationContext that was last given to setOperationContext, or null if setOperationContext was never called.
int	getOverflowCount() Deprecated. Get the number of notifications discarded since last forwarding because the cache limit has been reached.
int	getOverflowMode() Deprecated. Return whether to discard the oldest message (DISCARD_OLD) or the the newest message (DISCARD_NEW), if the cache size exceeds.
int	getPeriod() Deprecated. Gets the period for notification forwarding in milliseconds.
Object	invoke(ObjectName name, String methodName, Object[] arguments, String[] signature) Deprecated. Invokes a method of an MBean.
boolean	isConnected() Deprecated. Checks whether a communication with the MBeanServer is established.
boolean	isInstanceOf(ObjectName name, String className) Deprecated. Returns true if the MBean specified is an instance of the specified class, false otherwise.
boolean	isRegistered(ObjectName name) Deprecated. Checks whether an MBean, identified by its object name, is already registered with the MBeanServer.
Set	queryMBeans(ObjectName name, QueryExp query) Deprecated. Gets MBeans controlled by the MBeanServer.
Set	queryNames(ObjectName name, QueryExp query) Deprecated. Gets the names of MBeans controlled by the MBeanServer.
void	removeHeartBeatNotificationListener(NotificationListener listener) Deprecated. Removes the specified heartbeat listener so that it no longer receives heartbeat notifications from this connector client.
void	removeNotificationListener(ObjectName name, NotificationListener listener) Deprecated. Removes a listener from a registered MBean.
void	setAttribute(ObjectName name, Attribute attribute) Deprecated. Sets the value of a specific attribute of a named MBean.
AttributeList	setAttributes(ObjectName name, AttributeList attributes) Deprecated. Allows you to modify the values of several attributes of an MBean.
int	setCacheSize(int size, boolean discardOverflow) Deprecated. Sets the cache size of notifications waiting to be forwarded.
void	setHeartBeatPeriod(int period) Deprecated. Specifies the heartbeat period in milliseconds.
void	setHeartBeatRetries(int nretries) Deprecated. Sets the number of retries.
void	setMode(int mode) Deprecated. Sets the notification forwarding mode.
void	setOperationContext(OperationContext c) Deprecated. Set the OperationContext of this connector.
void	setOverflowCount(int count) Deprecated. Sets the number of notifications discarded, this number indicates the number of notifications discarded because the cache limit has been reached.
void	setOverflowMode(int of) Deprecated. Specify whether to discard the oldest message (DISCARD_OLD) or the the newest message (DISCARD_NEW), if the cache size exceeds.
void	setPeriod(int period) Deprecated. Specifies the period for notification forwarding in milliseconds.
void	setTimeout(int timeout) Deprecated.
void	unregisterMBean(ObjectName name) Deprecated. Deletes an instance of an MBean in the remote MBean server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RmiConnectorClient

public RmiConnectorClient(RMIClientSocketFactory csf)

Deprecated.

RmiConnectorClient

public RmiConnectorClient()

Deprecated.

Default constructor for RmiConnectorClient.

RmiConnectorClient

public RmiConnectorClient(InetAddress addr)

Deprecated. Only used for a Client with Java DMK 5.0 to connect to a server with a Java DMK 4.2 or earlier version.

Constructs RmiConnectorClient.

Parameters:

addr - a user specified local host address to receive notifications from the server.

RmiConnectorClient

public RmiConnectorClient(InetAddress add,
                          int commTimeout)

Deprecated.

RmiConnectorClient

public RmiConnectorClient(String addr)

Deprecated.

Constructs an RmiConnectorClient. This constructor is only intended to be used for a Client with Java DMK 5.0 or later to connect to a server with a Java DMK 4.2 or earlier version.

Parameters:

addr - a local host address to receive notifications from the server.

Since:

Java DMK 5.0

Method Detail

setTimeout

public void setTimeout(int timeout)

Deprecated.

setMode

public void setMode(int mode)
             throws IllegalArgumentException

Deprecated.

Sets the notification forwarding mode. If set to PUSH_MODE, it is the agent to push notifications to the client, if set to PULL_MODE, it is the client to retrieve notifications from the agent.

The default value is PUSH_MODE.

Specified by:

setMode in interface ClientNotificationHandler

Parameters:

mode - set to PUSH_MODE or PULL_MODE.

Throws:

IllegalArgumentException - Thrown if the mode is not equal to PUSH_MODE nor PULL_MODE.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getMode

public int getMode()

Deprecated.

Gets the notification forwarding mode. If set to PUSH_MODE, it is the agent to push notifications to the client, if set to PULL_MODE, it is the client to retrieve notifications from the agent.

The default value is PUSH_MODE.

Specified by:

getMode in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getNotifications

public void getNotifications()

Deprecated.

Retrieves all notifications in the cache.

Specified by:

getNotifications in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

clearCache

public void clearCache()

Deprecated.

Clear the notification cache. All notifications stored in the cache then will be discarded without being sent.

Specified by:

clearCache in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

setPeriod

public void setPeriod(int period)

Deprecated.

Specifies the period for notification forwarding in milliseconds.

If set to equal to or less than zero and the pull mode is used, no pull will be done. A user should explicitly call getNotifications to retrieve all notifications in the cache. This method has no effect in the push mode in the current implementation.

The default value is 1000 milliseconds.

Specified by:

setPeriod in interface ClientNotificationHandler

Parameters:

period - The period in milliseconds.

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getPeriod

public int getPeriod()

Deprecated.

Gets the period for notification forwarding in milliseconds.

The default value is 1000 milliseconds.

Specified by:

getPeriod in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

setCacheSize

public int setCacheSize(int size,
                        boolean discardOverflow)

Deprecated.

Sets the cache size of notifications waiting to be forwarded.

If set to NO_CACHE_LIMIT, notifications will never be discarded, but this may lead to OutOfMemory errors under stressed conditions. If set to zero, any notification will be discarded without being sent.

The default value is NO_CACHE_LIMIT.

Specified by:

setCacheSize in interface ClientNotificationHandler

Parameters:

size - the maximum number of notifications in the cache.

discardOverflow - effective only if current number of cached notifications exceeds the new size: if true, discard excess notifications; if false, the cache size will not be changed.

Returns:

The cache size currently set.

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getCacheSize

public int getCacheSize()

Deprecated.

Get the cache size of notifications waiting to be forwarded.

If set to NO_CACHE_LIMIT or a negative value, notifications will never be discarded, but this may lead to OutOfMemory errors under stressed conditions.

The default value is NO_CACHE_LIMIT.

Specified by:

getCacheSize in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

setOverflowCount

public void setOverflowCount(int count)

Deprecated.

Sets the number of notifications discarded, this number indicates the number of notifications discarded because the cache limit has been reached.

This count will be reset to zero if no more listener exists at the client side, because in this case the notification server will remove all information about this notification client.

Specified by:

setOverflowCount in interface ClientNotificationHandler

Parameters:

count - The new value to set to overflow count.

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getOverflowCount

public int getOverflowCount()

Deprecated.

Get the number of notifications discarded since last forwarding because the cache limit has been reached. This value can be reset by calling the method setOverFlowCount.

This count will be reset to zero if no more listener exists at the client side, because in this case the notification server will remove all information about this notification client.

Specified by:

getOverflowCount in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

setOverflowMode

public void setOverflowMode(int of)
                     throws IllegalArgumentException

Deprecated.

Specify whether to discard the oldest message (DISCARD_OLD) or the the newest message (DISCARD_NEW), if the cache size exceeds.

The default mode is DISCARD_OLD.

Specified by:

setOverflowMode in interface ClientNotificationHandler

Parameters:

of - The overflow mode to specify.

Throws:

IllegalArgumentException - Thrown if the mode is not DISCARD_NEW nor DISCARD_OLD.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getOverflowMode

public int getOverflowMode()

Deprecated.

Return whether to discard the oldest message (DISCARD_OLD) or the the newest message (DISCARD_NEW), if the cache size exceeds.

The default mode is DISCARD_OLD.

Specified by:

getOverflowMode in interface ClientNotificationHandler

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

addNotificationListener

public void addNotificationListener(ObjectName name,
                                    NotificationListener listener,
                                    NotificationFilter filter,
                                    Object handback)
                             throws InstanceNotFoundException

Deprecated.

Adds a listener to a registered MBean.

Specified by:

addNotificationListener in interface NotificationRegistration

Parameters:

name - The name of the MBean on which the listener should be added.

listener - The listener object which will handle the notifications emitted by the registered MBean.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - The context to be sent to the listener when a notification is emitted.

Throws:

InstanceNotFoundException - The MBean name provided does not match any of the registered MBeans.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       NotificationListener listener)
                                throws InstanceNotFoundException,
                                       ListenerNotFoundException

Deprecated.

Removes a listener from a registered MBean.

Specified by:

removeNotificationListener in interface NotificationRegistration

Parameters:

name - The name of the MBean on which the listener should be removed.

listener - The listener object which will handle the notifications emitted by the registered MBean. This method will remove all the information related to this listener.

Throws:

InstanceNotFoundException - The MBean name provided does not match any of the registered MBeans.

ListenerNotFoundException - The listener is not registered in the MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getHeartBeatPeriod

public int getHeartBeatPeriod()

Deprecated.

Gets the heartbeat period in milliseconds.

The default value is 10000 milliseconds.

Specified by:

getHeartBeatPeriod in interface HeartBeatClientHandler

setHeartBeatPeriod

public void setHeartBeatPeriod(int period)

Deprecated.

Specifies the heartbeat period in milliseconds.

If set to zero no check will be carried out for the associated connector server being alive. As the heartbeat is driven by the manager this would also prevent the connector server from being aware of the aliveness of this connector client.

The default value is 10000 milliseconds.

Specified by:

setHeartBeatPeriod in interface HeartBeatClientHandler

Parameters:

period - The heartbeat period in milliseconds.

getHeartBeatRetries

public int getHeartBeatRetries()

Deprecated.

Gets the number of retries. This number specifies how many times a connector client must retry the connection to the connector server before sending the heartbeat notification indicating that the connector server has died. If number of retries equals zero then no retries are carried out.

The default value is 6 times.

Specified by:

getHeartBeatRetries in interface HeartBeatClientHandler

setHeartBeatRetries

public void setHeartBeatRetries(int nretries)

Deprecated.

Sets the number of retries. This number specifies how many times a connector client must retry the connection to the connector server before sending the heartbeat notification indicating that the connector server has died. If number of retries equals zero then no retries are carried out.

The default value is 6 times.

Specified by:

setHeartBeatRetries in interface HeartBeatClientHandler

Parameters:

nretries - The number of retries.

addHeartBeatNotificationListener

public void addHeartBeatNotificationListener(NotificationListener listener,
                                             NotificationFilter filter,
                                             Object handback)

Deprecated.

Adds the specified heartbeat listener to receive heartbeat notifications from this connector client. Heartbeat notifications occur when the connector client connects to or disconnects from the connector server or when the connector server associated to this connector client dies or is temporarily unreachable.

Specified by:

addHeartBeatNotificationListener in interface HeartBeatClientHandler

Parameters:

listener - The heartbeat listener which will handle the notifications emitted by the connector client.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - The context to be sent to the listener when a notification is emitted.

removeHeartBeatNotificationListener

public void removeHeartBeatNotificationListener(NotificationListener listener)

Deprecated.

Removes the specified heartbeat listener so that it no longer receives heartbeat notifications from this connector client. Heartbeat notifications occur when the connector client connects to or disconnects from the connector server or when the connector server associated to this connector client dies or is temporarily unreachable.

Specified by:

removeHeartBeatNotificationListener in interface HeartBeatClientHandler

Parameters:

listener - The heartbeat listener which will handle the notifications emitted by the connector client.

setOperationContext

public void setOperationContext(OperationContext c)

Deprecated.

Set the OperationContext of this connector. This context will be sent along with each request and can be recovered by the server, which can make it available to the operations it invokes.

The saved OperationContext will be a clone of the object c made using its clone method.

Specified by:

setOperationContext in interface RemoteMBeanServer

Parameters:

c - the new OperationContext. It may be null to indicate that there is no context. The previous OperationContext, if any, is lost.

Throws:

CommunicationException - if the context cannot be set for some reason. One common reason is that the object c does not implement the Cloneable interface.

getOperationContext

public OperationContext getOperationContext()

Deprecated.

Get the OperationContext that was last given to setOperationContext, or null if setOperationContext was never called.

Specified by:

getOperationContext in interface RemoteMBeanServer

Returns:

the current OperationContext.

connect

public String connect(ConnectorAddress MBeanServerAddress)

Deprecated.

Initializes the communication with the remote MBeanServer. All the information needed to identify the MBeanServer to contact and the protocol to be used is contained in the object of the type ConnectorAddress passed as a parameter. For then RmiconnectotClient, the ConnectorAddress should of class RmiConnectorAddress. If a communication problem occurs this method will throw a CommunicationException (JMRuntimeException). If the RemoteMBeanServer had already been connected and disconnected with an MBeanServer identified by its MBeanServerId, and if the MBeanServer reachable by the MBeanServerAddress parameter doesn't have to same MBeanServerId, the java.lang.IllegalAccessException is thrown.

Specified by:

connect in interface RemoteMBeanServer

Parameters:

MBeanServerAddress - The exact MBeanServer address to contact (MBeanServer identification, protocol specification).

Returns:

A String identifying the MBeanServer with which the communication is established.

Throws:

CommunicationException - The RemoteMBeanServer was already connected or a problem was encountered in the connection to the RMI Connector Server.

IllegalArgumentException - The RemoteMBeanServer has already been connected and disconnected and the specified ConnectorAddress doesn't identify the same MBeanServer.

disconnect

public void disconnect()

Deprecated.

Terminates the communication with the MBeanServer.

Specified by:

disconnect in interface RemoteMBeanServer

disconnect

public void disconnect(boolean local)

Deprecated.

Terminates the communication with the MBeanServer.

isConnected

public boolean isConnected()

Deprecated.

Checks whether a communication with the MBeanServer is established.

Specified by:

isConnected in interface RemoteMBeanServer

Returns:

True, if the communication is established, otherwise false.

getMBeanServerAddress

public ConnectorAddress getMBeanServerAddress()

Deprecated.

Returns the exact address of the MBeanServer to which the ConnectorClient is connected. The address is of the type ConnectorAddress.

Specified by:

getMBeanServerAddress in interface RemoteMBeanServer

Returns:

The exact address of the remote MBeanServer, or null if the ConnectorClient is not connected.

getMBeanServerId

public String getMBeanServerId()

Deprecated.

Returns a string which represents the MBeanServer identification. This String comes from the MBeanServerDelegate Mbean. If the Connector Client has not already been connected, it returns null. If the Connector Client has been connected and disconnected, getMBeanServerId still returns the previous MBeanServer identification.

Specified by:

getMBeanServerId in interface RemoteMBeanServer

Returns:

If the Connector Client has not been connected yet, it returns null. If the connector Client has been connected and disconnected, getMbeanServerId still returns the previous MbeanServer identification.

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException

Deprecated.

Creates and registers an instance of an MBean in the remote object server. When calling the method, you have to provide the class name of the Java implementation to be used for instantiating the new object. It returns an ObjectInstance representing the remote MBean created.

Specified by:

createMBean in interface RemoteMBeanServer

Parameters:

className - The name of the Java class to be used by the MBeanServer for creating the MBean.

name - The name of the MBean to be created.

Returns:

An ObjectInstance representing the newly created MBean.

Throws:

ReflectionException - Wraps the 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 - Wraps an exception thrown by the MBean's constructor.

NotCompliantMBeanException - This class is not a JMX compliant MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  ObjectName loaderName)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException,
                                  InstanceNotFoundException

Deprecated.

Creates and registers an instance of an MBean in the remote object server. When calling the method, you have to provide the class name of the Java implementation to be used for instantiating the new object. You can optionally provide the name of the class loader to be used. It returns an ObjectInstance representing the remote MBean created.

Specified by:

createMBean in interface RemoteMBeanServer

Parameters:

className - The name of the Java class to be used by the MBeanServer for creating the MBean.

name - The name of the MBean to be created.

loaderName - The name of the class loader to be used by the MBeanServer.

Returns:

An ObjectInstance representing the newly created MBean.

Throws:

ReflectionException - Wraps the 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 - Wraps an exception thrown by the MBean's constructor.

NotCompliantMBeanException - This class is not a JMX compliant MBean.

InstanceNotFoundException - The specified loader is not registered in the MBeanServer.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  Object[] params,
                                  String[] signature)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException

Deprecated.

Creates and registers an instance of an MBean in the remote object server. When calling the method, you have to provide the class name of the Java implementation to be used for instantiating the new object. It returns an ObjectInstance representing the remote MBean created.

Specified by:

createMBean in interface RemoteMBeanServer

Parameters:

className - The name of the Java class to be used by the MBeanServer for creating the MBean.

name - The name of the MBean to be created.

params - An array containing the parameters of the constructor to be invoked. A parameter can be any Java object that is serializable.

signature - An array containing the signature of the constructor to be invoked.

Returns:

An ObjectInstance representing the newly created MBean.

Throws:

ReflectionException - Wraps the 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 - Wraps an exception thrown by the MBean's constructor.

NotCompliantMBeanException - This class is not a JMX compliant MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  ObjectName loaderName,
                                  Object[] params,
                                  String[] signature)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException,
                                  InstanceNotFoundException

Deprecated.

Creates and registers an instance of an MBean in the remote object server. When calling the method, you have to provide the class name of the Java implementation to be used for instantiating the new object. You can optionally provide the name of the class loader to be used. It returns an ObjectInstance representing the remote MBean created.

Specified by:

createMBean in interface RemoteMBeanServer

Parameters:

className - The name of the Java class to be used by the MBeanServer for creating the MBean.

name - The name of the MBean to be created.

loaderName - The name of the class loader to be used by the MBeanServer.

params - An array containing the parameters of the constructor to be invoked. A parameter can be any Java object that is serializable.

signature - An array containing the signature of the constructor to be invoked.

Returns:

An ObjectInstance representing the newly created MBean.

Throws:

ReflectionException - Wraps the 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 - Wraps an exception thrown by the MBean's constructor.

NotCompliantMBeanException - This class is not a JMX compliant MBean.

InstanceNotFoundException - The specified loader is not registered in the MBeanServer.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

unregisterMBean

public void unregisterMBean(ObjectName name)
                     throws InstanceNotFoundException,
                            MBeanRegistrationException

Deprecated.

Deletes an instance of an MBean in the remote MBean server. It also removes its local proxy (ProxyMBean and/or GenericProxy) object from the ProxyFactory.

Specified by:

unregisterMBean in interface RemoteMBeanServer

Specified by:

unregisterMBean in interface ProxyHandler

Parameters:

name - The name of the MBean to be deleted.

Throws:

InstanceNotFoundException - The specified MBean is not registered in the MBeanServer.

MBeanRegistrationException - The preDeregister (MBeanRegistration interface) method of the MBean has thrown an exception.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

isRegistered

public boolean isRegistered(ObjectName name)

Deprecated.

Checks whether an MBean, identified by its object name, is already registered with the MBeanServer.

Specified by:

isRegistered in interface RemoteMBeanServer

Parameters:

name - The object name of the MBean to be checked.

Returns:

True if the MBean is already registered in the MBeanServer, false otherwise.

Throws:

RuntimeOperationsException - Wraps an IllegalArgumentException: The object name in parameter is null.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

queryNames

public Set queryNames(ObjectName name,
                      QueryExp query)

Deprecated.

Gets the names of MBeans controlled by the MBeanServer. This method allows any of the following to be obtained: The names of all MBeans, the names of a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean name (equivalent to testing whether an MBean is registered). When the object name is null or empty, all the objects are to be selected (and filtered if a query is specified). It returns the set of ObjectNames for the MBeans selected.

Specified by:

queryNames in interface RemoteMBeanServer

Parameters:

name - The object name pattern identifying the MBean names to be retrieved. If null or empty, the names of all the registered MBeans will be retrieved.

query - The query expression to be applied for selecting MBeans.

Returns:

A set containing the ObjectNames for the MBeans selected.

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

queryMBeans

public Set queryMBeans(ObjectName name,
                       QueryExp query)

Deprecated.

Gets MBeans controlled by the MBeanServer. This method allows any of the following to be obtained: All MBeans, a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean. When the object name is null or empty, all objects are to be selected (and filtered if a query is specified). It returns the set of ObjectInstance for the selected MBeans.

Specified by:

queryMBeans in interface RemoteMBeanServer

Parameters:

name - The object name pattern identifying the MBeans to be retrieved. If null or empty all the MBeans registered will be retrieved.

query - The query expression to be applied for selecting MBeans.

Returns:

A set containing the ObjectInstance for the MBeans selected.

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getMBeanCount

public Integer getMBeanCount()

Deprecated.

Returns the number of MBeans controlled by the MBeanServer.

Specified by:

getMBeanCount in interface RemoteMBeanServer

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getDefaultDomain

public String getDefaultDomain()

Deprecated.

Returns the default domain used for the MBean naming.

Specified by:

getDefaultDomain in interface RemoteMBeanServer

Throws:

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

isInstanceOf

public boolean isInstanceOf(ObjectName name,
                            String className)
                     throws InstanceNotFoundException

Deprecated.

Returns true if the MBean specified is an instance of the specified class, false otherwise.

Specified by:

isInstanceOf in interface RemoteMBeanServer

Parameters:

name - The ObjectName of the MBean.

className - The name of the class.

Returns:

true if the MBean specified is an instance of the specified class, false otherwise.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

getObjectInstance

public ObjectInstance getObjectInstance(ObjectName name)
                                 throws InstanceNotFoundException

Deprecated.

Gets the ObjectInstance for a given MBean registered with the MBeanServer.

Specified by:

getObjectInstance in interface RemoteMBeanServer

Parameters:

name - The object name of the MBean.

Returns:

The ObjectInstance associated to the MBean specified by name.

Throws:

InstanceNotFoundException - The specified MBean is not registered in the MBeanServer.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getAttribute

public Object getAttribute(ObjectName name,
                           String attribute)
                    throws MBeanException,
                           AttributeNotFoundException,
                           InstanceNotFoundException,
                           ReflectionException

Deprecated.

Gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

Specified by:

getAttribute in interface RemoteMBeanServer

Specified by:

getAttribute in interface ProxyHandler

Parameters:

name - The object name of the MBean from which the attribute is to be retrieved.

attribute - The name of the attribute to be retrieved.

Returns:

The value of the retrieved attribute. The return value can be any Java object that is serializable.

Throws:

AttributeNotFoundException - The attribute specified is not accessible in the MBean.

MBeanException - Wraps an exception thrown by the MBean's getter.

InstanceNotFoundException - The specified MBean is not registered in the MBeanServer.

ReflectionException - An exception occurred when trying to invoke the getAttributes of a Dynamic MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getAttributes

public AttributeList getAttributes(ObjectName name,
                                   String[] attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException

Deprecated.

Allows you to retrieve the values of several attributes of an MBean.

Specified by:

getAttributes in interface RemoteMBeanServer

Specified by:

getAttributes in interface ProxyHandler

Parameters:

name - The object name of the MBean from within which the attributes are to be retrieved.

attributes - A list of the attributes to be retrieved.

Returns:

The values of the attributes retrieved. The value of the attributes can be any Java object that is serializable.

Throws:

InstanceNotFoundExceptionThe - MBean specified is not registered in the MBean server.

ReflectionException - An exception occurred when trying to invoke the getAttributes of a Dynamic MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

InstanceNotFoundException - The specified MBean is not registered in the MBean server.

setAttribute

public void setAttribute(ObjectName name,
                         Attribute attribute)
                  throws InstanceNotFoundException,
                         AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

Deprecated.

Sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

Specified by:

setAttribute in interface RemoteMBeanServer

Specified by:

setAttribute in interface ProxyHandler

Parameters:

name - The name of the MBean within which the attribute is to be set.

attribute - The modification to be performed: The identification of the attribute to be set, the value it is to be set to, and the operator to apply. The value of the attribute can be any Java object that is serializable.

Throws:

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 an exception thrown while trying to instantiate and apply the operator specified in Modification.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

setAttributes

public AttributeList setAttributes(ObjectName name,
                                   AttributeList attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException

Deprecated.

Allows you to modify the values of several attributes of an MBean.

Specified by:

setAttributes in interface RemoteMBeanServer

Specified by:

setAttributes in interface ProxyHandler

Parameters:

name - The object name of the MBean from within which the attributes are to be set.

attributes - A list of the attributes to be set, their values and, optionally, the operators to apply. The value of the attributes can be any Java object that is serializable.

Returns:

The values of the attributes that were set. The value of the attributes can be any Java object that is serializable.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

ReflectionException - An exception occurred when trying to invoke the setAttributes of a Dynamic MBean.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

invoke

public Object invoke(ObjectName name,
                     String methodName,
                     Object[] arguments,
                     String[] signature)
              throws InstanceNotFoundException,
                     MBeanException,
                     ReflectionException

Deprecated.

Invokes a method of an MBean.

Specified by:

invoke in interface RemoteMBeanServer

Specified by:

invoke in interface ProxyHandler

Parameters:

name - The name of the MBean on which the method is to be invoked.

methodName - The name of the method to be invoked.

arguments - An array containing the arguments to be set when the method is invoked. An argument can be any Java object that is serializable.

signature - An array containing the signature of the method.

Returns:

The object returned by the invocation of the given method. The return value can be any Java object that is serializable.

Throws:

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.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getMBeanInfo

public MBeanInfo getMBeanInfo(ObjectName name)
                       throws InstanceNotFoundException,
                              IntrospectionException,
                              ReflectionException

Deprecated.

This method supplies the exposed attributes and actions of the MBean. It provides this information using an MBeanInfo object.

Specified by:

getMBeanInfo in interface RemoteMBeanServer

Specified by:

getMBeanInfo in interface ProxyHandler

Parameters:

name - The names of the MBean whose attributes and actions will be returned.

Returns:

An instance of MBeanInfo which allows all methods and actions of this MBean to be retrieved.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

IntrospectionException - An exception occurs during introspection.

ReflectionException - Wraps an java.lang.Exception thrown while trying to invoke the getMBeanInfo method.

CommunicationException - The RMI Connector Client is not connected to RMI Connector Server or a problem was encountered in the connection to the RMI Connector Server.

getClassForProxyMBean

public String getClassForProxyMBean(ObjectInstance instance)
                             throws ProxyMBeanInstantiationException

Deprecated.

Given the object name and the Java class name of the MBean (ObjectInstance), this method returns the name of the Java class of the corresponding Proxy MBean. The returned name can be null, if there is no Java class corresponding to the needed Proxy MBean.

Specified by:

getClassForProxyMBean in interface RemoteMBeanServer

Parameters:

instance - The ObjectInstance of the MBean which is represented by the ProxyMBean.

Returns:

The name of the Java class of the ProxyMBean.

Throws:

ProxyMBeanInstantiationException - An error occurs.