Property Detail

• java.util.ArrayList configFields

  An array reference, that represents fields that would be used by plugin as a reference to plugin configurations. For example, one could use ['config', 'configName'] to say that config name could be found in these parameter values. This list will be used from left to right, so, in example above configName will be used only if there is no procedure parameter with name 'config'.

• java.util.ArrayList configLocations

  An array reference with locations of plugin configurations. In all new plugins it will be set to ['ec_plugin_cfgs']. Precedence is the same as in configFields.

• Log log

  Log instance for user purposes. Log level will be auto adjusted according to the configuration 'debuglevel' parameter.

• java.util.Map<java.lang.String, java.lang.Object> pluginValues

  Map with information about the plugin

Constructor Detail

• FlowPlugin()

  Constructor

Method Detail

• Context getContext()

  This method returns already created L object. Does not require any additional parameters. If this method is being used first time, it creates new context object and returns it. Each next call will return exactly this object.

  Returns:

  previously initialized or new Context object

• java.lang.String getFlowPDFVersion()

  Determines current version of the flowpdf-groovy-lib

  Returns:

  version string

• java.lang.String getPluginName()

  Accessor for the pluginName variable

  Returns:

  plugin's name

• java.lang.String getPluginProjectName()

  Builds name of the plugin project

  Returns:

  name of to the plugin project

• java.lang.String getPluginProjectPath()

  Builds path to the plugin project

  Returns:

  property path to the plugin project

• Context newContext()

  Creates Context object. Does not require any additional parameters. Please, note, that this function always creates a new context object. If you want to use already existing context object, consider to use a FlowPlugin.getContext method.

  Returns:

  new Context object

• java.util.Map<java.lang.String, java.lang.Object> pluginInfo()

  This method should return information about a plugin

• void runStep(java.lang.String procedureName, java.lang.String stepName, java.lang.String methodName)

  This method is responsible for collecting the context information and running the procedure's step

  Parameters:

  procedureName - name of the procedure we are running in

  stepName - name of the step we are running in

  methodName - name of the step method, defined in the FlowPlugin ancestor

• void showEnvironmentInfo()

  Logs environment information