Class AbstractPlugin
- java.lang.Object
-
- org.imixs.workflow.engine.plugins.AbstractPlugin
-
- All Implemented Interfaces:
Plugin
- Direct Known Subclasses:
AccessPlugin
,AnalysisPlugin
,ApplicationPlugin
,ApproverPlugin
,DocumentComposerPlugin
,HistoryPlugin
,IntervalPlugin
,LogPlugin
,MailPlugin
,OwnerPlugin
,ReportPlugin
,ResultPlugin
,RulePlugin
,SplitAndJoinPlugin
,TaxonomyPlugin
,VersionPlugin
public abstract class AbstractPlugin extends Object implements Plugin
This abstract class implements different helper methods used by subclasses- Version:
- 1.1
- Author:
- Ralph Soika
- See Also:
WorkflowManager
-
-
Field Summary
Fields Modifier and Type Field Description static String
INVALID_ITEMVALUE_FORMAT
static String
INVALID_PROPERTYVALUE_FORMAT
-
Constructor Summary
Constructors Constructor Description AbstractPlugin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close(boolean rollbackTransaction)
This method is called after all plugins are executed by the WorkfloKernel.WorkflowContext
getCtx()
WorkflowService
getWorkflowService()
Returns an instance of the WorkflowService EJB.void
init(WorkflowContext actx)
Initialize Plugin and get an instance of the EJB Session Contextvoid
mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList)
This method merges the values of fieldList into valueList and test for duplicates.List<?>
uniqueList(List<Object> valueList)
This method removes duplicates and null values from a vector.
-
-
-
Field Detail
-
INVALID_ITEMVALUE_FORMAT
public static final String INVALID_ITEMVALUE_FORMAT
- See Also:
- Constant Field Values
-
INVALID_PROPERTYVALUE_FORMAT
public static final String INVALID_PROPERTYVALUE_FORMAT
- See Also:
- Constant Field Values
-
-
Method Detail
-
init
public void init(WorkflowContext actx) throws PluginException
Initialize Plugin and get an instance of the EJB Session Context- Specified by:
init
in interfacePlugin
- Parameters:
actx
- defines the context in which the plugin runs. The context can be used to get information about the environment- Throws:
PluginException
-
close
public void close(boolean rollbackTransaction) throws PluginException
Description copied from interface:Plugin
This method is called after all plugins are executed by the WorkfloKernel. A plugin my tear down external resources.- Specified by:
close
in interfacePlugin
- Parameters:
rollbackTransaction
- indicates if the current transaction will be rolled back.- Throws:
PluginException
-
getCtx
public WorkflowContext getCtx()
-
getWorkflowService
public WorkflowService getWorkflowService()
Returns an instance of the WorkflowService EJB.- Returns:
-
mergeFieldList
public void mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList)
This method merges the values of fieldList into valueList and test for duplicates. If an entry of the fieldList is a single key value, than the values to be merged are read from the corresponding documentContext property e.g. 'namTeam' -> maps the values of the documentContext property 'namteam' into the valueList If an entry of the fieldList is in square brackets, than the comma separated elements are mapped into the valueList e.g. '[user1,user2]' - maps the values 'user1' and 'user2' int the valueList. Also Curly brackets are allowed '{user1,user2}'- Parameters:
valueList
-fieldList
-
-
-