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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addPendingRequest​(FetchExternalTasksExtendedDto dto, javax.ws.rs.container.AsyncResponse asyncResponse, ProcessEngine processEngine)
      Invoked if a fetch and lock request has been sent by the client
      void contextInitialized​(javax.servlet.ServletContextEvent servletContextEvent)
      Invoked on initialization of the servlet context
      void shutdown()
      Receives a notification that the engine rest web application is about to be shut down
      void start()
      Receives a notification that the engine rest web application initialization has been started

    • Method Detail

      • 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,
                       javax.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 payload
        asyncResponse - provides means for asynchronous server side response processing
        processEngine - provides the process engine context of the respective request

      • contextInitialized

        void contextInitialized​(javax.servlet.ServletContextEvent servletContextEvent)
        Invoked on initialization of the servlet context
        Parameters:
        servletContextEvent - provides the servlet context