com.amazonaws.services.dynamodbv2.streamsadapter

Class DynamoDBStreamsShardConsumer

java.lang.Object

com.amazonaws.services.dynamodbv2.streamsadapter.DynamoDBStreamsShardConsumer

All Implemented Interfaces:

com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

public class DynamoDBStreamsShardConsumer
extends java.lang.Object
implements com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Nested Class Summary

Nested classes/interfaces inherited from interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer.TaskOutcome

Method Summary

Modifier and Type	Method and Description
boolean	beginShutdown() Shutdown this ShardConsumer (including invoking the RecordProcessor shutdown API).
boolean	consumeShard() No-op if current task is pending, otherwise submits next task for this shard.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisConsumerStates.ShardConsumerState	getCurrentState() Private/Internal method - has package level access solely for testing purposes.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.GetRecordsCache	getGetRecordsCache()
com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShardSyncer	getShardSyncer()
com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownReason	getShutdownReason()
boolean	isShutdown() Used (by Worker) to check if this ShardConsumer instance has been shutdown RecordProcessor shutdown() has been invoked, as appropriate.
boolean	isShutdownRequested()
boolean	isSkipShardSyncAtWorkerInitializationIfLeasesExist()
void	notifyShutdownRequested(com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownNotification shutdownNotification) Requests the shutdown of the this ShardConsumer.

Methods inherited from class java.lang.Object

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

Method Detail

getShardSyncer

public com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShardSyncer getShardSyncer()

getGetRecordsCache

public com.amazonaws.services.kinesis.clientlibrary.lib.worker.GetRecordsCache getGetRecordsCache()

consumeShard

public boolean consumeShard()

No-op if current task is pending, otherwise submits next task for this shard. This method should NOT be called if the ShardConsumer is already in SHUTDOWN_COMPLETED state.

Specified by:

consumeShard in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Returns:

true if a new process task was submitted, false otherwise

isSkipShardSyncAtWorkerInitializationIfLeasesExist

public boolean isSkipShardSyncAtWorkerInitializationIfLeasesExist()

Specified by:

isSkipShardSyncAtWorkerInitializationIfLeasesExist in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

notifyShutdownRequested

public void notifyShutdownRequested(com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownNotification shutdownNotification)

Requests the shutdown of the this ShardConsumer. This should give the record processor a chance to checkpoint before being shutdown.

Specified by:

notifyShutdownRequested in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Parameters:

shutdownNotification - used to signal that the record processor has been given the chance to shutdown.

beginShutdown

public boolean beginShutdown()

Shutdown this ShardConsumer (including invoking the RecordProcessor shutdown API). This is called by Worker when it loses responsibility for a shard.

Specified by:

beginShutdown in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Returns:

true if shutdown is complete (false if shutdown is still in progress)

isShutdown

public boolean isShutdown()

Used (by Worker) to check if this ShardConsumer instance has been shutdown RecordProcessor shutdown() has been invoked, as appropriate.

Specified by:

isShutdown in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Returns:

true if shutdown is complete

getShutdownReason

public com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownReason getShutdownReason()

Specified by:

getShutdownReason in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Returns:

the shutdownReason

isShutdownRequested

public boolean isShutdownRequested()

Specified by:

isShutdownRequested in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

getCurrentState

public com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisConsumerStates.ShardConsumerState getCurrentState()

Private/Internal method - has package level access solely for testing purposes.

Specified by:

getCurrentState in interface com.amazonaws.services.kinesis.clientlibrary.lib.worker.IShardConsumer

Returns:

the currentState