Package io.camunda.zeebe.engine.state

Interface QueryService

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
StateQueryService
@Deprecated(forRemoval=true, since="1.2") public interface QueryService extends AutoCloseable
Deprecated, for removal: This API element is subject to removal in a future version.
This service provides a few highly specific queries.

It exists to be used by the broker's temporary query api, which only exists as a temporary solution to provide client authorization. Once client authorization is a first-class citizen, this interface should be removed. We strongly discourage using this interface for anything else than it's intended purpose.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    QueryService.ClosedServiceException
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<org.agrona.DirectBuffer>
    getBpmnProcessIdForJob(long jobKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Queries the state for the bpmn process id of the process that a specific job belongs to.
    Optional<org.agrona.DirectBuffer>
    getBpmnProcessIdForProcess(long processKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Queries the state for the bpmn process id of a specific process.
    Optional<org.agrona.DirectBuffer>
    getBpmnProcessIdForProcessInstance(long processInstanceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Queries the state for the bpmn process id of the process of a specific process instance.

    Methods inherited from interface java.lang.AutoCloseable

    close

  • Method Details

    • getBpmnProcessIdForProcess

      Optional<org.agrona.DirectBuffer> getBpmnProcessIdForProcess(long processKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Queries the state for the bpmn process id of a specific process.
      Parameters:
      processKey - The key of the process
      Returns:
      Optionally the bpmn process id if found, otherwise an empty optional
      Throws:
      QueryService.ClosedServiceException - if the service is already closed

    • getBpmnProcessIdForProcessInstance

      Optional<org.agrona.DirectBuffer> getBpmnProcessIdForProcessInstance(long processInstanceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Queries the state for the bpmn process id of the process of a specific process instance.
      Parameters:
      processInstanceKey - The key of the process instance
      Returns:
      Optionally the bpmn process id if found, otherwise an empty optional
      Throws:
      QueryService.ClosedServiceException - if the service is already closed

    • getBpmnProcessIdForJob

      Optional<org.agrona.DirectBuffer> getBpmnProcessIdForJob(long jobKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Queries the state for the bpmn process id of the process that a specific job belongs to.
      Parameters:
      jobKey - The key of the job
      Returns:
      Optionally the bpmn process id if found, otherwise an empty optional
      Throws:
      QueryService.ClosedServiceException - if the service is already closed