com.haulmont.cuba.web.jmx

Interface JmxControlAPI

All Known Implementing Classes:

JmxControlBean

public interface JmxControlAPI

Interface to provide JMX control functionality for local and remote JMX interfaces

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.util.List<ManagedBeanDomain>	getDomains(JmxInstance instance) Loads list of managed bean domains
java.util.List<JmxInstance>	getInstances()
JmxInstance	getLocalInstance()
java.lang.String	getLocalNodeName()
ManagedBeanInfo	getManagedBean(JmxInstance instance, java.lang.String beanObjectName) Loads the managed bean by its ObjectName
java.util.List<ManagedBeanInfo>	getManagedBeans(JmxInstance instance) Loads the list of managed bean infos
ManagedBeanOperation	getOperation(ManagedBeanInfo bean, java.lang.String operationName, java.lang.String[] argTypes) Searches for the bean operation by its name and argument types.
java.lang.String	getRemoteNodeName(JmxInstance jmxInstance)
java.lang.Object	invokeOperation(ManagedBeanOperation operation, java.lang.Object[] parameterValues) Invokes method of managed bean
ManagedBeanAttribute	loadAttribute(ManagedBeanInfo info, java.lang.String attributeName) Loads attribute by its name.
void	loadAttributes(ManagedBeanInfo info) Loads attributes for managed bean descriptor
void	loadAttributeValue(ManagedBeanAttribute attribute) Loads attribute value for managed bean attribute
void	saveAttributeValue(ManagedBeanAttribute attribute) Saves attribute value to JMX node

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getInstances

java.util.List<JmxInstance> getInstances()

Returns:

the list with available JMX nodes in cluster

getLocalInstance

JmxInstance getLocalInstance()

Returns:

the local JMX node descriptor

getLocalNodeName

java.lang.String getLocalNodeName()

Returns:

the local cluster node name

getRemoteNodeName

java.lang.String getRemoteNodeName(JmxInstance jmxInstance)

Returns:

the remote cluster node name

getManagedBeans

java.util.List<ManagedBeanInfo> getManagedBeans(JmxInstance instance)

Loads the list of managed bean infos

Parameters:

instance - JMX node descriptor

Returns:

the list with managed beans

getManagedBean

ManagedBeanInfo getManagedBean(JmxInstance instance,
                               java.lang.String beanObjectName)

Loads the managed bean by its ObjectName

Parameters:

instance - JMX node descriptor

beanObjectName - exact ObjectName of the bean

Returns:

found managed bean, null if no bean found

loadAttributes

void loadAttributes(ManagedBeanInfo info)

Loads attributes for managed bean descriptor

Parameters:

info - managed bean descriptor

loadAttribute

@Nullable
ManagedBeanAttribute loadAttribute(ManagedBeanInfo info,
                                             java.lang.String attributeName)

Loads attribute by its name. Note that the reference from ManagedBeanInfo to loaded ManagedBeanAttribute is not set.

Parameters:

info - managed bean descriptor

Returns:

loaded attribute, null if no attribute found.

loadAttributeValue

void loadAttributeValue(ManagedBeanAttribute attribute)

Loads attribute value for managed bean attribute

Parameters:

attribute - attribute descriptor

saveAttributeValue

void saveAttributeValue(ManagedBeanAttribute attribute)

Saves attribute value to JMX node

Parameters:

attribute - attribute descriptor

getOperation

ManagedBeanOperation getOperation(ManagedBeanInfo bean,
                                  java.lang.String operationName,
                                  @Nullable
                                  java.lang.String[] argTypes)

Searches for the bean operation by its name and argument types.

Parameters:

bean - managed bean descriptor

operationName - operation exact name

argTypes - operation argument types

Returns:

Found operation descriptor, null if not found

invokeOperation

java.lang.Object invokeOperation(ManagedBeanOperation operation,
                                 java.lang.Object[] parameterValues)

Invokes method of managed bean

Parameters:

operation - operation descriptor

parameterValues - array with parameter values

Returns:

invocation result

getDomains

java.util.List<ManagedBeanDomain> getDomains(JmxInstance instance)

Loads list of managed bean domains

Parameters:

instance - JMX node descriptor

Returns:

the list of managed bean domains