com.amazonaws.services.cloudtrail.processinglibrary.interfaces

Interface ProgressReporter

All Known Implementing Classes:

DefaultProgressReporter, SampleProgressReporter

public interface ProgressReporter

ProgressReporter is an interface for providing custom handlers of AWS CloudTrail Processing Library progress.

reportStart(ProgressStatus) and reportEnd(ProgressStatus, Object) are invoked at the beginning and the end of the following actions:

1. Polling messages from SQS - SqsManager.pollQueue().
2. Parsing message from SQS - SqsManager.parseMessage(List).
3. Deleting messages from SQS - SqsManager.deleteMessageFromQueue(Message, ProgressStatus).
4. Downloading an AWS CloudTrail log file - S3Manager.downloadLog(CloudTrailLog, CloudTrailSource).
5. Processing the AWS CloudTrail log file - EventReader.processSource(CloudTrailSource).

See Also:

for more information.

Method Summary

Modifier and Type	Method and Description
void	reportEnd(ProgressStatus status, java.lang.Object object) A callback method that report ending status.
java.lang.Object	reportStart(ProgressStatus status) A callback method that report starting status.

Method Detail

reportStart

java.lang.Object reportStart(ProgressStatus status)

A callback method that report starting status.

Parameters:

status - A ProgressStatus that represents the status of the current action being performed.

Returns:

An Object that can be sent to reportEnd(ProgressStatus, Object).

reportEnd

void reportEnd(ProgressStatus status,
               java.lang.Object object)

A callback method that report ending status.

Parameters:

status - A ProgressStatus that represents the status of the current action being performed.

object - An Object to send; usually the object returned by {reportStart(ProgressStatus)}.