com.amazon.sqs.javamessaging

Class ExtendedClientConfiguration

java.lang.Object

com.amazon.sqs.javamessaging.ExtendedClientConfiguration

public class ExtendedClientConfiguration
extends java.lang.Object

Amazon SQS extended client configuration options such as Amazon S3 client, bucket name, and message size threshold for large-payload messages.

Constructor Summary

Constructors

Constructor and Description
ExtendedClientConfiguration()
ExtendedClientConfiguration(ExtendedClientConfiguration other)

Method Summary

Methods

Modifier and Type	Method and Description
AmazonS3	getAmazonS3Client() Gets the Amazon S3 client which is being used for storing large-payload messages.
int	getMessageSizeThreshold() Gets the message size threshold for storing message payloads in Amazon S3.
java.lang.String	getS3BucketName() Gets the name of the S3 bucket which is being used for storing large-payload messages.
boolean	isAlwaysThroughS3() Checks whether or not all messages regardless of their payload size are being stored in Amazon S3.
boolean	isLargePayloadSupportEnabled() Check if the support for large-payload message if enabled.
void	setAlwaysThroughS3(boolean alwaysThroughS3) Sets whether or not all messages regardless of their payload size should be stored in Amazon S3.
void	setLargePayloadSupportDisabled() Disables support for large-payload messages.
void	setLargePayloadSupportEnabled(AmazonS3 s3, java.lang.String s3BucketName) Enables support for large-payload messages.
void	setMessageSizeThreshold(int messageSizeThreshold) Sets the message size threshold for storing message payloads in Amazon S3.
ExtendedClientConfiguration	withAlwaysThroughS3(boolean alwaysThroughS3) Sets whether or not all messages regardless of their payload size should be stored in Amazon S3.
ExtendedClientConfiguration	withLargePayloadSupportDisabled() Disables support for large-payload messages.
ExtendedClientConfiguration	withLargePayloadSupportEnabled(AmazonS3 s3, java.lang.String s3BucketName) Enables support for large-payload messages.
ExtendedClientConfiguration	withMessageSizeThreshold(int messageSizeThreshold) Sets the message size threshold for storing message payloads in Amazon S3.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedClientConfiguration

public ExtendedClientConfiguration()

ExtendedClientConfiguration

public ExtendedClientConfiguration(ExtendedClientConfiguration other)

Method Detail

setLargePayloadSupportEnabled

public void setLargePayloadSupportEnabled(AmazonS3 s3,
                                 java.lang.String s3BucketName)

Enables support for large-payload messages.

Parameters:

s3 - Amazon S3 client which is going to be used for storing large-payload messages.

s3BucketName - Name of the bucket which is going to be used for storing large-payload messages. The bucket must be already created and configured in s3.

withLargePayloadSupportEnabled

public ExtendedClientConfiguration withLargePayloadSupportEnabled(AmazonS3 s3,
                                                         java.lang.String s3BucketName)

Enables support for large-payload messages.

Parameters:

s3 - Amazon S3 client which is going to be used for storing large-payload messages.

s3BucketName - Name of the bucket which is going to be used for storing large-payload messages. The bucket must be already created and configured in s3.

Returns:

the updated ExtendedClientConfiguration object.

setLargePayloadSupportDisabled

public void setLargePayloadSupportDisabled()

Disables support for large-payload messages.

withLargePayloadSupportDisabled

public ExtendedClientConfiguration withLargePayloadSupportDisabled()

Disables support for large-payload messages.

Returns:

the updated ExtendedClientConfiguration object.

isLargePayloadSupportEnabled

public boolean isLargePayloadSupportEnabled()

Check if the support for large-payload message if enabled.

Returns:

true if support for large-payload messages is enabled.

getAmazonS3Client

public AmazonS3 getAmazonS3Client()

Gets the Amazon S3 client which is being used for storing large-payload messages.

Returns:

Reference to the Amazon S3 client which is being used.

getS3BucketName

public java.lang.String getS3BucketName()

Gets the name of the S3 bucket which is being used for storing large-payload messages.

Returns:

The name of the bucket which is being used.

setMessageSizeThreshold

public void setMessageSizeThreshold(int messageSizeThreshold)

Sets the message size threshold for storing message payloads in Amazon S3.

Parameters:

messageSizeThreshold - Message size threshold to be used for storing in Amazon S3. Default: 256KB.

withMessageSizeThreshold

public ExtendedClientConfiguration withMessageSizeThreshold(int messageSizeThreshold)

Sets the message size threshold for storing message payloads in Amazon S3.

Parameters:

messageSizeThreshold - Message size threshold to be used for storing in Amazon S3. Default: 256KB.

Returns:

the updated ExtendedClientConfiguration object.

getMessageSizeThreshold

public int getMessageSizeThreshold()

Gets the message size threshold for storing message payloads in Amazon S3.

Returns:

Message size threshold which is being used for storing in Amazon S3. Default: 256KB.

setAlwaysThroughS3

public void setAlwaysThroughS3(boolean alwaysThroughS3)

Sets whether or not all messages regardless of their payload size should be stored in Amazon S3.

Parameters:

alwaysThroughS3 - Whether or not all messages regardless of their payload size should be stored in Amazon S3. Default: false

withAlwaysThroughS3

public ExtendedClientConfiguration withAlwaysThroughS3(boolean alwaysThroughS3)

Sets whether or not all messages regardless of their payload size should be stored in Amazon S3.

Parameters:

alwaysThroughS3 - Whether or not all messages regardless of their payload size should be stored in Amazon S3. Default: false

Returns:

the updated ExtendedClientConfiguration object.

isAlwaysThroughS3

public boolean isAlwaysThroughS3()

Checks whether or not all messages regardless of their payload size are being stored in Amazon S3.

Returns:

True if all messages regardless of their payload size are being stored in Amazon S3. Default: false