Package flexagon.fd.core.plugin

Interface PluginProvider

All Known Implementing Classes:
AbstractPartialDeployPluginProvider, AbstractPluginProvider
public interface PluginProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanup()
    This method is invoked at the end of the plugin lifecycle to allow implementations to cleanup after themselves (e.g.
    PluginResult
    execute()
    This method is invoked to perform the plugin operation's implementation.
    void
    setWorkflowExecutionContext(WorkflowExecutionContext pExecutionContext)
    This method is called to set the ExecutionContext for the plugin operation execution.
    void
    validate()
    This method is invoked to validate the preconditions of the plugin operation have been satisfied.

  • Method Details

    • setWorkflowExecutionContext

      void setWorkflowExecutionContext(WorkflowExecutionContext pExecutionContext)
      This method is called to set the ExecutionContext for the plugin operation execution. Implementations should set the context as an instance variable for use throughout the plugin operation's execution lifecycle.
      Parameters:
      pExecutionContext - the workflow execution context

    • execute

      PluginResult execute() throws FlexCheckedException
      This method is invoked to perform the plugin operation's implementation.
      Returns:
      the result of the plugin operation's execution
      Throws:
      FlexCheckedException - if any exception occurs during the execution of the plugin operation

    • validate

      void validate() throws FlexCheckedException
      This method is invoked to validate the preconditions of the plugin operation have been satisfied. Implementations should perform validations such as required properties being set, and throw a FlexCheckedException if the validation check fails.

      Implementors should also make an attempt to perform all validations and throw a single exception where possible, and avoid having users track down one validation issue per execution.

      Throws:
      FlexCheckedException - if the preconditions of the plugin operation are not met.

    • cleanup

      void cleanup()
      This method is invoked at the end of the plugin lifecycle to allow implementations to cleanup after themselves (e.g. delete temporary files, close connections, etc.).

      Note that this method is invoked in the finally clause surrounding the plugin execution. This allows the implementations to avoid wrapping try/catch/finally around operations for the purpose of cleanup. Since an exception can occur at various points, implementations must take precautions in performing the necessary null checking.

      Also note that any exceptions raised during the cleanup will be logged and ignored.