Class AMQPFederationManagementSupport

java.lang.Object
org.apache.activemq.artemis.protocol.amqp.connect.federation.AMQPFederationManagementSupport
public abstract class AMQPFederationManagementSupport extends Object
Support methods for working with the AMQP Federation management types

  • Field Details

    • FEDERATION_SOURCE_RESOURCE_TEMPLATE

      public static final String FEDERATION_SOURCE_RESOURCE_TEMPLATE
      Template used to denote federation source instances in the server management registry.
      See Also:

    • FEDERATION_SOURCE_POLICY_RESOURCE_TEMPLATE

      public static final String FEDERATION_SOURCE_POLICY_RESOURCE_TEMPLATE
      Template used to denote federation policy managers created on the source in the server management registry.
      See Also:

    • FEDERATION_SOURCE_CONSUMER_RESOURCE_TEMPLATE

      public static final String FEDERATION_SOURCE_CONSUMER_RESOURCE_TEMPLATE
      Template used to denote federation consumers on the source in the server management registry. Since policy names are unique on the local broker AMQP federation configuration these names should not collide as each policy will create only one consumer for a given address or queue.
      See Also:

    • FEDERATION_SOURCE_PRODUCER_RESOURCE_TEMPLATE

      public static final String FEDERATION_SOURCE_PRODUCER_RESOURCE_TEMPLATE
      Template used to denote federation producers on the source in the server management registry. Since policy names are unique on the local broker AMQP federation configuration these names should not collide as each policy will create only one producer for a given address or queue.
      See Also:

    • FEDERATION_TARGET_RESOURCE_TEMPLATE

      public static final String FEDERATION_TARGET_RESOURCE_TEMPLATE
      Template used to denote federation source instances in the server management registry.
      See Also:

    • FEDERATION_TARGET_POLICY_RESOURCE_TEMPLATE

      public static final String FEDERATION_TARGET_POLICY_RESOURCE_TEMPLATE
      Template used to denote federation policy managers created on the source in the server management registry.
      See Also:

    • FEDERATION_TARGET_CONSUMER_RESOURCE_TEMPLATE

      public static final String FEDERATION_TARGET_CONSUMER_RESOURCE_TEMPLATE
      Template used to denote federation consumers on the source in the server management registry. Since policy names are unique on the local broker AMQP federation configuration these names should not collide as each policy will create only one consumer for a given address or queue.
      See Also:

    • FEDERATION_TARGET_PRODUCER_RESOURCE_TEMPLATE

      public static final String FEDERATION_TARGET_PRODUCER_RESOURCE_TEMPLATE
      Template used to denote federation producers on the source in the server management registry. Since policy names are unique on the local broker AMQP federation configuration these names should not collide as each policy will create only one producer for a given address or queue.
      See Also:

    • FEDERATION_NAME_TEMPLATE

      public static final String FEDERATION_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation policy control elements.
      See Also:

    • FEDERATION_POLICY_NAME_TEMPLATE

      public static final String FEDERATION_POLICY_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation policy control elements.
      See Also:

    • FEDERATION_QUEUE_CONSUMER_NAME_TEMPLATE

      public static final String FEDERATION_QUEUE_CONSUMER_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation queue consumer control elements.
      See Also:

    • FEDERATION_ADDRESS_CONSUMER_NAME_TEMPLATE

      public static final String FEDERATION_ADDRESS_CONSUMER_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation address consumer control elements.
      See Also:

    • FEDERATION_QUEUE_PRODUCER_NAME_TEMPLATE

      public static final String FEDERATION_QUEUE_PRODUCER_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation queue producer control elements.
      See Also:

    • FEDERATION_ADDRESS_PRODUCER_NAME_TEMPLATE

      public static final String FEDERATION_ADDRESS_PRODUCER_NAME_TEMPLATE
      The template used to create the object name suffix that is appending to the broker connection object name when adding and removing AMQP federation address producer control elements.
      See Also:

  • Constructor Details

    • AMQPFederationManagementSupport

      public AMQPFederationManagementSupport()

  • Method Details

    • registerFederationSource

      public static void registerFederationSource(AMQPFederationSource federation) throws Exception
      Register the given AMQPFederationSource instance with the broker management services.
      Parameters:
      federation - The federation source instance being registered with management.
      Throws:
      Exception - if an error occurs while registering the federation with the management services.

    • unregisterFederationSource

      public static void unregisterFederationSource(AMQPFederationSource federation) throws Exception
      Unregister the given AMQPFederationSource instance with the broker management services.
      Parameters:
      federation - The federation source instance being unregistered from management.
      Throws:
      Exception - if an error occurs while unregistering the federation with the management services.

    • getFederationSourceResourceName

      public static String getFederationSourceResourceName(String brokerConnectionName, String federationName)

    • getFederationSourceObjectName

      public static ObjectName getFederationSourceObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName) throws Exception
      Throws:
      Exception

    • registerFederationTarget

      public static void registerFederationTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationTarget federation) throws Exception
      Register the given AMQPFederationTarget instance with the broker management services.
      Parameters:
      federation - The federation target instance being registered with management.
      Throws:
      Exception - if an error occurs while registering the federation with the management services.

    • unregisterFederationTarget

      public static void unregisterFederationTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationTarget federation) throws Exception
      Unregister the given AMQPFederationTarget instance with the broker management services.
      Parameters:
      federation - The federation target instance being unregistered from management.
      Throws:
      Exception - if an error occurs while unregistering the federation with the management services.

    • getFederationTargetResourceName

      public static String getFederationTargetResourceName(String remoteNodeId, String brokerConnectionName, String federationName)

    • getFederationTargetObjectName

      public static ObjectName getFederationTargetObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName) throws Exception
      Throws:
      Exception

    • registerLocalPolicyOnSource

      public static void registerLocalPolicyOnSource(String brokerConnectionName, AMQPFederationLocalPolicyManager manager) throws Exception
      Register a local federation policy manager with the server management services for a federation source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the manager being registered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the manager with the management services.

    • unregisterLocalPolicyOnSource

      public static void unregisterLocalPolicyOnSource(String brokerConnectionName, AMQPFederationLocalPolicyManager manager) throws Exception
      Unregister a local federation policy manager with the server management services for a federation source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the manager being unregistered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while unregistering the manager with the management services.

    • registerRemotePolicyOnSource

      public static void registerRemotePolicyOnSource(String brokerConnectionName, AMQPFederationRemotePolicyManager manager) throws Exception
      Register a remote federation policy manager with the server management services for a federation source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the manager being registered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the manager with the management services.

    • unregisterRemotePolicyOnSource

      public static void unregisterRemotePolicyOnSource(String brokerConnectionName, AMQPFederationRemotePolicyManager manager) throws Exception
      Unregister a remote federation policy manager with the server management services for a federation source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the manager being unregistered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while unregistering the manager with the management services.

    • getFederationSourcePolicyResourceName

      public static String getFederationSourcePolicyResourceName(String brokerConnectionName, String federationName, String policyName)

    • getFederationSourcePolicyObjectName

      public static ObjectName getFederationSourcePolicyObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName, String policyType, String policyName) throws Exception
      Throws:
      Exception

    • registerLocalPolicyOnTarget

      public static void registerLocalPolicyOnTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationLocalPolicyManager manager) throws Exception
      Register a local federation policy manager with the server management services for a federation target.
      Parameters:
      remoteNodeId - The remote broker node ID that is the source of the federation operations.
      brokerConnectionName - The name of the remote broker connection that owns the manager being registered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the manager with the management services.

    • unregisterLocalPolicyOnTarget

      public static void unregisterLocalPolicyOnTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationLocalPolicyManager manager) throws Exception
      Unregister a local federation policy manager with the server management services for a federation target.
      Parameters:
      remoteNodeId - The remote broker node ID that is the source of the federation operations.
      brokerConnectionName - The name of the remote broker connection that owns the manager being unregistered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while unregistering the manager with the management services.

    • registerRemotePolicyOnTarget

      public static void registerRemotePolicyOnTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationRemotePolicyManager manager) throws Exception
      Register a remote federation policy manager with the server management services for a federation target.
      Parameters:
      remoteNodeId - The remote broker node ID that is the source of the federation operations.
      brokerConnectionName - The name of the remote broker connection that owns the manager being registered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the manager with the management services.

    • unregisterRemotePolicyOnTarget

      public static void unregisterRemotePolicyOnTarget(String remoteNodeId, String brokerConnectionName, AMQPFederationRemotePolicyManager manager) throws Exception
      Unregister a remote federation policy manager with the server management services for a federation target.
      Parameters:
      remoteNodeId - The remote broker node ID that is the source of the federation operations.
      brokerConnectionName - The name of the remote broker connection that owns the manager being unregistered.
      manager - The AMQP federation policy manager instance that is being managed.
      Throws:
      Exception - if an error occurs while unregistering the manager with the management services.

    • getFederationTargetPolicyResourceName

      public static String getFederationTargetPolicyResourceName(String remoteNodeId, String brokerConnectionName, String federationName, String policyName)

    • getFederationTargetPolicyObjectName

      public static ObjectName getFederationTargetPolicyObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName, String policyType, String policyName) throws Exception
      Throws:
      Exception

    • registerFederationSourceConsumer

      public static void registerFederationSourceConsumer(String brokerConnectionName, AMQPFederationConsumer consumer) throws Exception
      Registers the federation consumer with the server management services on the source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the consumer being registered.
      consumer - The AMQP federation consumer instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the consumer with the management services.

    • unregisterFederationSourceConsumer

      public static void unregisterFederationSourceConsumer(String brokerConnectionName, AMQPFederationConsumer consumer) throws Exception
      Unregisters the federation consumer with the server management services on the source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the consumer being registered.
      consumer - The AMQP federation consumer instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the consumer with the management services.

    • registerFederationSourceProducer

      public static void registerFederationSourceProducer(String brokerConnectionName, AMQPFederationSenderController sender) throws Exception
      Registers the federation producer with the server management services on the source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the producer being registered.
      sender - The AMQP federation sender controller that manages the federation producer.
      Throws:
      Exception - if an error occurs while registering the producer with the management services.

    • unregisterFederationSourceProducer

      public static void unregisterFederationSourceProducer(String brokerConnectionName, AMQPFederationSenderController sender) throws Exception
      Unregisters the federation producer with the server management services on the source.
      Parameters:
      brokerConnectionName - The name of the broker connection that owns the producer being registered.
      sender - The AMQP federation sender controller that manages the federation producer.
      Throws:
      Exception - if an error occurs while registering the producer with the management services.

    • getFederationSourceAddressConsumerResourceName

      public static String getFederationSourceAddressConsumerResourceName(String brokerConnectionName, String federationName, String policyName, String address)

    • getFederationSourceQueueConsumerResourceName

      public static String getFederationSourceQueueConsumerResourceName(String brokerConnectionName, String federationName, String policyName, String fqqn)

    • getFederationSourceAddressProducerResourceName

      public static String getFederationSourceAddressProducerResourceName(String brokerConnectionName, String federationName, String policyName, String address)

    • getFederationSourceQueueProducerResourceName

      public static String getFederationSourceQueueProducerResourceName(String brokerConnectionName, String federationName, String policyName, String fqqn)

    • getFederationSourceAddressConsumerObjectName

      public static ObjectName getFederationSourceAddressConsumerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName, String policyType, String policyName, String address) throws Exception
      Throws:
      Exception

    • getFederationSourceAddressProducerObjectName

      public static ObjectName getFederationSourceAddressProducerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName, String policyType, String policyName, String address) throws Exception
      Throws:
      Exception

    • getFederationSourceQueueConsumerObjectName

      public static ObjectName getFederationSourceQueueConsumerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName, String policyType, String policyName, String fqqn) throws Exception
      Throws:
      Exception

    • getFederationSourceQueueProducerObjectName

      public static ObjectName getFederationSourceQueueProducerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String brokerConnection, String federationName, String policyType, String policyName, String fqqn) throws Exception
      Throws:
      Exception

    • registerFederationTargetConsumer

      public static void registerFederationTargetConsumer(String remoteNodeId, String brokerConnectionName, AMQPFederationConsumer consumer) throws Exception
      Registers the federation consumer with the server management services on the target.
      Parameters:
      brokerConnectionName - The name of the remote broker connection that owns the consumer being registered.
      consumer - The AMQP federation consumer instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the consumer with the management services.

    • unregisterFederationTargetConsumer

      public static void unregisterFederationTargetConsumer(String remoteNodeId, String brokerConnectionName, AMQPFederationConsumer consumer) throws Exception
      Unregisters the federation consumer with the server management services on the target.
      Parameters:
      brokerConnectionName - The name of the remote broker connection that owns the consumer being registered.
      consumer - The AMQP federation consumer instance that is being managed.
      Throws:
      Exception - if an error occurs while registering the consumer with the management services.

    • registerFederationTargetProducer

      public static void registerFederationTargetProducer(String remoteNodeId, String brokerConnectionName, AMQPFederationSenderController sender) throws Exception
      Registers the federation producer with the server management services on the target.
      Parameters:
      brokerConnectionName - The name of the remote broker connection that owns the producer being registered.
      sender - The AMQP federation sender controller that manages the federation producer.
      Throws:
      Exception - if an error occurs while registering the producer with the management services.

    • unregisterFederationTargetProducer

      public static void unregisterFederationTargetProducer(String remoteNodeId, String brokerConnectionName, AMQPFederationSenderController sender) throws Exception
      Unregisters the federation producer with the server management services on the target.
      Parameters:
      brokerConnectionName - The name of the remote broker connection that owns the producer being registered.
      sender - The AMQP federation sender controller that manages the federation producer.
      Throws:
      Exception - if an error occurs while registering the producer with the management services.

    • getFederationTargetAddressConsumerResourceName

      public static String getFederationTargetAddressConsumerResourceName(String remoteNodeId, String brokerConnectionName, String federationName, String policyName, String address)

    • getFederationTargetQueueConsumerResourceName

      public static String getFederationTargetQueueConsumerResourceName(String remoteNodeId, String brokerConnectionName, String federationName, String policyName, String fqqn)

    • getFederationTargetAddressProducerResourceName

      public static String getFederationTargetAddressProducerResourceName(String remoteNodeId, String brokerConnectionName, String federationName, String policyName, String address)

    • getFederationTargetQueueProducerResourceName

      public static String getFederationTargetQueueProducerResourceName(String remoteNodeId, String brokerConnectionName, String federationName, String policyName, String fqqn)

    • getFederationTargetAddressConsumerObjectName

      public static ObjectName getFederationTargetAddressConsumerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName, String policyType, String policyName, String address) throws Exception
      Throws:
      Exception

    • getFederationTargetAddressProducerObjectName

      public static ObjectName getFederationTargetAddressProducerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName, String policyType, String policyName, String address) throws Exception
      Throws:
      Exception

    • getFederationTargetQueueConsumerObjectName

      public static ObjectName getFederationTargetQueueConsumerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName, String policyType, String policyName, String fqqn) throws Exception
      Throws:
      Exception

    • getFederationTargetQueueProducerObjectName

      public static ObjectName getFederationTargetQueueProducerObjectName(org.apache.activemq.artemis.core.server.management.ManagementService management, String remoteNodeId, String brokerConnection, String federationName, String policyType, String policyName, String fqqn) throws Exception
      Throws:
      Exception