com.revolsys.jmx

Class JmxService

java.lang.Object

com.revolsys.jmx.JmxService

public class JmxService
extends Object

The JmxService provides a wrapper around JMX connections to one or more servers. The service is configured with a list of server definitions which includes a logical name for the server and a connection to the server. Each server has a list of object names and labels and the list of attributes and operations to be exposed on that server. The only servers, objects, attributes and operations to be exposed are those in the configuration.

Author:

Paul Austin paul.austin@revolsys.com

Constructor Summary

Constructors

Constructor and Description
JmxService(List<Map<String,Object>> jmxServers) Construct a new JmxService.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String serverId, String objectId, String attributeId) Get the value for the attribute for an object on a server.
List<String>	getAttributeNames(String serverId, String objectId) Get all the attributes names for an object on a server.
List<FieldDefinition>	getAttributes(String serverId, String objectId) Get the values for all attributes for an object on a server.
MBeanOperationInfo	getOperation(String serverId, String objectId, String operationId) Get the description for the operation for an object on a server.
List<String>	getOperationNames(String serverId, String objectId) Get all the operations names for an object on a server.
List<MBeanOperationInfo>	getOperations(String serverId, String objectId) Get the description for all operations for an object on a server.
boolean	hasAttribute(String serverId, String objectId, String attributeId) Check to see if the object has been configured to have the specified attribute.
boolean	hasOperation(String serverId, String objectId, String operationId) Check to see if the object has been configured to have the specified operation.
Object	invokeOperation(String serverId, String objectId, String operationId, Map<String,String> parameters) Invoke the operation with the specified parameters.
void	writeAttribute(MapWriter mapWriter, String serverId, String objectId, String attributeId) Write the attribute for the attribute for an object on a server.
void	writeAttribute(MapWriter mapWriter, String serverId, String objectId, String attributeId, Object value) Write the attribute for the attribute for an object on a server.
void	writeAttributes(MapWriter mapWriter) Write the attributes for all servers and objects.
void	writeAttributes(MapWriter mapWriter, String serverId) Write the attributes for all objects for a server.
void	writeAttributes(MapWriter mapWriter, String serverId, String objectId) Write the attributes for the objects on a server.
void	writeOperation(MapWriter mapWriter, String serverId, String objectId, MBeanOperationInfo operation, Object returnValue) Write the operation for the operation for an object on a server.
void	writeOperation(MapWriter mapWriter, String serverId, String objectId, String operationId) Write the operation for the operation for an object on a server.
void	writeOperation(MapWriter mapWriter, String serverId, String objectId, String operationId, Object returnValue) Write the operation for the operation for an object on a server.
void	writeOperations(MapWriter mapWriter) Write the operations for all servers and objects.
void	writeOperations(MapWriter mapWriter, String serverId) Write the operations for all objects for a server.
void	writeOperations(MapWriter mapWriter, String serverId, String objectId) Write the operations for the objects on a server.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxService

public JmxService(List<Map<String,Object>> jmxServers)

Construct a new JmxService.

Parameters:

jmxServers - The list of JMX server configurations.

Method Detail

getAttribute

public Object getAttribute(String serverId,
                  String objectId,
                  String attributeId)

Get the value for the attribute for an object on a server.

Parameters:

mapWriter - The writer to write the attributes to.

serverId - The name of the server.

objectId - The name of the object.

attributeId - The name of the attribute.

Returns:

The attribute value.

getAttributeNames

public List<String> getAttributeNames(String serverId,
                             String objectId)

Get all the attributes names for an object on a server.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

Returns:

The attribute names.

getAttributes

public List<FieldDefinition> getAttributes(String serverId,
                                  String objectId)

Get the values for all attributes for an object on a server.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

Returns:

The attribute values.

getOperation

public MBeanOperationInfo getOperation(String serverId,
                              String objectId,
                              String operationId)

Get the description for the operation for an object on a server.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

operationId - The name of the operation.

Returns:

The operations values.

getOperationNames

public List<String> getOperationNames(String serverId,
                             String objectId)

Get all the operations names for an object on a server.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

Returns:

The attribute names.

getOperations

public List<MBeanOperationInfo> getOperations(String serverId,
                                     String objectId)

Get the description for all operations for an object on a server.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

Returns:

The operations values.

hasAttribute

public boolean hasAttribute(String serverId,
                   String objectId,
                   String attributeId)

Check to see if the object has been configured to have the specified attribute.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

attributeId - The name of the attribute.

Returns:

True if the attribute exists.

hasOperation

public boolean hasOperation(String serverId,
                   String objectId,
                   String operationId)

Check to see if the object has been configured to have the specified operation.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

operationId - The name of the operation.

Returns:

True if the operation exists.

invokeOperation

public Object invokeOperation(String serverId,
                     String objectId,
                     String operationId,
                     Map<String,String> parameters)

Invoke the operation with the specified parameters.

Parameters:

serverId - The name of the server.

objectId - The name of the object.

operationId - The name of the operation.

parameters - The parameters to pass to the operation.

Returns:

The result of executing the operation.

writeAttribute

public void writeAttribute(MapWriter mapWriter,
                  String serverId,
                  String objectId,
                  String attributeId)

Write the attribute for the attribute for an object on a server.

Parameters:

mapWriter - The writer to write the attributes to.

serverId - The name of the server.

objectId - The name of the object.

attributeId - The name of the attribute.

writeAttribute

public void writeAttribute(MapWriter mapWriter,
                  String serverId,
                  String objectId,
                  String attributeId,
                  Object value)

Write the attribute for the attribute for an object on a server.

Parameters:

mapWriter - The writer to write the attributes to.

serverId - The name of the server.

objectId - The name of the object.

attributeId - The name of the attribute.

value - The value to write.

writeAttributes

public void writeAttributes(MapWriter mapWriter)

Write the attributes for all servers and objects.

Parameters:

mapWriter - The writer to write the attributes to.

writeAttributes

public void writeAttributes(MapWriter mapWriter,
                   String serverId)

Write the attributes for all objects for a server.

Parameters:

mapWriter - The writer to write the attributes to.

serverId - The name of the server.

writeAttributes

public void writeAttributes(MapWriter mapWriter,
                   String serverId,
                   String objectId)

Write the attributes for the objects on a server.

Parameters:

mapWriter - The writer to write the attributes to.

serverId - The name of the server.

objectId - The name of the object.

writeOperation

public void writeOperation(MapWriter mapWriter,
                  String serverId,
                  String objectId,
                  MBeanOperationInfo operation,
                  Object returnValue)

Write the operation for the operation for an object on a server.

Parameters:

mapWriter - The writer to write the operation to.

serverId - The name of the server.

objectId - The name of the object.

operation - The operation details.

returnValue - The value returned from invoking the method.

writeOperation

public void writeOperation(MapWriter mapWriter,
                  String serverId,
                  String objectId,
                  String operationId)

Write the operation for the operation for an object on a server.

Parameters:

mapWriter - The writer to write the operation to.

serverId - The name of the server.

objectId - The name of the object.

operationId - The name of the operations.

writeOperation

public void writeOperation(MapWriter mapWriter,
                  String serverId,
                  String objectId,
                  String operationId,
                  Object returnValue)

Write the operation for the operation for an object on a server.

Parameters:

mapWriter - The writer to write the operation to.

serverId - The name of the server.

objectId - The name of the object.

operationId - The name of the operations.

returnValue - The value returned from invoking the method.

writeOperations

public void writeOperations(MapWriter mapWriter)

Write the operations for all servers and objects.

Parameters:

mapWriter - The writer to write the operations to.

writeOperations

public void writeOperations(MapWriter mapWriter,
                   String serverId)

Write the operations for all objects for a server.

Parameters:

mapWriter - The writer to write the operations to.

serverId - The name of the server.

writeOperations

public void writeOperations(MapWriter mapWriter,
                   String serverId,
                   String objectId)

Write the operations for the objects on a server.

Parameters:

mapWriter - The writer to write the operations to.

serverId - The name of the server.

objectId - The name of the object.