com.amazonaws.services.cloudtrail.processinglibrary.manager

Class SqsManager

java.lang.Object

com.amazonaws.services.cloudtrail.processinglibrary.manager.SqsManager

public class SqsManager
extends java.lang.Object

A convenient class to manage Amazon SQS Service related operations.

Constructor Summary

Constructors

Constructor and Description
SqsManager(AmazonSQS sqsClient, ProcessingConfiguration config, ExceptionHandler exceptionHandler, ProgressReporter progressReporter, SourceSerializer sourceSerializer) SqsManager constructor.

Method Summary

Modifier and Type	Method and Description
void	deleteMessageFromQueue(Message sqsMessage, ProgressStatus progressStatus) Delete a message from the SQS queue that you specified in the configuration file.
java.util.List<CloudTrailSource>	parseMessage(java.util.List<Message> sqsMessages) Given a list of raw SQS message parse each of them, and return a list of CloudTrailSource.
java.util.List<Message>	pollQueue() Poll SQS queue for incoming messages, filter them, and return a list of SQS Messages.
boolean	shouldDeleteMessageUponFailure(boolean processSuccess) Delete the message if the CPL failed to process the message and ProcessingConfiguration.isDeleteMessageUponFailure() is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqsManager

public SqsManager(AmazonSQS sqsClient,
                  ProcessingConfiguration config,
                  ExceptionHandler exceptionHandler,
                  ProgressReporter progressReporter,
                  SourceSerializer sourceSerializer)

SqsManager constructor.

Parameters:

sqsClient - used to poll message from SQS.

config - user provided ProcessingConfiguration.

exceptionHandler - user provided exceptionHandler.

progressReporter - user provided progressReporter.

sourceSerializer - user provided SourceSerializer.

Method Detail

pollQueue

public java.util.List<Message> pollQueue()

Poll SQS queue for incoming messages, filter them, and return a list of SQS Messages.

Returns:

a list of SQS messages.

parseMessage

public java.util.List<CloudTrailSource> parseMessage(java.util.List<Message> sqsMessages)

Given a list of raw SQS message parse each of them, and return a list of CloudTrailSource.

Parameters:

sqsMessages - list of SQS messages.

Returns:

list of CloudTrailSource.

deleteMessageFromQueue

public void deleteMessageFromQueue(Message sqsMessage,
                                   ProgressStatus progressStatus)

Delete a message from the SQS queue that you specified in the configuration file.

Parameters:

sqsMessage - the Message that you want to delete.

progressStatus - ProgressStatus tracks the start and end status.

shouldDeleteMessageUponFailure

public boolean shouldDeleteMessageUponFailure(boolean processSuccess)

Delete the message if the CPL failed to process the message and ProcessingConfiguration.isDeleteMessageUponFailure() is enabled.

Parameters:

processSuccess - Indicates whether the CPL processing is successful, such as parsing message, or consuming the events in the CloudTrail log file.

Returns:

true if the message is removable. Otherwise, false.