Package io.camunda.zeebe.broker.system.management

Class BrokerAdminServiceImpl

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.broker.system.management.BrokerAdminServiceImpl

All Implemented Interfaces:

BrokerAdminService, AsyncClosable, ConcurrencyControl, AutoCloseable

public final class BrokerAdminServiceImpl
extends Actor
implements BrokerAdminService

A service that exposes interface to control some of the core functionalities of the broker such as * Pause stream processing * Force take a snapshot

This is intended to be used only by advanced users

Nested Class Summary

Nested classes/interfaces inherited from class io.camunda.zeebe.scheduler.Actor

Actor.ActorBuilder

Field Summary

Fields inherited from class io.camunda.zeebe.scheduler.Actor

actor, ACTOR_PROP_NAME, ACTOR_PROP_PARTITION_ID

Constructor Summary

Constructors

Constructor	Description
BrokerAdminServiceImpl()

Method Summary

Modifier and Type	Method	Description
Map<Integer,PartitionStatus>	getPartitionStatus()	Returns PartitionStatus of all partitions running on this broker.
void	injectAdminAccess(PartitionAdminAccess adminAccess)
void	injectPartitionInfoSource(Collection<ZeebePartition> partitions)
void	pauseExporting()	Request a partition to pause exporting
void	pauseStreamProcessing()	Request a partition to pause its StreamProcessor
void	prepareForUpgrade()	Prepares for upgrade by pausing stream processors and triggering snapshots.
void	resumeExporting()	Request a partition to resume exporting
void	resumeStreamProcessing()	Request a partition to resume its StreamProcessor
void	takeSnapshot()	Trigger a snapshot.

Methods inherited from class io.camunda.zeebe.scheduler.Actor

buildActorName, call, close, closeAsync, createContext, getContext, getName, handleFailure, isActorClosed, newActor, onActorClosed, onActorCloseRequested, onActorClosing, onActorFailed, onActorStarted, onActorStarting, run, runOnCompletion, schedule, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.scheduler.ConcurrencyControl

createCompletedFuture, createFuture

Constructor Details

BrokerAdminServiceImpl

public BrokerAdminServiceImpl()

Method Details

injectAdminAccess

public void injectAdminAccess(PartitionAdminAccess adminAccess)

injectPartitionInfoSource

public void injectPartitionInfoSource(@Deprecated
 Collection<ZeebePartition> partitions)

pauseStreamProcessing

public void pauseStreamProcessing()

Description copied from interface: BrokerAdminService

Request a partition to pause its StreamProcessor

Specified by:

pauseStreamProcessing in interface BrokerAdminService

resumeStreamProcessing

public void resumeStreamProcessing()

Description copied from interface: BrokerAdminService

Request a partition to resume its StreamProcessor

Specified by:

resumeStreamProcessing in interface BrokerAdminService

pauseExporting

public void pauseExporting()

Description copied from interface: BrokerAdminService

Request a partition to pause exporting

Specified by:

pauseExporting in interface BrokerAdminService

resumeExporting

public void resumeExporting()

Description copied from interface: BrokerAdminService

Request a partition to resume exporting

Specified by:

resumeExporting in interface BrokerAdminService

takeSnapshot

public void takeSnapshot()

Description copied from interface: BrokerAdminService

Trigger a snapshot. Partition will attempt to take a snapshot instead of waiting for the snapshot interval.

Specified by:

takeSnapshot in interface BrokerAdminService

prepareForUpgrade

public void prepareForUpgrade()

Description copied from interface: BrokerAdminService

Prepares for upgrade by pausing stream processors and triggering snapshots. It is not normally required to call this before every upgrade. However, this is useful as an upgrade procedure to mitigate the effects of some known bugs.

Specified by:

prepareForUpgrade in interface BrokerAdminService

getPartitionStatus

public Map<Integer,PartitionStatus> getPartitionStatus()

Description copied from interface: BrokerAdminService

Returns PartitionStatus of all partitions running on this broker.

Specified by:

getPartitionStatus in interface BrokerAdminService

Returns:

a map of partition id and partition status