java.lang.Object
- org.apache.activemq.artemis.protocol.amqp.connect.federation.AMQPFederationConstants

```
public final class AMQPFederationConstants
extends Object
```
Constants class for values used in the AMQP Federation implementation.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADD_ADDRESS_POLICY`	Indicates that the message carries a federation address match policy that should be added to the remote for reverse federation of matching queue from the remote peer.
`static String`	`ADD_QUEUE_POLICY`	Indicates that the message carries a federation queue match policy that should be added to the remote for reverse federation of matching queue from the remote peer.
`static String`	`ADDRESS_AUTO_DELETE`	Encodes a boolean value that indicates if queue auto delete option should be enabled.
`static String`	`ADDRESS_AUTO_DELETE_DELAY`	Encodes a signed long value that controls the delay before auto deletion if auto delete is enabled.
`static String`	`ADDRESS_AUTO_DELETE_MSG_COUNT`	Encodes a signed long value that controls the message count value that allows for address auto delete.
`static String`	`ADDRESS_ENABLE_DIVERT_BINDINGS`	Encodes boolean value that controls if the address federation should include divert bindings.
`static String`	`ADDRESS_EXCLUDES`	Address policy excludes are encoded as a `List` of string entries when configured.
`static String`	`ADDRESS_INCLUDES`	Address policy includes are encoded as a `List` of string entries when configured.
`static String`	`ADDRESS_MAX_HOPS`	Encodes a signed integer value that controls the maximum number of hops allowed for federated messages.
`static org.apache.qpid.proton.amqp.Symbol`	`EVENT_TYPE`	Events sent across the events link will each carry an event type to indicate the event type which controls how the remote reacts to the given event.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_ADDRESS_RECEIVER`	A desired capability added to the federation address receiver link that must be offered in return for a federation address receiver to be successfully opened.
`static String`	`FEDERATION_BASE_VALIDATION_ADDRESS`	Address used by a remote broker instance to validate that an incoming federation connection has access rights to perform federation operations.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_CONFIGURATION`	Property name used to embed a nested map of properties meant to be applied if the federation resources created on the remote end of the control link if configured to do so.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_CONTROL_LINK`	A desired capability added to the federation control link that must be offered in return for a federation connection to be successfully established.
`static String`	`FEDERATION_CONTROL_LINK_PREFIX`	The prefix value added when creating a federation control link beyond the initial portion of the validation address prefix.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_EVENT_LINK`	A desired capability added to the federation events links that must be offered in return for a federation event link to be successfully established.
`static String`	`FEDERATION_EVENTS_LINK_PREFIX`	The prefix value added when creating a federation events links beyond the initial portion of the validation address prefix.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_QUEUE_RECEIVER`	A desired capability added to the federation queue receiver link that must be offered in return for a federation queue receiver to be successfully opened.
`static org.apache.qpid.proton.amqp.Symbol`	`FEDERATION_RECEIVER_PRIORITY`	Property added to the receiver properties when opening an AMQP federation address or queue consumer that indicates the consumer priority that should be used when creating the remote consumer.
`static String`	`IGNORE_QUEUE_CONSUMER_FILTERS`	Configuration property used to convey the local side value to use when considering if federation queue consumers should filter using the filters defined on individual queue subscriptions, this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
`static String`	`IGNORE_QUEUE_CONSUMER_PRIORITIES`	Configuration property used to convey the local side value to use when considering if federation queue consumers should apply a consumer priority offset based on the subscription priority or should use a singular priority offset based on policy configuration.
`static String`	`LARGE_MESSAGE_THRESHOLD`	Configuration property used to convey the local side value to use when considering if a message is a large message, this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
`static String`	`LINK_ATTACH_TIMEOUT`	Property value that can be applied to federation configuration that controls the timeout value for a link attach to complete before the attach attempt is considered to have failed.
`static org.apache.qpid.proton.amqp.Symbol`	`OPERATION_TYPE`	Commands sent across the control link will each carry an operation type to indicate the desired action the remote should take upon receipt of the command.
`static String`	`POLICY_NAME`	Both Queue and Address policies carry a unique name that will always be encoded.
`static String`	`POLICY_PROPERTIES_MAP`	Encodes a `Map` of String keys and values that are carried along in the federation policy (address or queue).
`static String`	`PULL_RECEIVER_BATCH_SIZE`	Configuration property that defines the amount of credits to batch to an AMQP receiver link and the top up value when sending more credit once the broker has capacity available for them.
`static String`	`QUEUE_EXCLUDES`	Queue policy excludes are encoded as a `List` of flattened key / value pairs when configured.
`static String`	`QUEUE_INCLUDE_FEDERATED`	Encodes a boolean value that indicates if the include federation option should be enabled.
`static String`	`QUEUE_INCLUDES`	Queue policy includes are encoded as a `List` of flattened key / value pairs when configured.
`static String`	`QUEUE_PRIORITY_ADJUSTMENT`	Encodes a signed integer value that adjusts the priority of the any created queue receivers.
`static String`	`RECEIVER_CREDITS`	Configuration property that defines the amount of credits to batch to an AMQP receiver link and the top up limit when sending more credit once the credits are determined to be running low.
`static String`	`RECEIVER_CREDITS_LOW`	A low water mark for receiver credits that indicates more should be sent to top it up to the original credit batch size.
`static String`	`REQUESTED_ADDRESS_ADDED`	Indicates that the message carries an address name that was previously requested but did not exist, or that was federated but the remote consumer was closed due to removal of the address on the target peer.
`static String`	`REQUESTED_ADDRESS_NAME`	Carries the name of an Address that was either not present when a federation consumer was initiated and subsequently rejected, or was removed and has been recreated.
`static String`	`REQUESTED_QUEUE_ADDED`	Indicates that the message carries an address and queue name that was previously requested but did not exist, or that was federated but the remote consumer was closed due to removal of the queue on the target peer.
`static String`	`REQUESTED_QUEUE_NAME`	Carries the name of a Queue that was either not present when a federation consumer was initiated and subsequently rejected, or was removed and has been recreated.
`static String`	`TRANSFORMER_CLASS_NAME`	Encodes a string value carrying the name of the `Transformer` class to use.
`static String`	`TRANSFORMER_PROPERTIES_MAP`	Encodes a `Map` of String keys and values that are applied to the transformer configuration for the policy.

Constructor Summary

Constructors
Constructor Description

AMQPFederationConstants()

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FEDERATION_BASE_VALIDATION_ADDRESS
```
public static final String FEDERATION_BASE_VALIDATION_ADDRESS
```
    Address used by a remote broker instance to validate that an incoming federation connection has access rights to perform federation operations. The user that connects to the AMQP federation endpoint and attempts to create the control link must have write access to this address and any address prefixed by this value. When securing a federation user account the user must have read and write permissions to addresses under this prefix using the broker defined delimiter, this include the ability to create non-durable resources.
    $ACTIVEMQ_ARTEMIS_FEDERATION.#;
    See Also:
    
    Constant Field Values
  - FEDERATION_CONTROL_LINK_PREFIX
```
public static final String FEDERATION_CONTROL_LINK_PREFIX
```
    The prefix value added when creating a federation control link beyond the initial portion of the validation address prefix. Links for command and control of federation operations follow the form:
    $ACTIVEMQ_ARTEMIS_FEDERATION.control.<unique-id>
    See Also:
    
    Constant Field Values
  - FEDERATION_EVENTS_LINK_PREFIX
```
public static final String FEDERATION_EVENTS_LINK_PREFIX
```
    The prefix value added when creating a federation events links beyond the initial portion of the validation address prefix. Links for federation events follow the form:
    $ACTIVEMQ_ARTEMIS_FEDERATION.events.<unique-id>
    See Also:
    
    Constant Field Values
  - FEDERATION_CONTROL_LINK
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_CONTROL_LINK
```
    A desired capability added to the federation control link that must be offered in return for a federation connection to be successfully established.
  - FEDERATION_EVENT_LINK
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_EVENT_LINK
```
    A desired capability added to the federation events links that must be offered in return for a federation event link to be successfully established.
  - FEDERATION_CONFIGURATION
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_CONFIGURATION
```
    Property name used to embed a nested map of properties meant to be applied if the federation resources created on the remote end of the control link if configured to do so. These properties essentially carry local configuration to the remote side that would otherwise use broker defaults and not match behaviors of resources created on the local side of the connection.
  - LINK_ATTACH_TIMEOUT
```
public static final String LINK_ATTACH_TIMEOUT
```
    Property value that can be applied to federation configuration that controls the timeout value for a link attach to complete before the attach attempt is considered to have failed. The value is configured in seconds (default is 30 seconds).
    
    See Also:
    
    Constant Field Values
  - RECEIVER_CREDITS
```
public static final String RECEIVER_CREDITS
```
    Configuration property that defines the amount of credits to batch to an AMQP receiver link and the top up limit when sending more credit once the credits are determined to be running low. this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
    
    See Also:
    
    Constant Field Values
  - RECEIVER_CREDITS_LOW
```
public static final String RECEIVER_CREDITS_LOW
```
    A low water mark for receiver credits that indicates more should be sent to top it up to the original credit batch size. this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
    
    See Also:
    
    Constant Field Values
  - PULL_RECEIVER_BATCH_SIZE
```
public static final String PULL_RECEIVER_BATCH_SIZE
```
    Configuration property that defines the amount of credits to batch to an AMQP receiver link and the top up value when sending more credit once the broker has capacity available for them. this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
    
    See Also:
    
    Constant Field Values
  - LARGE_MESSAGE_THRESHOLD
```
public static final String LARGE_MESSAGE_THRESHOLD
```
    Configuration property used to convey the local side value to use when considering if a message is a large message, this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection.
    
    See Also:
    
    Constant Field Values
  - IGNORE_QUEUE_CONSUMER_FILTERS
```
public static final String IGNORE_QUEUE_CONSUMER_FILTERS
```
    Configuration property used to convey the local side value to use when considering if federation queue consumers should filter using the filters defined on individual queue subscriptions, this can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection. This can be used to prevent multiple subscriptions on the same queue based on local demand with differing subscription filters but does imply that message that don't match those filters would be federated to the local broker.
    
    See Also:
    
    Constant Field Values
  - IGNORE_QUEUE_CONSUMER_PRIORITIES
```
public static final String IGNORE_QUEUE_CONSUMER_PRIORITIES
```
    Configuration property used to convey the local side value to use when considering if federation queue consumers should apply a consumer priority offset based on the subscription priority or should use a singular priority offset based on policy configuration. This can be sent to the peer so that dual federation configurations share the same configuration on both sides of the connection. This can be used to prevent multiple subscriptions on the same queue based on local demand with differing consumer priorities but does imply that care needs to be taken to ensure remote consumers would normally have a higher priority value than the configured default priority offset.
    
    See Also:
    
    Constant Field Values
  - FEDERATION_QUEUE_RECEIVER
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_QUEUE_RECEIVER
```
    A desired capability added to the federation queue receiver link that must be offered in return for a federation queue receiver to be successfully opened. On the remote the presence of this capability indicates that the matching queue should be present on the remote and its absence constitutes a failure that should result in the attach request being failed.
  - FEDERATION_ADDRESS_RECEIVER
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_ADDRESS_RECEIVER
```
    A desired capability added to the federation address receiver link that must be offered in return for a federation address receiver to be successfully opened.
  - FEDERATION_RECEIVER_PRIORITY
```
public static final org.apache.qpid.proton.amqp.Symbol FEDERATION_RECEIVER_PRIORITY
```
    Property added to the receiver properties when opening an AMQP federation address or queue consumer that indicates the consumer priority that should be used when creating the remote consumer. The value assign to the properties Map is a signed integer value.
  - OPERATION_TYPE
```
public static final org.apache.qpid.proton.amqp.Symbol OPERATION_TYPE
```
    Commands sent across the control link will each carry an operation type to indicate the desired action the remote should take upon receipt of the command. The type of command infers the payload of the structure of the message payload.
  - ADD_QUEUE_POLICY
```
public static final String ADD_QUEUE_POLICY
```
    Indicates that the message carries a federation queue match policy that should be added to the remote for reverse federation of matching queue from the remote peer.
    
    See Also:
    
    Constant Field Values
  - ADD_ADDRESS_POLICY
```
public static final String ADD_ADDRESS_POLICY
```
    Indicates that the message carries a federation address match policy that should be added to the remote for reverse federation of matching queue from the remote peer.
    
    See Also:
    
    Constant Field Values
  - POLICY_NAME
```
public static final String POLICY_NAME
```
    Both Queue and Address policies carry a unique name that will always be encoded.
    
    See Also:
    
    Constant Field Values
  - QUEUE_INCLUDES
```
public static final String QUEUE_INCLUDES
```
    Queue policy includes are encoded as a List of flattened key / value pairs when configured.
    
    See Also:
    
    Constant Field Values
  - QUEUE_EXCLUDES
```
public static final String QUEUE_EXCLUDES
```
    Queue policy excludes are encoded as a List of flattened key / value pairs when configured.
    
    See Also:
    
    Constant Field Values
  - QUEUE_INCLUDE_FEDERATED
```
public static final String QUEUE_INCLUDE_FEDERATED
```
    Encodes a boolean value that indicates if the include federation option should be enabled.
    
    See Also:
    
    Constant Field Values
  - QUEUE_PRIORITY_ADJUSTMENT
```
public static final String QUEUE_PRIORITY_ADJUSTMENT
```
    Encodes a signed integer value that adjusts the priority of the any created queue receivers.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_INCLUDES
```
public static final String ADDRESS_INCLUDES
```
    Address policy includes are encoded as a List of string entries when configured.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_EXCLUDES
```
public static final String ADDRESS_EXCLUDES
```
    Address policy excludes are encoded as a List of string entries when configured.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_AUTO_DELETE
```
public static final String ADDRESS_AUTO_DELETE
```
    Encodes a boolean value that indicates if queue auto delete option should be enabled.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_AUTO_DELETE_DELAY
```
public static final String ADDRESS_AUTO_DELETE_DELAY
```
    Encodes a signed long value that controls the delay before auto deletion if auto delete is enabled.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_AUTO_DELETE_MSG_COUNT
```
public static final String ADDRESS_AUTO_DELETE_MSG_COUNT
```
    Encodes a signed long value that controls the message count value that allows for address auto delete.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_MAX_HOPS
```
public static final String ADDRESS_MAX_HOPS
```
    Encodes a signed integer value that controls the maximum number of hops allowed for federated messages.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_ENABLE_DIVERT_BINDINGS
```
public static final String ADDRESS_ENABLE_DIVERT_BINDINGS
```
    Encodes boolean value that controls if the address federation should include divert bindings.
    
    See Also:
    
    Constant Field Values
  - POLICY_PROPERTIES_MAP
```
public static final String POLICY_PROPERTIES_MAP
```
    Encodes a Map of String keys and values that are carried along in the federation policy (address or queue). These values can be used to add extended configuration to the policy object such as overriding settings from the connection URI.
    
    See Also:
    
    Constant Field Values
  - TRANSFORMER_CLASS_NAME
```
public static final String TRANSFORMER_CLASS_NAME
```
    Encodes a string value carrying the name of the Transformer class to use.
    
    See Also:
    
    Constant Field Values
  - TRANSFORMER_PROPERTIES_MAP
```
public static final String TRANSFORMER_PROPERTIES_MAP
```
    Encodes a Map of String keys and values that are applied to the transformer configuration for the policy.
    
    See Also:
    
    Constant Field Values
  - EVENT_TYPE
```
public static final org.apache.qpid.proton.amqp.Symbol EVENT_TYPE
```
    Events sent across the events link will each carry an event type to indicate the event type which controls how the remote reacts to the given event. The type of event infers the payload of the structure of the message payload.
  - REQUESTED_QUEUE_ADDED
```
public static final String REQUESTED_QUEUE_ADDED
```
    Indicates that the message carries an address and queue name that was previously requested but did not exist, or that was federated but the remote consumer was closed due to removal of the queue on the target peer.
    
    See Also:
    
    Constant Field Values
  - REQUESTED_ADDRESS_ADDED
```
public static final String REQUESTED_ADDRESS_ADDED
```
    Indicates that the message carries an address name that was previously requested but did not exist, or that was federated but the remote consumer was closed due to removal of the address on the target peer.
    
    See Also:
    
    Constant Field Values
  - REQUESTED_QUEUE_NAME
```
public static final String REQUESTED_QUEUE_NAME
```
    Carries the name of a Queue that was either not present when a federation consumer was initiated and subsequently rejected, or was removed and has been recreated.
    
    See Also:
    
    Constant Field Values
  - REQUESTED_ADDRESS_NAME
```
public static final String REQUESTED_ADDRESS_NAME
```
    Carries the name of an Address that was either not present when a federation consumer was initiated and subsequently rejected, or was removed and has been recreated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AMQPFederationConstants
```
public AMQPFederationConstants()
```

Class AMQPFederationConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FEDERATION_BASE_VALIDATION_ADDRESS

FEDERATION_CONTROL_LINK_PREFIX

FEDERATION_EVENTS_LINK_PREFIX

FEDERATION_CONTROL_LINK

FEDERATION_EVENT_LINK

FEDERATION_CONFIGURATION

LINK_ATTACH_TIMEOUT

RECEIVER_CREDITS

RECEIVER_CREDITS_LOW

PULL_RECEIVER_BATCH_SIZE

LARGE_MESSAGE_THRESHOLD

IGNORE_QUEUE_CONSUMER_FILTERS

IGNORE_QUEUE_CONSUMER_PRIORITIES

FEDERATION_QUEUE_RECEIVER

FEDERATION_ADDRESS_RECEIVER

FEDERATION_RECEIVER_PRIORITY

OPERATION_TYPE

ADD_QUEUE_POLICY

ADD_ADDRESS_POLICY

POLICY_NAME

QUEUE_INCLUDES

QUEUE_EXCLUDES

QUEUE_INCLUDE_FEDERATED

QUEUE_PRIORITY_ADJUSTMENT

ADDRESS_INCLUDES

ADDRESS_EXCLUDES

ADDRESS_AUTO_DELETE

ADDRESS_AUTO_DELETE_DELAY

ADDRESS_AUTO_DELETE_MSG_COUNT

ADDRESS_MAX_HOPS

ADDRESS_ENABLE_DIVERT_BINDINGS

POLICY_PROPERTIES_MAP

TRANSFORMER_CLASS_NAME

TRANSFORMER_PROPERTIES_MAP

EVENT_TYPE

REQUESTED_QUEUE_ADDED

REQUESTED_ADDRESS_ADDED

REQUESTED_QUEUE_NAME

REQUESTED_ADDRESS_NAME

Constructor Detail

AMQPFederationConstants