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

Class KinesisConsumerStates.InitializingState

java.lang.Object

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

All Implemented Interfaces:

KinesisConsumerStates.ConsumerState

Enclosing class:

KinesisConsumerStates

public static class KinesisConsumerStates.InitializingState
extends Object
implements KinesisConsumerStates.ConsumerState

This state is responsible for initializing the record processor with the shard information.

Valid Transitions

Success

Transitions to the processing state which will begin to send records to the record processor

Shutdown

At this point the record processor has been initialized, but hasn't processed any records. This requires that the record processor be notified of the shutdown, even though there is almost no actions the record processor could take.

ShutdownReason.REQUESTED

Transitions to the ShutdownNotificationState

ShutdownReason.ZOMBIE

Transitions to the ShuttingDownState

ShutdownReason.TERMINATE

This reason should not occur, since terminate is triggered after reaching the end of a shard. Initialize never makes an requests to Kinesis for records, so it can't reach the end of a shard.

Transitions to the ShuttingDownState

Constructor Summary

Constructors

Constructor and Description
InitializingState()

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 KinesisConsumerStates.ConsumerState.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 KinesisConsumerStates.ConsumerState.createTask(KinesisShardConsumer).

Methods inherited from class java.lang.Object

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

Constructor Detail

InitializingState

public InitializingState()

Method Detail

createTask

public ITask createTask(KinesisShardConsumer consumer)

Description copied from interface: KinesisConsumerStates.ConsumerState

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.

Specified by:

createTask in interface KinesisConsumerStates.ConsumerState

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

public KinesisConsumerStates.ConsumerState successTransition()

Description copied from interface: KinesisConsumerStates.ConsumerState

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

Specified by:

successTransition in interface KinesisConsumerStates.ConsumerState

Returns:

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

shutdownTransition

public KinesisConsumerStates.ConsumerState shutdownTransition(ShutdownReason shutdownReason)

Description copied from interface: KinesisConsumerStates.ConsumerState

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.

Specified by:

shutdownTransition in interface KinesisConsumerStates.ConsumerState

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

public TaskType getTaskType()

Description copied from interface: KinesisConsumerStates.ConsumerState

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

Specified by:

getTaskType in interface KinesisConsumerStates.ConsumerState

Returns:

the type of task that this state represents.

getState

public KinesisConsumerStates.ShardConsumerState getState()

Description copied from interface: KinesisConsumerStates.ConsumerState

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

Specified by:

getState in interface KinesisConsumerStates.ConsumerState

Returns:

the type of consumer state this represents.

isTerminal

public boolean isTerminal()

Specified by:

isTerminal in interface KinesisConsumerStates.ConsumerState