Package rife.engine

Class EngineContinuationConfigInstrument

java.lang.Object
rife.engine.EngineContinuationConfigInstrument
All Implemented Interfaces:
ContinuationConfigInstrument
public class EngineContinuationConfigInstrument extends Object implements ContinuationConfigInstrument
Configures the continuations system for the web engine.
Since:
1.0

  • Constructor Details

    • EngineContinuationConfigInstrument

      public EngineContinuationConfigInstrument()

  • Method Details

    • getContinuableMarkerInterfaceName

      public String getContinuableMarkerInterfaceName()
      Description copied from interface: ContinuationConfigInstrument
      The name of the interface that will indicate that a class should be instrumented for continuations functionalities, for instance ContinuableObject.class.getName().
      Specified by:
      getContinuableMarkerInterfaceName in interface ContinuationConfigInstrument
      Returns:
      the name of the marker interface

    • getContinuableSupportClassName

      public String getContinuableSupportClassName()
      Description copied from interface: ContinuationConfigInstrument
      The class name of the support class that contains dummy implementations of the continuation methods that are configured below, for instance ContinuableSupport.class.getName().

      If you implement these methods in your continuable classes or extend these classes from a common base class with those methods that are then called locally, this configuration can return null since it will not be used. A class name only needs to be provided if your continuable classes only implement the marker interface, and you call the continuation methods on an instance of this support inside your continuations logic.

      Specified by:
      getContinuableSupportClassName in interface ContinuationConfigInstrument
      Returns:
      the name of the continuable support class; or

      null if such a support class isn't used

    • getEntryMethodName

      public String getEntryMethodName()
      Description copied from interface: ContinuationConfigInstrument
      The name of the entry method that will be invoked when a new instance of a continuable class is created and its execution is started, for instance "execute".
      Specified by:
      getEntryMethodName in interface ContinuationConfigInstrument
      Returns:
      the name of the entry method

    • getEntryMethodDescriptor

      public String getEntryMethodDescriptor()
      Description copied from interface: ContinuationConfigInstrument
      The ASM method descriptor of the entry method, this includes the arguments and the return types. If there's no arguments nor return types, this is "()V".
      Specified by:
      getEntryMethodDescriptor in interface ContinuationConfigInstrument
      Returns:
      the ASM method descriptor for the entry method

    • getPauseMethodName

      public String getPauseMethodName()
      Description copied from interface: ContinuationConfigInstrument
      The name of the method that will trigger a pause continuation, for instance "pause".

      This method should have a void return type and take no arguments.

      Specified by:
      getPauseMethodName in interface ContinuationConfigInstrument
      Returns:
      the name of the pause method or null if you don't use pause continuations