Package io.awspring.cloud.sqs.operations

Class AbstractMessagingTemplate.AbstractMessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

java.lang.Object

io.awspring.cloud.sqs.operations.AbstractMessagingTemplate.AbstractMessagingTemplateOptions<O>

Type Parameters:

O - the options type for returning in the chained methods.

All Implemented Interfaces:

MessagingTemplateOptions<O>

Enclosing class:

AbstractMessagingTemplate<S>

protected abstract static class AbstractMessagingTemplate.AbstractMessagingTemplateOptions<O extends MessagingTemplateOptions<O>>
extends Object
implements MessagingTemplateOptions<O>

Base class for template options, to be extended by subclasses.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessagingTemplateOptions()

Method Summary

Modifier and Type	Method	Description
O	acknowledgementMode(TemplateAcknowledgementMode defaultAcknowledgementMode)	Set the acknowledgement mode for this template.
O	additionalHeaderForReceive(String name, Object value)	Set a default header to be added to received messages.
O	additionalHeadersForReceive(Map<String,Object> defaultAdditionalHeaders)	Set default headers to be added to received messages.
protected void	defaultEndpointName(String defaultEndpointName)	Subclasses should have a method with a more specific name and delegate to this.
O	defaultMaxNumberOfMessages(Integer defaultMaxNumberOfMessages)	Set the default maximum number of messages to be retrieved in a single batch.
O	defaultPayloadClass(Class<?> defaultPayloadClass)	The default class to which this template should convert payloads to.
O	defaultPollTimeout(Duration defaultPollTimeout)	Set the default maximum amount of time this template will wait for the maximum number of messages before returning.
O	self()
O	sendBatchFailureHandlingStrategy(SendBatchFailureHandlingStrategy sendBatchFailureHandlingStrategy)	Set the strategy to use when handling batch send operations with at least one failed message.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMessagingTemplateOptions

protected AbstractMessagingTemplateOptions()

Method Details

acknowledgementMode

public O acknowledgementMode(TemplateAcknowledgementMode defaultAcknowledgementMode)

Description copied from interface: MessagingTemplateOptions

Set the acknowledgement mode for this template. Default is TemplateAcknowledgementMode.ACKNOWLEDGE

Specified by:

acknowledgementMode in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

defaultAcknowledgementMode - the mode.

Returns:

the options instance.

sendBatchFailureHandlingStrategy

public O sendBatchFailureHandlingStrategy(SendBatchFailureHandlingStrategy sendBatchFailureHandlingStrategy)

Description copied from interface: MessagingTemplateOptions

Set the strategy to use when handling batch send operations with at least one failed message. Default is SendBatchFailureHandlingStrategy.THROW

Specified by:

sendBatchFailureHandlingStrategy in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

sendBatchFailureHandlingStrategy - the strategy.

Returns:

the options instance.

defaultPollTimeout

public O defaultPollTimeout(Duration defaultPollTimeout)

Description copied from interface: MessagingTemplateOptions

Set the default maximum amount of time this template will wait for the maximum number of messages before returning. Default is 10 seconds.

Specified by:

defaultPollTimeout in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

defaultPollTimeout - the timeout.

Returns:

the options instance.

defaultMaxNumberOfMessages

public O defaultMaxNumberOfMessages(Integer defaultMaxNumberOfMessages)

Description copied from interface: MessagingTemplateOptions

Set the default maximum number of messages to be retrieved in a single batch. Default is 10.

Specified by:

defaultMaxNumberOfMessages in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

defaultMaxNumberOfMessages - the maximum number of messages.

Returns:

the options instance.

defaultEndpointName

protected void defaultEndpointName(String defaultEndpointName)

Subclasses should have a method with a more specific name and delegate to this.

Parameters:

defaultEndpointName - the default endpoint name.

defaultPayloadClass

public O defaultPayloadClass(Class<?> defaultPayloadClass)

Description copied from interface: MessagingTemplateOptions

The default class to which this template should convert payloads to.

Specified by:

defaultPayloadClass in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

defaultPayloadClass - the default payload class.

Returns:

the options instance.

additionalHeaderForReceive

public O additionalHeaderForReceive(String name,
 Object value)

Description copied from interface: MessagingTemplateOptions

Set a default header to be added to received messages.

Specified by:

additionalHeaderForReceive in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

name - the header name.

value - the header value.

Returns:

the options instance.

additionalHeadersForReceive

public O additionalHeadersForReceive(Map<String,Object> defaultAdditionalHeaders)

Description copied from interface: MessagingTemplateOptions

Set default headers to be added to received messages.

Specified by:

additionalHeadersForReceive in interface MessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Parameters:

defaultAdditionalHeaders - the headers.

Returns:

the options instance.

self

public O self()