Package org.apache.flink.streaming.api.operators

Class StreamOperatorStateHandler

java.lang.Object

org.apache.flink.streaming.api.operators.StreamOperatorStateHandler

@Internal
public class StreamOperatorStateHandler
extends Object

Class encapsulating various state backend handling logic for StreamOperator implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamOperatorStateHandler.CheckpointedStreamOperator	Custom state handling hooks to be invoked by StreamOperatorStateHandler.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
StreamOperatorStateHandler(StreamOperatorStateContext context, org.apache.flink.api.common.ExecutionConfig executionConfig, org.apache.flink.core.fs.CloseableRegistry closeableRegistry)

Method Summary

Modifier and Type	Method	Description
void	dispose()
AsyncKeyedStateBackend	getAsyncKeyedStateBackend()
Object	getCurrentKey()
<K> KeyedStateBackend<K>	getKeyedStateBackend()
Optional<org.apache.flink.api.common.state.KeyedStateStore>	getKeyedStateStore()
Optional<KeyedStateStoreV2>	getKeyedStateStoreV2()
OperatorStateBackend	getOperatorStateBackend()
<N,S extends org.apache.flink.api.common.state.v2.State,T> S	getOrCreateKeyedState(N defaultNamespace, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, StateDescriptor<T> stateDescriptor)	Create new state (v2) based on new state descriptor.
<N,S extends org.apache.flink.api.common.state.State,T> S	getOrCreateKeyedState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor)
protected <S extends org.apache.flink.api.common.state.State,N> S	getPartitionedState(N namespace, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)	Creates a partitioned state handle, using the state backend configured for this task.
void	initializeOperatorState(StreamOperatorStateHandler.CheckpointedStreamOperator streamOperator)
void	notifyCheckpointAborted(long checkpointId)
void	notifyCheckpointComplete(long checkpointId)
static SnapshotStrategyRunner<KeyedStateHandle,? extends FullSnapshotResources<?>>	prepareCanonicalSavepoint(CheckpointableKeyedStateBackend<?> keyedStateBackend, org.apache.flink.core.fs.CloseableRegistry closeableRegistry)
void	setCurrentKey(Object key)
OperatorSnapshotFutures	snapshotState(StreamOperatorStateHandler.CheckpointedStreamOperator streamOperator, Optional<InternalTimeServiceManager<?>> timeServiceManager, String operatorName, long checkpointId, long timestamp, CheckpointOptions checkpointOptions, CheckpointStreamFactory factory, boolean isUsingCustomRawKeyedState, boolean useAsyncState)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

StreamOperatorStateHandler

public StreamOperatorStateHandler(StreamOperatorStateContext context,
                                  org.apache.flink.api.common.ExecutionConfig executionConfig,
                                  org.apache.flink.core.fs.CloseableRegistry closeableRegistry)

Method Detail

initializeOperatorState

public void initializeOperatorState(StreamOperatorStateHandler.CheckpointedStreamOperator streamOperator)
                             throws Exception

Throws:

Exception

dispose

public void dispose()
             throws Exception

Throws:

Exception

snapshotState

public OperatorSnapshotFutures snapshotState(StreamOperatorStateHandler.CheckpointedStreamOperator streamOperator,
                                             Optional<InternalTimeServiceManager<?>> timeServiceManager,
                                             String operatorName,
                                             long checkpointId,
                                             long timestamp,
                                             CheckpointOptions checkpointOptions,
                                             CheckpointStreamFactory factory,
                                             boolean isUsingCustomRawKeyedState,
                                             boolean useAsyncState)
                                      throws CheckpointException

Throws:

CheckpointException

prepareCanonicalSavepoint

@Nonnull
public static SnapshotStrategyRunner<KeyedStateHandle,? extends FullSnapshotResources<?>> prepareCanonicalSavepoint(CheckpointableKeyedStateBackend<?> keyedStateBackend,
                                                                                                                          org.apache.flink.core.fs.CloseableRegistry closeableRegistry)
                                                                                                                   throws Exception

Throws:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

Throws:

Exception

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)
                             throws Exception

Throws:

Exception

getKeyedStateBackend

public <K> KeyedStateBackend<K> getKeyedStateBackend()

getAsyncKeyedStateBackend

@Nullable
public AsyncKeyedStateBackend getAsyncKeyedStateBackend()

getOperatorStateBackend

public OperatorStateBackend getOperatorStateBackend()

getOrCreateKeyedState

public <N,S extends org.apache.flink.api.common.state.State,T> S getOrCreateKeyedState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                                   org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor)
                                                                                            throws Exception

Throws:

Exception

getOrCreateKeyedState

public <N,S extends org.apache.flink.api.common.state.v2.State,T> S getOrCreateKeyedState(N defaultNamespace,
                                                                                                      org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                                      StateDescriptor<T> stateDescriptor)
                                                                                               throws Exception

Create new state (v2) based on new state descriptor.

Throws:

Exception

getPartitionedState

protected <S extends org.apache.flink.api.common.state.State,N> S getPartitionedState(N namespace,
                                                                                            org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                            org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)
                                                                                     throws Exception

Creates a partitioned state handle, using the state backend configured for this task.

Throws:

IllegalStateException - Thrown, if the key/value state was already initialized.

Exception - Thrown, if the state backend cannot create the key/value state.

setCurrentKey

public void setCurrentKey(Object key)

getCurrentKey

public Object getCurrentKey()

getKeyedStateStore

public Optional<org.apache.flink.api.common.state.KeyedStateStore> getKeyedStateStore()

getKeyedStateStoreV2

public Optional<KeyedStateStoreV2> getKeyedStateStoreV2()