org.imixs.workflow.plugins
Class AccessPlugin

java.lang.Object
  org.imixs.workflow.plugins.AccessPlugin

All Implemented Interfaces:

Plugin

public class AccessPlugin
extends java.lang.Object
implements Plugin

This Plugin module implements a generic Access management controled throught the configuration in a Workflowactivity. The Plugin updates the attriubtes $ReadAccess and $WriteAccess depending on the configuration in a ActivityEntiy.

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
• keyaddreadroles (Vector): Roles to be added/replaced
• keyaddwriteroles (Vector): Roles to added/replaced
• keyaddreadfields (Vector): Attributes of the processd workitem to add there values
• keyaddwritefields (Vector): Attributes of the processd workitem to add therevalues

  Version:

  2.0

  Author:

  Ralph Soika

  See Also:

  WorkflowManager

  Field Summary

  Fields inherited from interface org.imixs.workflow.Plugin

  PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

  Constructor Summary

  AccessPlugin()
  

  Method Summary

  void	close(int status) This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data
  void	init(WorkflowContext actx) The init Methode is usesd to initialize the plugin.
  int	run(ItemCollection adocumentContext, ItemCollection adocumentActivity) changes the $readAccess and $writeAccess attribues depending to the activityentity

  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

  init

  public void init(WorkflowContext actx)
            throws java.lang.Exception

  Description copied from interface: Plugin

  The init Methode is usesd to initialize the plugin.

  Specified by:

  init in interface Plugin

  Parameters:

  actx - defines the context in which the plugin runs a Plugin can use this context to get information about the enviroment

  Throws:

  java.lang.Exception

  run

  public int run(ItemCollection adocumentContext,
                 ItemCollection adocumentActivity)
          throws java.lang.Exception

  changes the $readAccess and $writeAccess attribues depending to the activityentity

  Specified by:

  run in interface Plugin

  Parameters:

  adocumentContext - defines the document to be processed

  adocumentActivity - defines the activity document which contains the workflowprocessing instructions

  Returns:

  the current status for this plugin

  Throws:

  java.lang.Exception

  close

  public void close(int status)
             throws java.lang.Exception

  Description copied from interface: Plugin

  This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data

  Specified by:

  close in interface Plugin

  Parameters:

  status - gives the plugin information about the current status. this parameter is deliverd by the workflowKernel.

  Throws:

  java.lang.Exception