com.j256.simplejmx.common

Class JmxResourceInfo

java.lang.Object

com.j256.simplejmx.common.JmxResourceInfo

All Implemented Interfaces:

JmxSelfNaming

public class JmxResourceInfo
extends Object
implements JmxSelfNaming

This is used programmatically to register another class for JMX exposure. This is used when you are wiring using code or Spring another object that does not use the JmxResource annotation or JmxSelfNaming.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
JmxResourceInfo()
JmxResourceInfo(String jmxDomainName, String jmxBeanName, JmxFolderName[] jmxFolderNames, String jmxDescription)
JmxResourceInfo(String jmxDomainName, String jmxBeanName, String jmxDescription)
JmxResourceInfo(String jmxDomainName, String jmxBeanName, String[] jmxFolderNameStrings, String jmxDescription)

Method Summary

Modifier and Type	Method and Description
String	getJmxBeanName() Return the name of the object that will be the "name=..." part of the associated ObjectName.
String	getJmxDescription()
String	getJmxDomainName() Return the domain name of the object that is used to built the associated ObjectName.
JmxFolderName[]	getJmxFolderNames() Return the appropriate array of folder names used to built the associated ObjectName.
void	setJmxBeanName(String jmxBeanName) NotRequired name of the object.
void	setJmxDescription(String jmxDescription) Description of the class for jconsole.
void	setJmxDomainName(String jmxDomainName) Required domain name which is the top-level folder in jconsole.
void	setJmxFolderNames(JmxFolderName[] jmxFolderNames) NotRequired array of folders where the bean will live.
void	setJmxFolderNameStrings(String[] jmxFolderNameStrings) NotRequired array of folders where the bean will live.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxResourceInfo

public JmxResourceInfo()

JmxResourceInfo

public JmxResourceInfo(String jmxDomainName,
                       String jmxBeanName,
                       JmxFolderName[] jmxFolderNames,
                       String jmxDescription)

JmxResourceInfo

public JmxResourceInfo(String jmxDomainName,
                       String jmxBeanName,
                       String[] jmxFolderNameStrings,
                       String jmxDescription)

JmxResourceInfo

public JmxResourceInfo(String jmxDomainName,
                       String jmxBeanName,
                       String jmxDescription)

Method Detail

getJmxDomainName

public String getJmxDomainName()

Description copied from interface: JmxSelfNaming

Return the domain name of the object that is used to built the associated ObjectName. Return null to use the one from the JmxResource.domainName() annotation instead.

Specified by:

getJmxDomainName in interface JmxSelfNaming

setJmxDomainName

public void setJmxDomainName(String jmxDomainName)

Required domain name which is the top-level folder in jconsole.

See Also:

JmxResource.domainName()

getJmxBeanName

public String getJmxBeanName()

Description copied from interface: JmxSelfNaming

Return the name of the object that will be the "name=..." part of the associated ObjectName. Return null to use the one from the JmxResource.beanName() annotation instead.

Specified by:

getJmxBeanName in interface JmxSelfNaming

setJmxBeanName

public void setJmxBeanName(String jmxBeanName)

NotRequired name of the object. The- default is the Spring bean name or object name.

See Also:

JmxResource.beanName()

getJmxFolderNames

public JmxFolderName[] getJmxFolderNames()

Description copied from interface: JmxSelfNaming

Return the appropriate array of folder names used to built the associated ObjectName. Return null to use the folder names specified in the JmxResource.folderNames() annotation instead.

Specified by:

getJmxFolderNames in interface JmxSelfNaming

setJmxFolderNames

public void setJmxFolderNames(JmxFolderName[] jmxFolderNames)

NotRequired array of folders where the bean will live. Default is no folders. Either this or setJmxFolderNameStrings(String[]) should be used.

See Also:

JmxResource.folderNames()

setJmxFolderNameStrings

public void setJmxFolderNameStrings(String[] jmxFolderNameStrings)

NotRequired array of folders where the bean will live. Default is no folders. Either this or setJmxFolderNames(JmxFolderName[]) should be used. Can be used to specify an array of folder-names instead of having to construct a JmxFolderName array.

See Also:

JmxResource.folderNames()

getJmxDescription

public String getJmxDescription()

setJmxDescription

public void setJmxDescription(String jmxDescription)

Description of the class for jconsole. Not required. Default is something like: "Information about class-name".

See Also:

JmxResource.description()