Package org.camunda.bpm.engine.rest.spi
Interface FetchAndLockHandler
- All Known Implementing Classes:
FetchAndLockHandlerImpl
public interface FetchAndLockHandler
SPI supposed to replace the default implementation of the long-polling fetch and lock handler
- Author:
- Tassilo Weidner
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addPendingRequest
(FetchExternalTasksExtendedDto dto, jakarta.ws.rs.container.AsyncResponse asyncResponse, ProcessEngine processEngine) Invoked if a fetch and lock request has been sent by the clientvoid
contextInitialized
(jakarta.servlet.ServletContextEvent servletContextEvent) Invoked on initialization of the servlet contextvoid
shutdown()
Receives a notification that the engine rest web application is about to be shut downvoid
start()
Receives a notification that the engine rest web application initialization has been started
-
Method Details
-
start
void start()Receives a notification that the engine rest web application initialization has been started -
shutdown
void shutdown()Receives a notification that the engine rest web application is about to be shut down -
addPendingRequest
void addPendingRequest(FetchExternalTasksExtendedDto dto, jakarta.ws.rs.container.AsyncResponse asyncResponse, ProcessEngine processEngine) Invoked if a fetch and lock request has been sent by the client- Parameters:
dto
- which is supposed to hold the payloadasyncResponse
- provides means for asynchronous server side response processingprocessEngine
- provides the process engine context of the respective request
-
contextInitialized
void contextInitialized(jakarta.servlet.ServletContextEvent servletContextEvent) Invoked on initialization of the servlet context- Parameters:
servletContextEvent
- provides the servlet context
-