com.amazonaws.services.cloudtrail.processinglibrary.serializer

Class AbstractEventSerializer

java.lang.Object

com.amazonaws.services.cloudtrail.processinglibrary.serializer.AbstractEventSerializer

All Implemented Interfaces:

EventSerializer, java.lang.AutoCloseable

Direct Known Subclasses:

DefaultEventSerializer, RawLogDeliveryEventSerializer

public abstract class AbstractEventSerializer
extends java.lang.Object
implements EventSerializer

Abstract base class for Event Serializer implementations.

Constructor Summary

Constructors

Constructor and Description
AbstractEventSerializer(JsonParser jsonParser) Construct an AbstractEventSerializer object

Method Summary

Modifier and Type	Method and Description
void	close() Close the JSON parser object used to read the CloudTrail log.
abstract CloudTrailEventMetadata	getMetadata(int charStart, int charEnd) An abstract class that returns an CloudTrailEventMetadata object.
CloudTrailEvent	getNextEvent() Get the next event from the CloudTrail log and parse it.
boolean	hasNextEvent() Indicates whether the CloudTrail log has more events to read.
protected void	readArrayHeader() Read the header of an AWS CloudTrail log.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEventSerializer

public AbstractEventSerializer(JsonParser jsonParser)
                        throws java.io.IOException

Construct an AbstractEventSerializer object

Parameters:

jsonParser - a Jackson JsonParser object to use for interpreting JSON objects.

Throws:

java.io.IOException - under no conditions.

Method Detail

getMetadata

public abstract CloudTrailEventMetadata getMetadata(int charStart,
                                                    int charEnd)

An abstract class that returns an CloudTrailEventMetadata object.

Parameters:

charStart - the character count at which to begin reading event data.

charEnd - the character count at which to stop reading event data.

Returns:

the event metadata.

readArrayHeader

protected void readArrayHeader()
                        throws java.io.IOException

Read the header of an AWS CloudTrail log.

Throws:

JsonParseException - if the log could not be parsed.

java.io.IOException - if the log could not be opened or accessed.

hasNextEvent

public boolean hasNextEvent()
                     throws java.io.IOException

Indicates whether the CloudTrail log has more events to read.

Specified by:

hasNextEvent in interface EventSerializer

Returns:

true if the log contains more events; false otherwise.

Throws:

java.io.IOException - if the log could not be opened or accessed.

close

public void close()
           throws java.io.IOException

Close the JSON parser object used to read the CloudTrail log.

Specified by:

close in interface EventSerializer

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if the log could not be opened or accessed.

getNextEvent

public CloudTrailEvent getNextEvent()
                             throws java.io.IOException

Get the next event from the CloudTrail log and parse it.

Specified by:

getNextEvent in interface EventSerializer

Returns:

a CloudTrailEvent that represents the parsed event.

Throws:

java.io.IOException - if the event could not be parsed.