Package io.camunda.zeebe.broker.transport.queryapi

Class QueryApiRequestHandler

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.broker.transport.AsyncApiRequestHandler<QueryRequestReader,QueryResponseWriter>

io.camunda.zeebe.broker.transport.queryapi.QueryApiRequestHandler

All Implemented Interfaces:

AsyncClosable, ConcurrencyControl, RequestHandler, AutoCloseable

@Deprecated(forRemoval=true,
            since="1.2.0")
public final class QueryApiRequestHandler
extends AsyncApiRequestHandler<QueryRequestReader,QueryResponseWriter>

Deprecated, for removal: This API element is subject to removal in a future version.

Request handler for ExecuteQueryRequest SBE messages. When successful, it looks up the bpmnProcessId of a process based on the request details. Make sure to set QueryApiCfg.setEnabled(boolean) to true to enable this functionality.

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
QueryApiRequestHandler(QueryApiCfg config)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	addPartition(int partitionId, QueryService queryService)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getName()	Deprecated, for removal: This API element is subject to removal in a future version.
protected ActorFuture<Either<ErrorResponseWriter,QueryResponseWriter>>	handleAsync(int partitionId, long requestId, QueryRequestReader requestReader, QueryResponseWriter responseWriter, ErrorResponseWriter errorWriter)	Deprecated, for removal: This API element is subject to removal in a future version. Handles a request.
protected void	onActorClosing()	Deprecated, for removal: This API element is subject to removal in a future version.
void	removePartition(int partitionId)	Deprecated, for removal: This API element is subject to removal in a future version.

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

onRequest

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

buildActorName, close, closeAsync, createContext, getContext, handleFailure, isActorClosed, newActor, onActorClosed, onActorCloseRequested, 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

QueryApiRequestHandler

public QueryApiRequestHandler(QueryApiCfg config)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getName

public String getName()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

getName in class Actor

onActorClosing

protected void onActorClosing()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

onActorClosing in class Actor

addPartition

public void addPartition(int partitionId,
 QueryService queryService)

Deprecated, for removal: This API element is subject to removal in a future version.

removePartition

public void removePartition(int partitionId)

Deprecated, for removal: This API element is subject to removal in a future version.

handleAsync

protected ActorFuture<Either<ErrorResponseWriter,QueryResponseWriter>> handleAsync(int partitionId,
 long requestId,
 QueryRequestReader requestReader,
 QueryResponseWriter responseWriter,
 ErrorResponseWriter errorWriter)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AsyncApiRequestHandler

Handles a request. The is populated at this point.

Specified by:

handleAsync in class AsyncApiRequestHandler<QueryRequestReader,QueryResponseWriter>

Parameters:

partitionId - 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.