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

Class AMQPFederationQueueConsumer

java.lang.Object

org.apache.activemq.artemis.protocol.amqp.connect.federation.AMQPFederationQueueConsumer

All Implemented Interfaces:

FederationConsumer, FederationConsumerInternal

public class AMQPFederationQueueConsumer
extends Object
implements FederationConsumerInternal

Consumer implementation for Federated Queues that receives from a remote AMQP peer and forwards those messages onto the internal broker Queue for consumption by an attached resource.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PENDING_MSG_CHECK_BACKOFF_MULTIPLIER
static int	DEFAULT_PENDING_MSG_CHECK_MAX_DELAY
static int	DEFAULT_PULL_CREDIT_BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
AMQPFederationQueueConsumer(AMQPFederation federation, AMQPFederationConsumerConfiguration configuration, AMQPSessionContext session, FederationConsumerInfo consumerInfo, FederationReceiveFromQueuePolicy policy)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the federation consumer instance and cleans up its resources.
FederationConsumerInfo	getConsumerInfo()
Federation	getFederation()
FederationReceiveFromQueuePolicy	getPolicy()
protected boolean	remoteLinkClosedIntercepter(org.apache.qpid.proton.engine.Link link)
AMQPFederationQueueConsumer	setRemoteClosedHandler(Consumer<FederationConsumerInternal> handler)	Provides and event point for notification of the consumer having been closed by the remote.
void	start()	Starts the consumer instance which includes creating the remote resources and performing any internal initialization needed to fully establish the consumer instance.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PULL_CREDIT_BATCH_SIZE

public static final int DEFAULT_PULL_CREDIT_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_PENDING_MSG_CHECK_BACKOFF_MULTIPLIER

public static final int DEFAULT_PENDING_MSG_CHECK_BACKOFF_MULTIPLIER

See Also:

Constant Field Values

DEFAULT_PENDING_MSG_CHECK_MAX_DELAY

public static final int DEFAULT_PENDING_MSG_CHECK_MAX_DELAY

See Also:

Constant Field Values

Constructor Detail

AMQPFederationQueueConsumer

public AMQPFederationQueueConsumer(AMQPFederation federation,
                                   AMQPFederationConsumerConfiguration configuration,
                                   AMQPSessionContext session,
                                   FederationConsumerInfo consumerInfo,
                                   FederationReceiveFromQueuePolicy policy)

Method Detail

getFederation

public Federation getFederation()

Specified by:

getFederation in interface FederationConsumer

Returns:

the Federation that this consumer operates under.

getConsumerInfo

public FederationConsumerInfo getConsumerInfo()

Specified by:

getConsumerInfo in interface FederationConsumer

Returns:

an information object that defines the characteristics of the FederationConsumer

getPolicy

public FederationReceiveFromQueuePolicy getPolicy()

Returns:

the FederationReceiveFromQueuePolicy that initiated this consumer.

start

public void start()

Description copied from interface: FederationConsumerInternal

Starts the consumer instance which includes creating the remote resources and performing any internal initialization needed to fully establish the consumer instance. This call should not block and any errors encountered on creation of the backing consumer resources should utilize the error handling mechanisms of this Federation instance.

Specified by:

start in interface FederationConsumerInternal

close

public void close()

Description copied from interface: FederationConsumerInternal

Close the federation consumer instance and cleans up its resources. This method should not block and the actual resource shutdown work should occur asynchronously.

Specified by:

close in interface FederationConsumerInternal

setRemoteClosedHandler

public AMQPFederationQueueConsumer setRemoteClosedHandler(Consumer<FederationConsumerInternal> handler)

Description copied from interface: FederationConsumerInternal

Provides and event point for notification of the consumer having been closed by the remote.

Specified by:

setRemoteClosedHandler in interface FederationConsumerInternal

Parameters:

handler - The handler that will be invoked when the remote closes this consumer.

Returns:

this consumer instance.

remoteLinkClosedIntercepter

protected boolean remoteLinkClosedIntercepter(org.apache.qpid.proton.engine.Link link)