Package org.apache.activemq.artemis.protocol.amqp.federation

Interface FederationConsumerInfo

All Known Implementing Classes:

FederationGenericConsumerInfo

public interface FederationConsumerInfo

Information and identification interface for Federation consumers that will be created on the remote broker as demand on the local broker is detected. The behavior and meaning of some APIs in this interface may vary slightly depending on the role of the consumer (Address or Queue).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FederationConsumerInfo.Role

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Gets the address that will be used for this federation consumer instance.
String	getFilterString()	Gets the filter string that will be used when creating the remote consumer.
String	getFqqn()	Gets the FQQN that comprises the address and queue where the remote consumer will be attached.
String	getId()
int	getPriority()	Gets the priority value that will be requested for the remote consumer that is created.
String	getQueueName()	Gets the queue name that will be used for this federation consumer instance.
FederationConsumerInfo.Role	getRole()
RoutingType	getRoutingType()	Gets the routing type that will be requested when creating a consumer on the remote server.

Method Detail

getId

String getId()

Returns:

a unique Id for the consumer being represented.

getRole

FederationConsumerInfo.Role getRole()

Returns:

the type of federation consumer being represented.

getQueueName

String getQueueName()

Gets the queue name that will be used for this federation consumer instance. For Queue federation this will be the name of the queue whose messages are being federated to this server instance. For an Address federation this will be an automatically generated name that should be unique to a given federation instance

Returns:

the queue name associated with the federation consumer

getAddress

String getAddress()

Gets the address that will be used for this federation consumer instance. For Queue federation this is the address under which the matching queue must reside. For Address federation this is the actual address whose messages are being federated.

Returns:

the address associated with this federation consumer.

getFqqn

String getFqqn()

Gets the FQQN that comprises the address and queue where the remote consumer will be attached.

Returns:

provides the FQQN that can be used to address the consumer queue directly.

getRoutingType

RoutingType getRoutingType()

Gets the routing type that will be requested when creating a consumer on the remote server.

Returns:

the routing type of the remote consumer.

getFilterString

String getFilterString()

Gets the filter string that will be used when creating the remote consumer. For Queue federation this will be the filter that exists on the local queue that is requesting federation of messages from the remote. For address federation this filter will be used to restrict some movement of messages amongst federated server addresses.

Returns:

the filter string in use for the federation consumer.

getPriority

int getPriority()

Gets the priority value that will be requested for the remote consumer that is created.

Returns:

the assigned consumer priority for the federation consumer.