Package io.camunda.zeebe.broker.system.partitions

Interface PartitionStep

All Known Implementing Classes:

AtomixLogStoragePartitionStep, ExporterDirectorPartitionStep, FollowerPostStoragePartitionStep, LeaderPostStoragePartitionStep, LogDeletionPartitionStep, LogStreamPartitionStep, RaftLogReaderPartitionStep, RocksDbMetricExporterPartitionStep, SnapshotDirectorPartitionStep, SnapshotReplicationPartitionStep, StateControllerPartitionStep, StreamProcessorPartitionStep, ZeebeDbPartitionStep

public interface PartitionStep

A PartitionStep is an action to be taken while opening or closing a partition (e.g., opening/closing a component of the partition). The steps are opened in a pre-defined order and will be closed in the reverse order.

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	close(PartitionContext context)	Perform tear-down actions to clear the partition and prepare for another one to be installed.
String	getName()
default ActorFuture<Void>	open(long currentTerm, PartitionContext context)	Performs some action required for the partition to function.
default ActorFuture<Void>	open(PartitionContext context)	Performs some action required for the partition to function.

Method Detail

open

default ActorFuture<Void> open(long currentTerm,
                               PartitionContext context)

Performs some action required for the partition to function. This may include opening components (e.g., logstream), setting their values in PartitionContext, etc. The subsequent partition steps will only be opened after the returned future is completed.

Parameters:

currentTerm - the current term of the transition

context - the partition context

Returns:

future

open

default ActorFuture<Void> open(PartitionContext context)

Performs some action required for the partition to function. This may include opening components (e.g., logstream), setting their values in PartitionContext, etc. The subsequent partition steps will only be opened after the returned future is completed.

Parameters:

context - the partition context

Returns:

future

close

ActorFuture<Void> close(PartitionContext context)

Perform tear-down actions to clear the partition and prepare for another one to be installed. This includes closing components, clearing their values from PartitionContext so they may be garbage-collected, etc. The subsequent partition steps will only be closed after the returned future is completed.

Parameters:

context - the partition context

Returns:

future

getName

String getName()

Returns:

A log-friendly identification of the PartitionStep.