Package org.imixs.workflow

Schnittstelle Plugin

Alle bekannten Implementierungsklassen:
AbstractPlugin, AccessPlugin, AnalysisPlugin, ApplicationPlugin, ApproverPlugin, DocumentComposerPlugin, EventLogPlugin, HistoryPlugin, IntervalPlugin, LogPlugin, MailPlugin, OwnerPlugin, ReportPlugin, ResultPlugin, RulePlugin, SplitAndJoinPlugin, TaxonomyPlugin, VersionPlugin
public interface Plugin
A Plugin defines the interface between the WorkflowKernel and the WorkflowManager. Each Plugin have to be registered to the WorkflowKernel by the WorkflowManager. The WorkflowKernel executes all registered Plugins when processing a workflow event. A Plugin may throw a PluginException in case the execution failed. This will stop the execution of the process method. A Plugin methods init() and close() can be implemented by Plugin to initialize or tear down external resources or data.
Version:
2.0
Autor:
Ralph Soika
Siehe auch:

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    void
    close(boolean rollbackTransaction)
    This method is called after all plugins are executed by the WorkfloKernel.
    void
    init(WorkflowContext ctx)
    This method is called before the WorkflowKernel starts the execution.
    ItemCollection
    run(ItemCollection document, ItemCollection event)
     

  • Methodendetails

    • init

      void init(WorkflowContext ctx) throws PluginException
      This method is called before the WorkflowKernel starts the execution. A plugin can for example initialize external resources or data.
      Parameter:
      model - provides an instance to the current bpmn model (Note: this instance is not thread save!)
      Löst aus:
      PluginException

    • run

      ItemCollection run(ItemCollection document, ItemCollection event) throws PluginException
      Parameter:
      document - the workitem to be processed
      event - the workflow event containing the processing instructions
      Gibt zurück:
      updated workitem for further processing
      Löst aus:
      PluginException

    • close

      void close(boolean rollbackTransaction) throws PluginException
      This method is called after all plugins are executed by the WorkfloKernel. A plugin my tear down external resources.
      Parameter:
      rollbackTransaction - indicates if the current transaction will be rolled back.
      Löst aus:
      PluginException