WorkflowManager (Apache JSPWiki 2.11.0.M6 API)

java.lang.Object
- org.apache.wiki.workflow.WorkflowManager

All Implemented Interfaces:

EventListener, WikiEventListener
```
public class WorkflowManager
extends Object
implements WikiEventListener
```
Monitor class that tracks running Workflows. The WorkflowManager also keeps track of the names of users or groups expected to approve particular Workflows.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`PROPERTY_APPROVER_PREFIX` The prefix to use for looking up `jspwiki.properties` approval roles.
`static String`	`WF_UP_CREATE_SAVE_APPROVER` The name of the key from jspwiki.properties which defines who shall approve the workflow of creating a user profile.
`static String`	`WF_UP_CREATE_SAVE_ATTR_SAVED_PROFILE` The workflow attribute which stores the user profile.
`static String`	`WF_UP_CREATE_SAVE_DECISION_MESSAGE_KEY` The message key for storing the Decision text for saving a user profile.
`static String`	`WF_UP_CREATE_SAVE_FACT_PREFS_EMAIL` Fact name for storing the preferences' email.
`static String`	`WF_UP_CREATE_SAVE_FACT_PREFS_FULL_NAME` Fact name for storing the preferences' full name.
`static String`	`WF_UP_CREATE_SAVE_FACT_PREFS_LOGIN_NAME` Fact name for storing the preferences' login name.
`static String`	`WF_UP_CREATE_SAVE_FACT_SUBMITTER` Fact name for storing a the submitter name.
`static String`	`WF_WP_SAVE_APPROVER` The name of the key from jspwiki.properties which defines who shall approve the workflow of storing a wikipage.
`static String`	`WF_WP_SAVE_ATTR_PRESAVE_WIKI_CONTEXT` The workflow attribute which stores the wikiContext.
`static String`	`WF_WP_SAVE_DECISION_MESSAGE_KEY` The message key for storing the Decision text for saving a page.
`static String`	`WF_WP_SAVE_FACT_CURRENT_TEXT` Fact name for storing the current text.
`static String`	`WF_WP_SAVE_FACT_DIFF_TEXT` Fact name for storing a diff text.
`static String`	`WF_WP_SAVE_FACT_IS_AUTHENTICATED` Fact name for storing whether the user is authenticated or not.
`static String`	`WF_WP_SAVE_FACT_PAGE_NAME` Fact name for storing the page name.
`static String`	`WF_WP_SAVE_FACT_PROPOSED_TEXT` Fact name for storing the proposed (edited) text.
`static String`	`WF_WP_SAVE_REJECT_MESSAGE_KEY` The message key for rejecting the decision to save the page.

Constructor Summary

Constructors
Constructor and Description

WorkflowManager()
Constructs a new WorkflowManager, with an empty workflow cache.

Constructors
Constructor and Description
`WorkflowManager()` Constructs a new WorkflowManager, with an empty workflow cache.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(WikiEvent event)` Listens for `WorkflowEvent` objects emitted by Workflows.
`protected void`	`add(Workflow workflow)` Protected helper method that adds a newly created Workflow to the cache, and sets its `workflowManager` and `Id` properties if not set.
`Principal`	`getApprover(String messageKey)` Looks up and resolves the actor who approves a Decision for a particular Workflow, based on the Workflow's message key.
`List<Workflow>`	`getCompletedWorkflows()` Returns a collection of finished workflows; that is, those that have aborted or completed.
`DecisionQueue`	`getDecisionQueue()` Returns the DecisionQueue associated with this WorkflowManager
`protected WikiEngine`	`getEngine()` Protected helper method that returns the associated WikiEngine
`Collection<Workflow>`	`getOwnerWorkflows(WikiSession session)` Returns the current workflows a wiki session owns.
`Collection<Workflow>`	`getWorkflows()` Returns a collection of the currently active workflows.
`void`	`initialize(WikiEngine engine, Properties props)` Initializes the WorkflowManager using a specfied WikiEngine and properties.
`protected void`	`remove(Workflow workflow)` Protected helper method that removes a specified Workflow from the cache, and moves it to the workflow history list.
`boolean`	`requiresApproval(String messageKey)` Returns `true` if a workflow matching a particular key contains an approval step.
`void`	`start(Workflow workflow)` Adds a new workflow to the set of workflows and starts it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WF_WP_SAVE_ATTR_PRESAVE_WIKI_CONTEXT
```
public static final String WF_WP_SAVE_ATTR_PRESAVE_WIKI_CONTEXT
```
    The workflow attribute which stores the wikiContext.
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_APPROVER
```
public static final String WF_WP_SAVE_APPROVER
```
    The name of the key from jspwiki.properties which defines who shall approve the workflow of storing a wikipage. Value is "workflow.saveWikiPage"
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_DECISION_MESSAGE_KEY
```
public static final String WF_WP_SAVE_DECISION_MESSAGE_KEY
```
    The message key for storing the Decision text for saving a page. Value is "decision.saveWikiPage".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_REJECT_MESSAGE_KEY
```
public static final String WF_WP_SAVE_REJECT_MESSAGE_KEY
```
    The message key for rejecting the decision to save the page. Value is "notification.saveWikiPage.reject".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_FACT_PAGE_NAME
```
public static final String WF_WP_SAVE_FACT_PAGE_NAME
```
    Fact name for storing the page name. Value is "fact.pageName".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_FACT_DIFF_TEXT
```
public static final String WF_WP_SAVE_FACT_DIFF_TEXT
```
    Fact name for storing a diff text. Value is "fact.diffText".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_FACT_CURRENT_TEXT
```
public static final String WF_WP_SAVE_FACT_CURRENT_TEXT
```
    Fact name for storing the current text. Value is "fact.currentText".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_FACT_PROPOSED_TEXT
```
public static final String WF_WP_SAVE_FACT_PROPOSED_TEXT
```
    Fact name for storing the proposed (edited) text. Value is "fact.proposedText".
    
    See Also:
    
    Constant Field Values
  - WF_WP_SAVE_FACT_IS_AUTHENTICATED
```
public static final String WF_WP_SAVE_FACT_IS_AUTHENTICATED
```
    Fact name for storing whether the user is authenticated or not. Value is "fact.isAuthenticated".
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_ATTR_SAVED_PROFILE
```
public static final String WF_UP_CREATE_SAVE_ATTR_SAVED_PROFILE
```
    The workflow attribute which stores the user profile.
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_APPROVER
```
public static final String WF_UP_CREATE_SAVE_APPROVER
```
    The name of the key from jspwiki.properties which defines who shall approve the workflow of creating a user profile. Value is "workflow.createUserProfile"
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_DECISION_MESSAGE_KEY
```
public static final String WF_UP_CREATE_SAVE_DECISION_MESSAGE_KEY
```
    The message key for storing the Decision text for saving a user profile. Value is "decision.createUserProfile".
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_FACT_SUBMITTER
```
public static final String WF_UP_CREATE_SAVE_FACT_SUBMITTER
```
    Fact name for storing a the submitter name. Value is "fact.submitter".
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_FACT_PREFS_LOGIN_NAME
```
public static final String WF_UP_CREATE_SAVE_FACT_PREFS_LOGIN_NAME
```
    Fact name for storing the preferences' login name. Value is "prefs.loginname".
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_FACT_PREFS_FULL_NAME
```
public static final String WF_UP_CREATE_SAVE_FACT_PREFS_FULL_NAME
```
    Fact name for storing the preferences' full name. Value is "prefs.fullname".
    
    See Also:
    
    Constant Field Values
  - WF_UP_CREATE_SAVE_FACT_PREFS_EMAIL
```
public static final String WF_UP_CREATE_SAVE_FACT_PREFS_EMAIL
```
    Fact name for storing the preferences' email. Value is "prefs.email".
    
    See Also:
    
    Constant Field Values
  - PROPERTY_APPROVER_PREFIX
```
protected static final String PROPERTY_APPROVER_PREFIX
```
    The prefix to use for looking up jspwiki.properties approval roles.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkflowManager
```
public WorkflowManager()
```
    Constructs a new WorkflowManager, with an empty workflow cache. New Workflows are automatically assigned unique identifiers, starting with 1.
- Method Detail
  - start
```
public void start(Workflow workflow)
           throws WikiException
```
    Adds a new workflow to the set of workflows and starts it. The new workflow is automatically assigned a unique ID. If another workflow with the same ID already exists, this method throws a WikIException.
    
    Parameters:
    
    workflow - the workflow to start
    
    Throws:
    
    WikiException - if a workflow the automatically assigned ID already exist; this should not happen normally
  - getWorkflows
```
public Collection<Workflow> getWorkflows()
```
    Returns a collection of the currently active workflows.
    
    Returns:
    
    the current workflows
  - getCompletedWorkflows
```
public List<Workflow> getCompletedWorkflows()
```
    Returns a collection of finished workflows; that is, those that have aborted or completed.
    
    Returns:
    
    the finished workflows
  - initialize
```
public void initialize(WikiEngine engine,
                       Properties props)
```
    Initializes the WorkflowManager using a specfied WikiEngine and properties. Any properties that begin with PROPERTY_APPROVER_PREFIX will be assumed to be Decisions that require approval. For a given property key, everything after the prefix denotes the Decision's message key. The property value indicates the Principal (Role, GroupPrincipal, WikiPrincipal) that must approve the Decision. For example, if the property key/value pair is jspwiki.approver.workflow.saveWikiPage=Admin, the Decision's message key is workflow.saveWikiPage. The Principal Admin will be resolved via AuthorizationManager.resolvePrincipal(String).
    
    Parameters:
    
    engine - the wiki engine to associate with this WorkflowManager
    
    props - the wiki engine's properties
  - requiresApproval
```
public boolean requiresApproval(String messageKey)
```
    Returns true if a workflow matching a particular key contains an approval step.
    
    Parameters:
    
    messageKey - the name of the workflow; corresponds to the value returned by Workflow.getMessageKey().
    
    Returns:
    
    the result
  - getApprover
```
public Principal getApprover(String messageKey)
                      throws WikiException
```
    Looks up and resolves the actor who approves a Decision for a particular Workflow, based on the Workflow's message key. If not found, or if Principal is Unresolved, throws WikiException. This particular implementation always returns the GroupPrincipal Admin
    
    Parameters:
    
    messageKey - the Decision's message key
    
    Returns:
    
    the actor who approves Decisions
    
    Throws:
    
    WikiException - if the message key was not found, or the Principal value corresponding to the key could not be resolved
  - getEngine
```
protected WikiEngine getEngine()
```
    Protected helper method that returns the associated WikiEngine
    
    Returns:
    
    the wiki engine
  - getDecisionQueue
```
public DecisionQueue getDecisionQueue()
```
    Returns the DecisionQueue associated with this WorkflowManager
    
    Returns:
    
    the decision queue
  - getOwnerWorkflows
```
public Collection<Workflow> getOwnerWorkflows(WikiSession session)
```
    Returns the current workflows a wiki session owns. These are workflows whose Workflow.getOwner() method returns a Principal also possessed by the wiki session (see WikiSession.getPrincipals()). If the wiki session is not authenticated, this method returns an empty Collection.
    
    Parameters:
    
    session - the wiki session
    
    Returns:
    
    the collection workflows the wiki session owns, which may be empty
  - actionPerformed
```
public void actionPerformed(WikiEvent event)
```
    Listens for WorkflowEvent objects emitted by Workflows. In particular, this method listens for WorkflowEvent.CREATED, WorkflowEvent.ABORTED and WorkflowEvent.COMPLETED events. If a workflow is created, it is automatically added to the cache. If one is aborted or completed, it is automatically removed.
    
    Specified by:
    
    actionPerformed in interface WikiEventListener
    
    Parameters:
    
    event - the event passed to this listener
  - add
```
protected void add(Workflow workflow)
```
    Protected helper method that adds a newly created Workflow to the cache, and sets its workflowManager and Id properties if not set.
    
    Parameters:
    
    workflow - the workflow to add
  - remove
```
protected void remove(Workflow workflow)
```
    Protected helper method that removes a specified Workflow from the cache, and moves it to the workflow history list. This method defensively checks to see if the workflow has not yet been removed.
    
    Parameters:
    
    workflow - the workflow to remove

Class WorkflowManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WF_WP_SAVE_ATTR_PRESAVE_WIKI_CONTEXT

WF_WP_SAVE_APPROVER

WF_WP_SAVE_DECISION_MESSAGE_KEY

WF_WP_SAVE_REJECT_MESSAGE_KEY

WF_WP_SAVE_FACT_PAGE_NAME

WF_WP_SAVE_FACT_DIFF_TEXT

WF_WP_SAVE_FACT_CURRENT_TEXT

WF_WP_SAVE_FACT_PROPOSED_TEXT

WF_WP_SAVE_FACT_IS_AUTHENTICATED

WF_UP_CREATE_SAVE_ATTR_SAVED_PROFILE

WF_UP_CREATE_SAVE_APPROVER

WF_UP_CREATE_SAVE_DECISION_MESSAGE_KEY

WF_UP_CREATE_SAVE_FACT_SUBMITTER

WF_UP_CREATE_SAVE_FACT_PREFS_LOGIN_NAME

WF_UP_CREATE_SAVE_FACT_PREFS_FULL_NAME

WF_UP_CREATE_SAVE_FACT_PREFS_EMAIL

PROPERTY_APPROVER_PREFIX

Constructor Detail

WorkflowManager

Method Detail

start

getWorkflows

getCompletedWorkflows

initialize

requiresApproval

getApprover

getEngine

getDecisionQueue

getOwnerWorkflows

actionPerformed

add

remove