com.sun.jbi.ui.client

Interface JMXConnection

All Known Implementing Classes:

JMXConnectionImpl, RemoteJMXConnectionImpl, SunASEEJMXConnectionImpl

public interface JMXConnection

This interface defines the higher level interface to access jmx apis from client side.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() closes the jmx connection
Object	getMBeanAttribute(ObjectName name, String attribute) retrieves the attribute value
MBeanServerConnection	getMBeanServerConnection() gives the MBeanSever connection interface.
Object	invokeMBeanOperation(ObjectName name, String operationName, Object[] params, String[] signature) invokes the operation on mbean
void	openConnection() opens the jmx connection
void	setMBeanAttribute(ObjectName name, Attribute attribute) sets the attribute value

Method Detail

openConnection

void openConnection()
                    throws JMXConnectionException

opens the jmx connection

Throws:

JMXConnectionException - on jmx error

closeConnection

void closeConnection()
                     throws JMXConnectionException

closes the jmx connection

Throws:

JMXConnectionException - on jmx error

getMBeanServerConnection

MBeanServerConnection getMBeanServerConnection()
                                               throws IllegalStateException

gives the MBeanSever connection interface. Should be called after open

Returns:

mbean server connection interface

Throws:

IllegalStateException - on jmx error

invokeMBeanOperation

Object invokeMBeanOperation(ObjectName name,
                          String operationName,
                          Object[] params,
                          String[] signature)
                            throws JMXConnectionException,
                                   JBIRemoteException

invokes the operation on mbean

Parameters:

name - object name

operationName - operation name

params - parameters

signature - signature of the parameters

Returns:

result object

Throws:

JMXConnectionException - on jmx error

JBIRemoteException - on user error

getMBeanAttribute

Object getMBeanAttribute(ObjectName name,
                       String attribute)
                         throws JMXConnectionException,
                                JBIRemoteException

retrieves the attribute value

Parameters:

name - object name

attribute - attribute object

Returns:

result object

Throws:

JMXConnectionException - on jmx error

JBIRemoteException - on user error

setMBeanAttribute

void setMBeanAttribute(ObjectName name,
                     Attribute attribute)
                       throws JMXConnectionException,
                              JBIRemoteException

sets the attribute value

Parameters:

name - object name

attribute - attribute object

Throws:

JMXConnectionException - on jmx error

JBIRemoteException - on user error