com.j256.simplejmx.common
Interface JmxSelfNaming

All Known Implementing Classes:
BaseJmxSelfNaming

public interface JmxSelfNaming

This allows objects to name themselves based on some internal values. This is often used by objects that have multiple instances and that are dynamically added and removed. Objects that are passed to JmxServer.register(Object) must either implement this interface or have a JmxResource annotation.

Author:
graywatson

Method Summary
 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.
 String getJmxNameOfObject()
          Return the name of the object that will be the "name=..." part of the associated ObjectName.
 

Method Detail

getJmxDomainName

String getJmxDomainName()
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.


getJmxNameOfObject

String getJmxNameOfObject()
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.


getJmxFolderNames

JmxFolderName[] getJmxFolderNames()
Return the appropriate array of folder names used to built the associated ObjectName. Return null for no folders in which case the bean will be at the top of the hierarchy in jconsole without any sub-folders.



This content is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.