Class ManagementContext

java.lang.Object
org.apache.activemq.broker.jmx.ManagementContext
All Implemented Interfaces:
org.apache.activemq.Service

public class ManagementContext extends Object implements org.apache.activemq.Service
An abstraction over JMX MBean registration
  • Field Details

    • DEFAULT_DOMAIN

      public static final String DEFAULT_DOMAIN
      Default activemq domain
      See Also:
    • DEFAULT_LOOKUP_NAME

      public static final String DEFAULT_LOOKUP_NAME
      Default registry lookup name
      See Also:
    • DEFAULT_CREATE_CONNECTOR

      public static final boolean DEFAULT_CREATE_CONNECTOR
  • Constructor Details

    • ManagementContext

      public ManagementContext()
    • ManagementContext

      public ManagementContext(MBeanServer server)
  • Method Details

    • start

      public void start() throws Exception
      Specified by:
      start in interface org.apache.activemq.Service
      Throws:
      Exception
    • stop

      public void stop() throws Exception
      Specified by:
      stop in interface org.apache.activemq.Service
      Throws:
      Exception
    • getBrokerName

      public String getBrokerName()
      Gets the broker name this context is used by, may be null if the broker name was not set.
    • setBrokerName

      public void setBrokerName(String brokerName)
      Sets the broker name this context is being used by.
    • getJmxDomainName

      public String getJmxDomainName()
      Returns:
      Returns the jmxDomainName.
    • setJmxDomainName

      public void setJmxDomainName(String jmxDomainName)
      Parameters:
      jmxDomainName - The jmxDomainName to set.
    • getMBeanServer

      public MBeanServer getMBeanServer()
      Get the MBeanServer
      Returns:
      the MBeanServer
    • setMBeanServer

      public void setMBeanServer(MBeanServer beanServer)
      Set the MBeanServer
    • isUseMBeanServer

      public boolean isUseMBeanServer()
      Returns:
      Returns the useMBeanServer.
    • setUseMBeanServer

      public void setUseMBeanServer(boolean useMBeanServer)
      Parameters:
      useMBeanServer - The useMBeanServer to set.
    • isCreateMBeanServer

      public boolean isCreateMBeanServer()
      Returns:
      Returns the createMBeanServer flag.
    • setCreateMBeanServer

      public void setCreateMBeanServer(boolean enableJMX)
      Parameters:
      enableJMX - Set createMBeanServer.
    • isFindTigerMbeanServer

      public boolean isFindTigerMbeanServer()
    • isConnectorStarted

      public boolean isConnectorStarted()
    • setFindTigerMbeanServer

      public void setFindTigerMbeanServer(boolean findTigerMbeanServer)
      Enables/disables the searching for the Java 5 platform MBeanServer
    • createCustomComponentMBeanName

      public ObjectName createCustomComponentMBeanName(String type, String name)
      Formulate and return the MBean ObjectName of a custom control MBean
      Returns:
      the JMX ObjectName of the MBean, or null if customName is invalid.
    • getSystemObjectName

      public static ObjectName getSystemObjectName(String domainName, String containerName, Class<?> theClass) throws MalformedObjectNameException, NullPointerException
      Retrieve an System ObjectName
      Throws:
      MalformedObjectNameException
      NullPointerException
    • newProxyInstance

      public Object newProxyInstance(ObjectName objectName, Class<?> interfaceClass, boolean notificationBroadcaster)
    • getAttribute

      public Object getAttribute(ObjectName name, String attribute) throws Exception
      Throws:
      Exception
    • registerMBean

      public ObjectInstance registerMBean(Object bean, ObjectName name) throws Exception
      Throws:
      Exception
    • isAllowedToRegister

      protected boolean isAllowedToRegister(ObjectName name)
    • queryNames

      public Set<ObjectName> queryNames(ObjectName name, QueryExp query) throws Exception
      Throws:
      Exception
    • getObjectInstance

      public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException
      Throws:
      InstanceNotFoundException
    • unregisterMBean

      public void unregisterMBean(ObjectName name) throws JMException
      Unregister an MBean
      Throws:
      JMException
    • findMBeanServer

      protected MBeanServer findMBeanServer()
    • findTigerMBeanServer

      public MBeanServer findTigerMBeanServer()
    • createMBeanServer

      protected MBeanServer createMBeanServer() throws MalformedObjectNameException, IOException
      Returns:
      an MBeanServer instance
      Throws:
      MalformedObjectNameException
      IOException
    • getConnectorPath

      public String getConnectorPath()
    • setConnectorPath

      public void setConnectorPath(String connectorPath)
    • getConnectorPort

      public int getConnectorPort()
    • setConnectorPort

      public void setConnectorPort(int connectorPort)
    • getRmiServerPort

      public int getRmiServerPort()
    • setRmiServerPort

      public void setRmiServerPort(int rmiServerPort)
    • isCreateConnector

      public boolean isCreateConnector()
    • setCreateConnector

      public void setCreateConnector(boolean createConnector)
    • getConnectorHost

      public String getConnectorHost()
      Get the connectorHost
      Returns:
      the connectorHost
    • setConnectorHost

      public void setConnectorHost(String connectorHost)
      Set the connectorHost
      Parameters:
      connectorHost - the connectorHost to set
    • getEnvironment

      public Map<String,?> getEnvironment()
    • setEnvironment

      public void setEnvironment(Map<String,?> environment)
    • isAllowRemoteAddressInMBeanNames

      public boolean isAllowRemoteAddressInMBeanNames()
    • setAllowRemoteAddressInMBeanNames

      public void setAllowRemoteAddressInMBeanNames(boolean allowRemoteAddressInMBeanNames)
    • setSuppressMBean

      public void setSuppressMBean(String commaListOfAttributeKeyValuePairs)
      Allow selective MBeans registration to be suppressed. Any Mbean ObjectName that matches any of the supplied attribute values will not be registered with the MBeanServer. eg: "endpoint=dynamicProducer,endpoint=Consumer" will suppress the registration of *all* dynamic producer and consumer mbeans.
      Parameters:
      commaListOfAttributeKeyValuePairs - the comma separated list of attribute key=value pairs to match.
    • getSuppressMBean

      public String getSuppressMBean()