Skip to content

Endpoints

Endpoints is an abstraction of API endpoints.

Contract (Subset)

Creating QueryPublisher

CompletableFuture<QueryPublisher> createQueryPublisher(
  String sql,
  Map<String, Object> properties,
  Map<String, Object> sessionVariables,
  Map<String, Object> requestProperties,
  Context context, WorkerExecutor workerExecutor,
  ApiSecurityContext apiSecurityContext,
  MetricsCallbackHolder metricsCallbackHolder,
  Optional<Boolean> isInternalRequest)

See KsqlServerEndpoints

Used when:

Creating InsertsStreamSubscriber

CompletableFuture<InsertsStreamSubscriber> createInsertsSubscriber(
  String target,
  JsonObject properties,
  Subscriber<InsertResult> acksSubscriber,
  Context context,
  WorkerExecutor workerExecutor,
  ApiSecurityContext apiSecurityContext)

See KsqlServerEndpoints

Used when:

Executing KsqlRequest

CompletableFuture<EndpointResponse> executeKsqlRequest(
  KsqlRequest request,
  WorkerExecutor workerExecutor,
  ApiSecurityContext apiSecurityContext)

See KsqlServerEndpoints

Used when:

Executing Query Request

CompletableFuture<EndpointResponse> executeQueryRequest(
  KsqlRequest request, WorkerExecutor workerExecutor,
  CompletableFuture<Void> connectionClosedFuture, ApiSecurityContext apiSecurityContext,
  Optional<Boolean> isInternalRequest,
  KsqlMediaType mediaType,
  MetricsCallbackHolder metricsCallbackHolder,
  Context context)

See KsqlServerEndpoints

Used when:

executeWebsocketStream

void executeWebsocketStream(
  ServerWebSocket webSocket,
  MultiMap requstParams,
  WorkerExecutor workerExecutor,
  ApiSecurityContext apiSecurityContext,
  Context context)

See KsqlServerEndpoints

Used when:

  • ServerVerticle is requested to handleWebsocket (for GET /ws/query HTTP requests)

Implementations