org.imixs.workflow.engine.plugins

Class AccessPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.AccessPlugin

All Implemented Interfaces:

Plugin

public class AccessPlugin
extends AbstractPlugin

This plug-in implements a generic access management control (ACL) by evaluating the configuration of a BPMN Event or BPMN Task. The plug-in updates the WorkItem attributes $ReadAccess and $WriteAccess depending on the provided information.

The following attributes defined in the model element are evaluated by the plugin:

• keyupdateacl (Boolean): if false the ACL will not be changed
• keyaddreadfields (Vector): a list of items of the current WorkItem to be applied to the read access
• keyaddwritefields (Vector): a list of items of the current WorkItem to be applied to the write access
• namaddreadaccess (Vector): Names & Groups to be applied to the read access
• namaddwriteaccess (Vector): Names & Groups to be applied to the write access

The AccessPlugin evaluates the ACL settings of the current Event element as also the ACL settings of the next Task element. If the current Event Element provides a ACL setting, the next Task element will be ignored.

Fallback Mode:

NOTE: Models generated with the first version of the Imixs-Workflow Modeler provide a different set of attributes. Therefore the plugin implements a fallback method to support deprecated models. The fallback method evaluate the following list of attributes defined in Activity Entity:

These attributes are:

• keyaccessmode (Vector): '1'=update '0'=renew
• namaddreadaccess (Vector): Names & Groups to be added /replaced
• namaddwriteaccess (Vector): Names & Groups to be added/replaced
• keyaddreadfields (Vector): Attributes of the processd workitem to add there values
• keyaddwritefields (Vector): Attributes of the processd workitem to add therevalues

Version:

3.0

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor and Description
AccessPlugin()

Method Summary

Modifier and Type	Method and Description
static void	mergeRoles(List valueList, List sourceList, ItemCollection documentContext, WorkflowService workflowService) This method merges the role names from a SourceList into a valueList and removes duplicates.
ItemCollection	run(ItemCollection adocumentContext, ItemCollection adocumentActivity) This method updates the $readAccess and $writeAccess attributes of a WorkItem depending to the configuration of a Activity Entity.

Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccessPlugin

public AccessPlugin()

Method Detail

run

public ItemCollection run(ItemCollection adocumentContext,
                          ItemCollection adocumentActivity)
                   throws PluginException

This method updates the $readAccess and $writeAccess attributes of a WorkItem depending to the configuration of a Activity Entity. The method evaluates the new model flag keyupdateacl. If 'false' then acl will not be updated.

Throws:

PluginException

mergeRoles

public static void mergeRoles(List valueList,
                              List sourceList,
                              ItemCollection documentContext,
                              WorkflowService workflowService)
                       throws PluginException

This method merges the role names from a SourceList into a valueList and removes duplicates. The AddaptText event is fired so a client can adapt a role name.

Parameters:

valueList -

sourceList -

Throws:

PluginException