Package ch.ivyteam.ivy.process.extension

Interface IProcessExtension

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void abort​(IRequestId requestId)
      The request with the request id must be aborted Called if a timeout exception occurs.
      String getAdditionalLogInfo​(IRequestId requestId)
      Gets addition log info.
      void release()
      This method is called before this process extension is thrown away by the process engine.
      void setConfiguration​(String configuration)
      Sets the configuration of the process extension
      void start()
      On the designer this method is called if the simulation starts.
      void stop()
      On the designer this method is called if the simulation stops.

    • Method Detail

      • abort

        void abort​(IRequestId requestId)
        The request with the request id must be aborted Called if a timeout exception occurs.
        Parameters:
        requestId - the identifier of the request to stop
        API:
        This public API is available in Java.

      • start

        void start()
    throws Exception
        On the designer this method is called if the simulation starts. On the server this method is called after the process is loaded and before the process handles the first request. Implementors can use this method to prepare the bean to handle requests (e.g. start threads, allocate resources etc.)
        Throws:
        Exception - if bean can not be started
        API:
        This public API is available in Java.

      • stop

        void stop()
   throws Exception
        On the designer this method is called if the simulation stops. On the server this method is called before the process is unloaded, this can happened if the process model version, the process model or the web application is deactivated. Implementors must use this method to abort all running request.
        Throws:
        Exception - if bean can not be stopped
        API:
        This public API is available in Java.

      • release

        void release()
      throws Exception
        This method is called before this process extension is thrown away by the process engine. Implementers should release all resource they have allocated in this method, so that the process extension can be garbage collected (Stop all created threads, close all opened files, etc.)
        Throws:
        Exception - if bean can not be released
        API:
        This public API is available in Java.

      • setConfiguration

        void setConfiguration​(String configuration)
        Sets the configuration of the process extension
        Parameters:
        configuration - the process extension configuration
        API:
        This public API is available in Java.

      • getAdditionalLogInfo

        String getAdditionalLogInfo​(IRequestId requestId)
        Gets addition log info. This information will be added to all log messages.
        Parameters:
        requestId - the identifier of the request
        Returns:
        additional log info
        API:
        This public API is available in Java.