Package org.apache.activemq.artemis.api.core.management

Class ObjectNameBuilder

java.lang.Object
org.apache.activemq.artemis.api.core.management.ObjectNameBuilder
public final class ObjectNameBuilder extends Object
Helper class to build ObjectNames for ActiveMQ Artemis resources.

  • Field Details

    • DEFAULT

      public static final ObjectNameBuilder DEFAULT
      Default JMX domain for ActiveMQ Artemis resources.

  • Method Details

    • create

      public static ObjectNameBuilder create(String domain)

    • create

      public static ObjectNameBuilder create(String domain, String brokerName)

    • create

      public static ObjectNameBuilder create(String domain, String brokerName, boolean jmxUseBrokerName)

    • getActiveMQServerObjectName

      public ObjectName getActiveMQServerObjectName() throws Exception
      Returns the ObjectName used by the single ActiveMQServerControl.
      Returns:
      the ObjectName used by the single ActiveMQServerControl
      Throws:
      Exception

    • getAddressObjectName

      public ObjectName getAddressObjectName(SimpleString address) throws Exception
      Returns the ObjectName used by AddressControl.
      Returns:
      the ObjectName used by AddressControl
      Throws:
      Exception
      See Also:

    • getQueueObjectName

      public ObjectName getQueueObjectName(SimpleString address, SimpleString name, RoutingType routingType) throws Exception
      Returns the ObjectName used by QueueControl.
      Returns:
      the ObjectName used by QueueControl
      Throws:
      Exception
      See Also:

    • getDivertObjectName

      public ObjectName getDivertObjectName(String name, String address) throws Exception
      Returns the ObjectName used by DivertControl.
      Returns:
      the ObjectName used by DivertControl
      Throws:
      Exception
      See Also:

    • getAcceptorObjectName

      public ObjectName getAcceptorObjectName(String name) throws Exception
      Returns the ObjectName used by AcceptorControl.
      Returns:
      the ObjectName used by AcceptorControl
      Throws:
      Exception
      See Also:

    • getBroadcastGroupObjectName

      public ObjectName getBroadcastGroupObjectName(String name) throws Exception
      Returns the ObjectName used by BroadcastGroupControl.
      Returns:
      the ObjectName used by BroadcastGroupControl
      Throws:
      Exception
      See Also:

    • getBrokerConnectionObjectName

      public ObjectName getBrokerConnectionObjectName(String name) throws Exception
      Returns the ObjectName used by broker connection management objects for outgoing connections.
      Returns:
      the ObjectName used by broker connection management objects for outgoing connections
      Throws:
      Exception
      See Also:

    • getBrokerConnectionBaseObjectNameString

      public String getBrokerConnectionBaseObjectNameString(String name) throws Exception
      Returns the base ObjectName string used by for outgoing broker connections and possibly broker connection services that are registered by broker connection specific features. This value is pre-quoted and ready for use in an ObjectName.getIstnace call but is intended for use by broker connection components to create names specific to a broker connection feature that registers its own object for management.
      Parameters:
      name - The broker connection name
      Returns:
      the base object name string that is used for broker connection Object names
      Throws:
      Exception
      See Also:

    • getRemoteBrokerConnectionObjectName

      public ObjectName getRemoteBrokerConnectionObjectName(String nodeId, String name) throws Exception
      Returns the ObjectName used by remote broker connection management objects for incoming connections.
      Returns:
      the ObjectName used by remote broker connection management objects for incoming connections
      Throws:
      Exception
      See Also:

    • getRemoteBrokerConnectionBaseObjectNameString

      public String getRemoteBrokerConnectionBaseObjectNameString(String nodeId, String name) throws Exception
      Returns the base ObjectName string used by for incoming broker connections and possibly broker connection services that are registered by broker connection specific features. This value is pre-quoted and ready for use in an ObjectName.getIstnace call but is intended for use by broker connection components to create names specific to a broker connection feature that registers its own object for management.
      Parameters:
      nodeId - The node ID of the remote broker that initiated the broker connection.
      name - The broker connection name configured on the initiating broker.
      Returns:
      the base object name string that is used for broker connection Object names
      Throws:
      Exception

    • getBridgeObjectName

      public ObjectName getBridgeObjectName(String name) throws Exception
      Returns the ObjectName used by BridgeControl.
      Returns:
      the ObjectName used by BridgeControl
      Throws:
      Exception
      See Also:

    • getClusterConnectionObjectName

      public ObjectName getClusterConnectionObjectName(String name) throws Exception
      Returns the ObjectName used by ClusterConnectionControl.
      Returns:
      the ObjectName used by ClusterConnectionControl
      Throws:
      Exception
      See Also:

    • getConnectionRouterObjectName

      public ObjectName getConnectionRouterObjectName(String name) throws Exception
      Returns the ObjectName used by ConnectionRouterControl.
      Returns:
      the ObjectName used by ConnectionRouterControl
      Throws:
      Exception
      See Also:

    • getManagementContextObjectName

      @Deprecated public ObjectName getManagementContextObjectName() throws Exception
      Deprecated.
      Throws:
      Exception

    • getSecurityObjectName

      public ObjectName getSecurityObjectName() throws Exception
      Throws:
      Exception