Class AmqpClient.Builder

java.lang.Object

org.springframework.amqp.client.AmqpClient.Builder

Enclosing interface:

AmqpClient

public static class AmqpClient.Builder
extends Object

Since:

4.1

Author:

Artem Bilan

Method Summary

Modifier and Type	Method	Description
AmqpClient	build()	Build the AmqpClient instance based on the provided options.
AmqpClient.Builder	completionTimeout(Duration completionTimeout)	Set a duration for CompletableFuture.orTimeout(long, TimeUnit) on returns.
AmqpClient.Builder	defaultToAddress(String defaultToAddress)	Set the default target AMQP 1.0 address for the AmqpClient.sendToDefault(org.springframework.amqp.core.Message) and AmqpClient.send(Message) operations.
AmqpClient.Builder	messageConverter(MessageConverter messageConverter)	Set the MessageConverter for converting to/from message body.
AmqpClient.Builder	senderOptions(org.apache.qpid.protonj2.client.SenderOptions senderOptions)	Set the SenderOptions for an internal AMQP 1.0 Sender.
AmqpClient.Builder	taskExecutor(TaskExecutor taskExecutor)	Set the TaskExecutor for asynchronous operations.

Methods inherited from class java.lang.Object

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

Method Details

senderOptions

public AmqpClient.Builder senderOptions(org.apache.qpid.protonj2.client.SenderOptions senderOptions)

Set the SenderOptions for an internal AMQP 1.0 Sender.

Parameters:

senderOptions - to use.

Returns:

this builder.

completionTimeout

public AmqpClient.Builder completionTimeout(Duration completionTimeout)

Set a duration for CompletableFuture.orTimeout(long, TimeUnit) on returns. There is no CompletableFuture API like onTimeout() requested from the CompletableFuture.get(long, TimeUnit), but used in operations AMQP resources have to be closed eventually independently of the CompletableFuture fulfilment. Defaults to 1 minute.

Parameters:

completionTimeout - duration for future completions.

Returns:

this builder.

defaultToAddress

public AmqpClient.Builder defaultToAddress(String defaultToAddress)

Set the default target AMQP 1.0 address for the AmqpClient.sendToDefault(org.springframework.amqp.core.Message) and AmqpClient.send(Message) operations.

Parameters:

defaultToAddress - the target address to use as a convenient default.

Returns:

this builder.

messageConverter

public AmqpClient.Builder messageConverter(MessageConverter messageConverter)

Set the MessageConverter for converting to/from message body. For the AmqpClient.ReceiveSpec.receiveAndConvert(T...) with non-Object generic type, this converter has to be SmartMessageConverter.

Parameters:

messageConverter - the converter.

Returns:

this builder.

taskExecutor

public AmqpClient.Builder taskExecutor(TaskExecutor taskExecutor)

Set the TaskExecutor for asynchronous operations. A ThreadPoolExecutor with one core pool thread is used by default.

Parameters:

taskExecutor - the task executor.

Returns:

this builder.

build

public AmqpClient build()

Build the AmqpClient instance based on the provided options.

Returns:

the client instance.