Package io.camunda.zeebe.broker.transport.backupapi

Class BackupApiRequestHandler

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.broker.transport.AsyncApiRequestHandler<BackupApiRequestReader,BackupApiResponseWriter>

io.camunda.zeebe.broker.transport.backupapi.BackupApiRequestHandler

All Implemented Interfaces:

DiskSpaceUsageListener, AsyncClosable, ConcurrencyControl, RequestHandler, AutoCloseable

public final class BackupApiRequestHandler
extends AsyncApiRequestHandler<BackupApiRequestReader,BackupApiResponseWriter>
implements DiskSpaceUsageListener

Request handler to handle commands and queries related to the backup (RequestType.BACKUP)

Nested Class Summary

Nested classes/interfaces inherited from class io.camunda.zeebe.broker.transport.AsyncApiRequestHandler

AsyncApiRequestHandler.RequestReader<T extends org.agrona.sbe.MessageDecoderFlyweight>, AsyncApiRequestHandler.ResponseWriter

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

Actor.ActorBuilder

Field Summary

Fields inherited from class io.camunda.zeebe.broker.transport.AsyncApiRequestHandler

LOG

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

actor, ACTOR_PROP_NAME, ACTOR_PROP_PARTITION_ID

Constructor Summary

Constructors

Constructor	Description
BackupApiRequestHandler(AtomixServerTransport transport, LogStreamWriter logStreamWriter, BackupManager backupManager, int partitionId, boolean backupFeatureEnabled)

Method Summary

Modifier and Type	Method	Description
void	close()
protected ActorFuture<Either<ErrorResponseWriter,BackupApiResponseWriter>>	handleAsync(int requestStreamId, long requestId, BackupApiRequestReader requestReader, BackupApiResponseWriter responseWriter, ErrorResponseWriter errorWriter)	Handles a request.
void	onDiskSpaceAvailable()	Will be called when disk space usage goes below the threshold after it was above it.
void	onDiskSpaceNotAvailable()	Will be called when disk space usage grows above the threshold

Methods inherited from class io.camunda.zeebe.broker.transport.AsyncApiRequestHandler

onRequest

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

buildActorName, closeAsync, createContext, getContext, getName, handleFailure, isActorClosed, newActor, onActorClosed, onActorCloseRequested, onActorClosing, onActorFailed, onActorStarted, onActorStarting, run, runOnCompletion, 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

BackupApiRequestHandler

public BackupApiRequestHandler(AtomixServerTransport transport,
 LogStreamWriter logStreamWriter,
 BackupManager backupManager,
 int partitionId,
 boolean backupFeatureEnabled)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class Actor

handleAsync

protected ActorFuture<Either<ErrorResponseWriter,BackupApiResponseWriter>> handleAsync(int requestStreamId,
 long requestId,
 BackupApiRequestReader requestReader,
 BackupApiResponseWriter responseWriter,
 ErrorResponseWriter errorWriter)

Description copied from class: AsyncApiRequestHandler

Handles a request. The is populated at this point.

Specified by:

handleAsync in class AsyncApiRequestHandler<BackupApiRequestReader,BackupApiResponseWriter>

Parameters:

requestStreamId - the current partition id

requestId - the current request id

requestReader - a reader that is already populated with the request data

responseWriter - a writer that can be used to write successful responses

errorWriter - a ErrorResponseWriter that can be used to write error responses

Returns:

a ErrorResponseWriter when the handling failed, or a ResponseWriter when the handling was successful. Writes to the other writer will be ignored and are not sent as a response.

onDiskSpaceNotAvailable

public void onDiskSpaceNotAvailable()

Description copied from interface: DiskSpaceUsageListener

Will be called when disk space usage grows above the threshold

Specified by:

onDiskSpaceNotAvailable in interface DiskSpaceUsageListener

onDiskSpaceAvailable

public void onDiskSpaceAvailable()

Description copied from interface: DiskSpaceUsageListener

Will be called when disk space usage goes below the threshold after it was above it.

Specified by:

onDiskSpaceAvailable in interface DiskSpaceUsageListener