Interface IUserProcessExtension

  • All Superinterfaces:
    All Known Implementing Classes:

    public interface IUserProcessExtension
    extends IProcessExtension

    This interface must be implemented by user process extensions (e.g. Java classes that can be used in PI process elements).

    If the program should be configured by the user, there must be a public static inner class called editor implementing the IProcessExtensionConfigurationEditorEx interface. The configuration editor must have a public constructor without arguments.

    Implementors can use the abstract class AbstractUserProcessExtension

    This is a public API.
    • Method Detail

      • perform

        CompositeObject perform​(IRequestId requestId,
                                CompositeObject in,
                                IIvyScriptContext context)
                         throws Exception
        This method is the program performed in a process extension element every time a token comes to the process element (request). Note that more than one thread can call this method parallel if more than one request are running through the process extension element. Therefore the bean must be aware of multithreading.
        requestId - the identifier of the request
        in - the current process data. Modify this process data in your implementation
        context - the context to use to perform the request
        the process data that are reinjected to the process. Most implementation simple return the in object
        Exception - if perform fails
        This public API is available in Java.