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

Class KinesisShardConsumer

java.lang.Object

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

All Implemented Interfaces:

IShardConsumer

public class KinesisShardConsumer
extends Object
implements IShardConsumer

Responsible for consuming data records of a (specified) shard. The instance should be shutdown when we lose the primary responsibility for a shard. A new instance should be created if the primary responsibility is reassigned back to this process.

Nested Class Summary

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

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.
KinesisConsumerStates.ShardConsumerState	getCurrentState() Private/Internal method - has package level access solely for testing purposes.
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(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

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 IShardConsumer

Returns:

true if a new process task was submitted, false otherwise

isSkipShardSyncAtWorkerInitializationIfLeasesExist

public boolean isSkipShardSyncAtWorkerInitializationIfLeasesExist()

Specified by:

isSkipShardSyncAtWorkerInitializationIfLeasesExist in interface IShardConsumer

notifyShutdownRequested

public void notifyShutdownRequested(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 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 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 IShardConsumer

Returns:

true if shutdown is complete

getShutdownReason

public ShutdownReason getShutdownReason()

Specified by:

getShutdownReason in interface IShardConsumer

Returns:

the shutdownReason

isShutdownRequested

public boolean isShutdownRequested()

Specified by:

isShutdownRequested in interface IShardConsumer

getCurrentState

public KinesisConsumerStates.ShardConsumerState getCurrentState()

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

Specified by:

getCurrentState in interface IShardConsumer

Returns:

the currentState