com.denodo.common.custom.policy

Interface JmxConnection

public interface JmxConnection

The JmxConnection interface provides access to the MBeans registered on the JVM the VDP Server is running.

If the custom policy was assigned by an administrator, all the MBeans in the JVM will be available. However, if the custom policy was assigned by an user who has administration privileges in certain databases, only the MBeans related to these databases will be available. If the custom policy tries to access a MBean that is not allowed to an InsufficientPrivilegeException will be thrown.

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(ObjectName name, String attribute) Gets the value of a specific attribute of a named MBean.
AttributeList	getAttributes(ObjectName name, String[] attributes) Enables the values of several attributes of a named MBean.
MBeanInfo	getMBeanInfo(ObjectName name) This method discovers the attributes and operations that an MBean exposes for management.
Object	invoke(ObjectName name, String operationName, Object[] params, String[] signature) Invokes an operation on an MBean.
boolean	isRegistered(ObjectName name) Checks whether an MBean, identified by its object name, is already registered with the MBean server.
Set<ObjectInstance>	queryMBeans(ObjectName name, QueryExp query) Gets MBeans controlled by the MBean server.
Set<ObjectName>	queryNames(ObjectName name, QueryExp query) Gets the names of MBeans controlled by the MBean server.

Method Detail

isRegistered

boolean isRegistered(ObjectName name)
              throws IOException,
                     InsufficientPrivilegeException

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

Parameters:

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

Returns:

True if the MBean is already registered in the MBean server, false otherwise

Throws:

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access this MBean

See Also:

MBeanServerConnection.isRegistered(ObjectName)

queryMBeans

Set<ObjectInstance> queryMBeans(ObjectName name,
                                QueryExp query)
                         throws IOException,
                                InsufficientPrivilegeException

Gets MBeans controlled by the MBean server. 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.

Parameters:

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. If null no query expression will be applied for selecting MBeans.

Returns:

A set containing the ObjectInstance objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.

Throws:

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access some of these MBeans

See Also:

MBeanServerConnection.queryMBeans(ObjectName, QueryExp)

queryNames

Set<ObjectName> queryNames(ObjectName name,
                           QueryExp query)
                    throws IOException,
                           InsufficientPrivilegeException

Gets the names of MBeans controlled by the MBean server. This method enables 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).

Parameters:

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. If null no query expression will be applied for selecting MBeans.

Returns:

A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.

Throws:

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access some of these MBeans

See Also:

MBeanServerConnection.queryNames(ObjectName, QueryExp)

getAttribute

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

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

Parameters:

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.

Returns:

The value of the retrieved attribute.

Throws:

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 setter.

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access this MBean

See Also:

MBeanServerConnection.getAttribute(ObjectName, String)

getAttributes

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

Enables the values of several attributes of a named MBean. The MBean is identified by its object name.

Parameters:

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

attributes - A list of the attributes to be retrieved.

Returns:

The list of the retrieved attributes.

Throws:

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.

RuntimeOperationsException - Wrap a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access this MBean

See Also:

MBeanServerConnection.getAttributes(ObjectName, String[])

invoke

Object invoke(ObjectName name,
              String operationName,
              Object[] params,
              String[] signature)
       throws InstanceNotFoundException,
              MBeanException,
              ReflectionException,
              IOException,
              InsufficientPrivilegeException

Invokes an operation on an MBean.

Parameters:

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

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.

Returns:

The object returned by the operation, which represents the result of invoking the operation on the MBean specified.

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 Exception thrown while trying to invoke the method.

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access this MBean

See Also:

MBeanServerConnection.invoke(ObjectName, String, Object[], String[])

getMBeanInfo

MBeanInfo getMBeanInfo(ObjectName name)
                throws InstanceNotFoundException,
                       IntrospectionException,
                       ReflectionException,
                       IOException,
                       InsufficientPrivilegeException

This method discovers the attributes and operations that an MBean exposes for management.

Parameters:

name - The name of the MBean to analyze

Returns:

An instance of MBeanInfo allowing the retrieval of all attributes and operations of this MBean.

Throws:

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.

IOException - A communication problem occurred when talking to the MBean server.

InsufficientPrivilegeException - The custom policy is not allowed to access this MBean

See Also:

MBeanServerConnection.getMBeanInfo(ObjectName)