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

Interface KinesisConsumerStates.ConsumerState

All Known Implementing Classes:

KinesisConsumerStates.InitializingState

Enclosing class:

KinesisConsumerStates

public static interface KinesisConsumerStates.ConsumerState

Represents a the current state of the consumer. This handles the creation of tasks for the consumer, and what to do when a transition occurs.

Method Summary

Modifier and Type	Method and Description
ITask	createTask(KinesisShardConsumer consumer) Creates a new task for this state using the passed in consumer to build the task.
KinesisConsumerStates.ShardConsumerState	getState() An enumeration represent the type of this state.
TaskType	getTaskType() The type of task that createTask(KinesisShardConsumer) would return.
boolean	isTerminal()
KinesisConsumerStates.ConsumerState	shutdownTransition(ShutdownReason shutdownReason) Provides the next state of the consumer when a shutdown has been requested.
KinesisConsumerStates.ConsumerState	successTransition() Provides the next state of the consumer upon success of the task return by createTask(KinesisShardConsumer).

Method Detail

createTask

ITask createTask(KinesisShardConsumer consumer)

Creates a new task for this state using the passed in consumer to build the task. If there is no task required for this state it may return a null value. KinesisConsumerStates.ConsumerState's are allowed to modify the consumer during the execution of this method.

Parameters:

consumer - the consumer to use build the task, or execute state.

Returns:

a valid task for this state or null if there is no task required.

successTransition

KinesisConsumerStates.ConsumerState successTransition()

Provides the next state of the consumer upon success of the task return by createTask(KinesisShardConsumer).

Returns:

the next state that the consumer should transition to, this may be the same object as the current state.

shutdownTransition

KinesisConsumerStates.ConsumerState shutdownTransition(ShutdownReason shutdownReason)

Provides the next state of the consumer when a shutdown has been requested. The returned state is dependent on the current state, and the shutdown reason.

Parameters:

shutdownReason - the reason that a shutdown was requested

Returns:

the next state that the consumer should transition to, this may be the same object as the current state.

getTaskType

TaskType getTaskType()

The type of task that createTask(KinesisShardConsumer) would return. This is always a valid state even if createTask would return a null value.

Returns:

the type of task that this state represents.

getState

KinesisConsumerStates.ShardConsumerState getState()

An enumeration represent the type of this state. Different consumer states may return the same KinesisConsumerStates.ShardConsumerState.

Returns:

the type of consumer state this represents.

isTerminal

boolean isTerminal()