Package com.tangosol.net.management

Interface MBeanServerFinder

All Known Implementing Classes:
JmxmpServer
public interface MBeanServerFinder
MBeanServerFinder represents a facility that allows a pluggable run-time selection of an MBeanServer to be used by the Coherence JMX framework.
Since:
Coherence 3.6
Author:
gg 2009.06.22

  • Method Summary

    Modifier and Type
    Method
    Description
    JMXServiceURL
    findJMXServiceUrl(String sDefaultDomain)
    Find the JMXServiceURL for the MBeanConnector used by the Coherence JMX framework.
    MBeanServer
    findMBeanServer(String sDefaultDomain)
    Find an MBeanServer that should be used by the Coherence JMX framework to register new or locate existing MBeans.

  • Method Details

    • findMBeanServer

      MBeanServer findMBeanServer(String sDefaultDomain)
      Find an MBeanServer that should be used by the Coherence JMX framework to register new or locate existing MBeans.

      Under some circumstances, there could exist more than one MBeanServer and the default domain name parameter is used to identify which MBeanServer should be returned by this method.

      When standard Coherence MBeans are need to be registered with an MBeanServer, this method is passed the value of the "management-config/default-domain-name" element in the operational configuration descriptor (empty string by default). When a platform or custom MBeans are to be queried using the "mbean/mbean-query" configuration element, the value of the "mbean/mbean-server-domain" element is passed as this parameter.

      Note: Returning null will result in Coherence using the standard MBeanServer discovery algorithm (see MBeanHelper.findMBeanServer(String)).

      Parameters:
      sDefaultDomain - the default domain name; empty string indicates that the caller does not have any preferences and MBeanServerFinder could return any MBeanServer it deems fit
      Returns:
      an existing or new MBeanServer with the specified default domain name (if specified) or null

    • findJMXServiceUrl

      JMXServiceURL findJMXServiceUrl(String sDefaultDomain)
      Find the JMXServiceURL for the MBeanConnector used by the Coherence JMX framework.

      When "management-config/managed-nodes" value is set to "dynamic" and a Coherence node is elected to be a management node, then it calls this method to find out if there is an existing MBean Connector running that can be used to access the MBeanServer on the node. It publishes this JMXServiceURL thru the Coherence NamingService.

      If there is no existing MBeanConnector running, then a new Connector is started and its JMXServiceURL is published in the NamingService.

      Parameters:
      sDefaultDomain - the default domain name; empty string indicates that the caller does not have any preferences and MBeanServerFinder could return any JMXServiceURL it deems fit
      Returns:
      JMXServiceURL for the MBeanConnector or null if no MBean Connector running.