Package com.rabbitmq.client.amqp

Interface ConsumerBuilder

public interface ConsumerBuilder

API to configure and create a Consumer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConsumerBuilder.FilterOptions<T>	Filter options for support of AMQP filter expressions.
static interface	ConsumerBuilder.StreamFilterOptions	Filter options for support of AMQP filter expressions.
static enum	ConsumerBuilder.StreamOffsetSpecification	Offset specification to start consuming from.
static interface	ConsumerBuilder.StreamOptions	Options for a consumer consuming from a stream.
static interface	ConsumerBuilder.SubscriptionListener	Callback to modify a consumer subscription before the link creation.

Method Summary

Modifier and Type	Method	Description
Consumer	build()	Build the consumer.
ConsumerBuilder	initialCredits(int initialCredits)	The initial number credits to grant to the AMQP receiver.
ConsumerBuilder	listeners(Resource.StateListener... listeners)	Add Resource.StateListeners to the consumer.
ConsumerBuilder	messageHandler(Consumer.MessageHandler handler)	The callback for inbound messages.
ConsumerBuilder	priority(int priority)	The consumer priority.
ConsumerBuilder	queue(String queue)	The queue to consume from.
ConsumerBuilder.StreamOptions	stream()	Options for a consumer consuming from a stream.
ConsumerBuilder	subscriptionListener(ConsumerBuilder.SubscriptionListener subscriptionListener)	Set a listener to customize the subscription before the consumer is created (or recovered).

Method Details

queue

ConsumerBuilder queue(String queue)

The queue to consume from.

Parameters:

queue - queue

Returns:

this builder instance

messageHandler

ConsumerBuilder messageHandler(Consumer.MessageHandler handler)

The callback for inbound messages.

Parameters:

handler - callback

Returns:

this builder instance

initialCredits

ConsumerBuilder initialCredits(int initialCredits)

The initial number credits to grant to the AMQP receiver.

The default is 100.

Parameters:

initialCredits - number of initial credits

Returns:

this buidler instance

priority

ConsumerBuilder priority(int priority)

The consumer priority.

Parameters:

priority - consumer priority

Returns:

this builder instance

See Also:

• Consumer Priorities

listeners

ConsumerBuilder listeners(Resource.StateListener... listeners)

Add Resource.StateListeners to the consumer.

Parameters:

listeners - listeners

Returns:

this builder instance

stream

ConsumerBuilder.StreamOptions stream()

Options for a consumer consuming from a stream.

Returns:

stream options

See Also:

• Streams
• Stream Consumers

subscriptionListener

ConsumerBuilder subscriptionListener(ConsumerBuilder.SubscriptionListener subscriptionListener)

Set a listener to customize the subscription before the consumer is created (or recovered).

This callback is available for stream consumers.

Parameters:

subscriptionListener - subscription listener

Returns:

this builder instance

See Also:

• ConsumerBuilder.SubscriptionListener

build

Consumer build()

Build the consumer.

Returns:

the configured consumer instance