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 Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static ObjectNameBuilder` | `DEFAULT` Default JMX domain for ActiveMQ Artemis resources.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static ObjectNameBuilder` | `create(String domain)`
    `static ObjectNameBuilder` | `create(String domain, String brokerName)`
    `static ObjectNameBuilder` | `create(String domain, String brokerName, boolean jmxUseBrokerName)`
    `ObjectName` | `getAcceptorObjectName(String name)` Returns the ObjectName used by AcceptorControl.
    `ObjectName` | `getActiveMQServerObjectName()` Returns the ObjectName used by the single `ActiveMQServerControl`.
    `ObjectName` | `getAddressObjectName(SimpleString address)` Returns the ObjectName used by AddressControl.
    `ObjectName` | `getBridgeObjectName(String name)` Returns the ObjectName used by BridgeControl.
    `ObjectName` | `getBroadcastGroupObjectName(String name)` Returns the ObjectName used by BroadcastGroupControl.
    `ObjectName` | `getBrokerBalancerObjectName(String name)` Returns the ObjectName used by BrokerBalancerControl.
    `ObjectName` | `getClusterConnectionObjectName(String name)` Returns the ObjectName used by ClusterConnectionControl.
    `ObjectName` | `getDivertObjectName(String name, String address)` Returns the ObjectName used by DivertControl.
    `ObjectName` | `getManagementContextObjectName()`
    `ObjectName` | `getQueueObjectName(SimpleString address, SimpleString name, RoutingType routingType)` Returns the ObjectName used by QueueControl.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### DEFAULT

          public static final ObjectNameBuilder DEFAULT

      Default JMX domain for ActiveMQ Artemis resources.

  - ### Method Detail

    - #### 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`.
      Throws:
        `Exception`

    - #### getAddressObjectName

          public ObjectName getAddressObjectName(SimpleString address)
                                          throws Exception

      Returns the ObjectName used by AddressControl.
      Throws:
        `Exception`
      See Also:
        `AddressControl`

    - #### getQueueObjectName

          public ObjectName getQueueObjectName(SimpleString address,
                                               SimpleString name,
                                               RoutingType routingType)
                                        throws Exception

      Returns the ObjectName used by QueueControl.
      Throws:
        `Exception`
      See Also:
        `QueueControl`

    - #### getDivertObjectName

          public ObjectName getDivertObjectName(String name,
                                                String address)
                                         throws Exception

      Returns the ObjectName used by DivertControl.
      Throws:
        `Exception`
      See Also:
        `DivertControl`

    - #### getAcceptorObjectName

          public ObjectName getAcceptorObjectName(String name)
                                           throws Exception

      Returns the ObjectName used by AcceptorControl.
      Throws:
        `Exception`
      See Also:
        `AcceptorControl`

    - #### getBroadcastGroupObjectName

          public ObjectName getBroadcastGroupObjectName(String name)
                                                 throws Exception

      Returns the ObjectName used by BroadcastGroupControl.
      Throws:
        `Exception`
      See Also:
        `BroadcastGroupControl`

    - #### getBridgeObjectName

          public ObjectName getBridgeObjectName(String name)
                                         throws Exception

      Returns the ObjectName used by BridgeControl.
      Throws:
        `Exception`
      See Also:
        `BridgeControl`

    - #### getClusterConnectionObjectName

          public ObjectName getClusterConnectionObjectName(String name)
                                                    throws Exception

      Returns the ObjectName used by ClusterConnectionControl.
      Throws:
        `Exception`
      See Also:
        `ClusterConnectionControl`

    - #### getBrokerBalancerObjectName

          public ObjectName getBrokerBalancerObjectName(String name)
                                                 throws Exception

      Returns the ObjectName used by BrokerBalancerControl.
      Throws:
        `Exception`
      See Also:
        `BrokerBalancerControl`

    - #### getManagementContextObjectName

          public ObjectName getManagementContextObjectName()
                                                    throws Exception

      Throws:
        `Exception`

Copyright © 2021 The Apache Software Foundation. All rights reserved.