Source code: domain/VolatileProcess.java

   /*
    * This file is part of the WfMCore/WfMOpen project.
    * Copyright (C) 2001-2003 Danet GmbH (www.danet.de), GS-AN.
    * All rights reserved.
    *
    * This program is free software; you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
    * the Free Software Foundation; either version 2 of the License, or
    * (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   *
   * $Id: VolatileProcess.java,v 1.38 2003/09/24 15:19:09 lipp Exp $
   *
   * $Log: VolatileProcess.java,v $
   * Revision 1.38  2003/09/24 15:19:09  lipp
   * Updated to interface changes.
   *
   * Revision 1.37  2003/09/22 12:56:53  lipp
   * Fixed key creation for block activity (must be unique).
   *
   * Revision 1.36  2003/09/21 21:28:14  lipp
   * Introducing "virtual" block activity.
   *
   * Revision 1.35  2003/06/27 09:44:13  lipp
   * Fixed copyright/license information.
   *
   * Revision 1.34  2003/05/31 20:05:25  lipp
   * Added support for different condition types.
   *
   * Revision 1.33  2003/05/16 08:08:49  lipp
   * Handling OTHERWISE condition type.
   *
   * Revision 1.32  2003/05/14 13:05:06  lipp
   * Made creator of subprocess inherited attribute.
   *
   * Revision 1.31  2003/05/08 08:14:17  lipp
   * Adapted to changes.
   *
   * Revision 1.30  2003/05/05 14:39:50  lipp
   * Moved code for removing process automatically to event handling.
   *
   * Revision 1.29  2003/05/05 07:04:51  lipp
   * Handling parameters for sub-flow now.
   *
   * Revision 1.28  2003/04/26 16:12:35  lipp
   * Moved some classes to reduce package dependencies.
   *
   * Revision 1.27  2003/04/19 18:33:28  lipp
   * Improved handling of info.
   *
   * Revision 1.26  2003/02/03 10:09:27  lipp
   * Adapted to latest changes in src.
   *
   * Revision 1.25  2002/11/26 11:23:29  lipp
   * Modified RemoteException comment.
   *
   * Revision 1.24  2002/11/25 21:16:23  lipp
   * Adapted to transition interface changes.
   *
   * Revision 1.23  2002/11/15 15:13:54  lipp
   * Clarified usage of transitions as attribute. Included in caching.
   *
   * Revision 1.22  2002/11/04 08:40:25  barzik
   * adapted to several modifications in the workflow component
   *
   * Revision 1.21  2002/10/21 19:08:05  lipp
   * Continuing implementation of new state handling.
   *
   * Revision 1.20  2002/10/21 11:54:23  lipp
   * Better suspend state handling.
   *
   * Revision 1.19  2002/10/18 13:46:02  lipp
   * Getting on with adaptions...
   *
   * Revision 1.18  2002/10/09 14:27:33  lipp
   * Intermediate, compilable state.
   *
   * Revision 1.17  2002/10/09 07:30:29  lipp
   * log fire events as debug.
   *
   * Revision 1.16  2002/10/08 15:32:39  lipp
   * Providing base implementations for more methods in AbstractActivity.
   *
   * Revision 1.15  2002/10/02 21:23:25  lipp
   * Some adaptations.
   *
   * Revision 1.14  2002/09/17 06:53:17  huaiyang
   * Do not use super.init(null).
   *
   * Revision 1.13  2002/08/30 11:38:51  lipp
   * Added create time as process method.
  *
  * Revision 1.12  2002/08/30 09:06:40  lipp
  * Renamed internal state to typed state and use polymorphism for type
  * names where possible.
  *
  * Revision 1.11  2002/08/30 07:58:19  huaiyang
  * Separation of Domain class and persistent class more cleaner.
  *
  * Revision 1.10  2002/08/29 20:55:34  lipp
  * Added last state time persistence and process create time.
  *
  * Revision 1.9  2002/08/29 14:33:17  huaiyang
  * Use createTransitionRef.
  *
  * Revision 1.8  2002/08/29 11:00:45  huaiyang
  * Move operation methods towards domain for new style of procDefSpec.
  *
  * Revision 1.7  2002/08/28 15:04:34  huaiyang
  * New methods in AbstractProcess.
  *
  * Revision 1.6  2002/08/28 12:58:03  lipp
  * Fixed unittests.
  *
  * Revision 1.5  2002/08/28 12:47:20  lipp
  * Starting new process generation.
  *
  * Revision 1.4  2002/08/28 09:54:51  lipp
  * Moving domain logic to domain package...
  *
  * Revision 1.3  2002/08/27 11:36:37  lipp
  * Better use of ProcessDefinition.
  *
  * Revision 1.2  2002/08/25 20:55:54  lipp
  * Clearing up use of ProcessDefinition.
  *
  * Revision 1.1  2002/08/22 15:19:34  lipp
  * Redesign of EJB persistence.
  *
  */
 package domain;
 
 import java.io.Serializable;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import java.rmi.RemoteException;
 import java.security.Principal;
 
 import org.jdom.Element;
 
 import de.danet.an.workflow.omgcore.CannotChangeRequesterException;
 import de.danet.an.workflow.omgcore.InvalidPerformerException;
 import de.danet.an.workflow.omgcore.ProcessData;
 import de.danet.an.workflow.omgcore.WfActivity;
 import de.danet.an.workflow.omgcore.WfAuditEvent;
 import de.danet.an.workflow.omgcore.WfProcess;
 import de.danet.an.workflow.omgcore.WfProcessMgr;
 import de.danet.an.workflow.omgcore.WfRequester;
 
 import de.danet.an.workflow.api.Activity;
 import de.danet.an.workflow.api.Activity.JoinAndSplitMode;
 import de.danet.an.workflow.api.InvalidKeyException;
 import de.danet.an.workflow.api.Process;
 import de.danet.an.workflow.api.ProcessDefinition;
 import de.danet.an.workflow.api.ProcessDefinitionDirectory;
 import de.danet.an.workflow.api.Transition;
 
 import de.danet.an.workflow.domain.AbstractProcess;
 import de.danet.an.workflow.domain.TransitionDefinition;
 
 import de.danet.an.workflow.apix.ExtActivity;
 
 /**
  * This class implements the persistance layer required by
  * <code>AbstractProcess</code> by, well, providing no
  * persistence ...
  *
  * @author <a href="mailto:lipp@danet.de"></a>
  * @version $Revision: 1.38 $
  */
 
 public class VolatileProcess extends AbstractProcess {
     /** Persistent attribute <code>id</code>. */
     private String paId;
     
     /** Persistent attribute <code>key</code>. */
     private String paKey;
 
     /** Persistent attribute <code>name</code>. */
     private String paName;
 
     /** Persistent attribute <code>createTime</code>. */
     private Date paCreateTime = new Date();
 
     /** Persistent attribute <code>description</code>. */
     private String paDescription;
 
     /** Persistent attribute <code>priority</code>. */
     private Priority paPriority = Priority.NORMAL;
 
     /** Persistent attribute <code>typedState</code>. */
     private State paTypedState;
 
     /** Persistent attribute <code>lastStateTime</code>. */
     private Date paLastStateTime;
 
     /** Persistent attribute <code>processMgr</code>. */
     private String paProcessMgr;
 
     /** Persistent attribute <code>requester</code>. */
     private WfRequester paRequester;
 
     /** Persistent attribute <code>processDef</code>. */
     private ProcessDefinition paProcessDef;
 
     /** Persistent attribute <code>processData</code>. */
     private ProcessData paProcessData;
     
     /** Persistent attribute <code>processMgrName</code>. */
     private String paProcessMgrName;
 
     /** Persistent attribute <code>processMgrVersion</code>. */
     private String paProcessMgrVersion;
 
     // normal attributes
     private Collection activities = new ArrayList();
     private WfProcessMgr pmgr = new VolatileMgr ();
 
     private static int procKeyGen = 1;
 
     private List transitions = new ArrayList();
 
     /**
      * Creates an instance of <code>TestProcess</code>
      * with all attributes initialized to default values.
      * @param key a <code>String</code> value
      */
     public VolatileProcess (String key) {
   setPaLastStateTime (new Date());
   setPaPriority (Priority.NORMAL);
   setPaTypedState (NotRunningState.NOT_STARTED);
   paKey = key;  
     }
 
     /**
      * Creates an instance of <code>TestProcess</code>
      * with all attributes initialized to default values.
      */
     public VolatileProcess () {
   this (Integer.toString(procKeyGen++));
     }
 
     /**
      * Describe <code>thisRemote</code> method here.
      *
      * @return a <code>Process</code> value
      */
     protected Process thisRemote () {
   return this;
     }
 
     /**
      * Remove this process.
      */
     protected void removeThis () {
     }
 
     /**
      * Returns the process manager which created this process.
      * @return the associated process manager.
      * @throws RemoteException if a system-level error occurs.
      */
     public WfProcessMgr manager () throws RemoteException {
   return pmgr;
     }
 
     //
     // Implement abstract methods as unsupported
     //
 
     /**
      * Describe <code>createTime</code> method here.
      *
      * @return a <code>Date</code> value
      */
     public Date createTime () {
   return getPaCreateTime();
     }
 
     /**
      * Return the creator of the process.
      * @return the process creator.
      */
     public Principal processCreator() {
   return null;
     }
 
     /**
      * Describe <code>setActivities</code> method here.
      *
      * @param act a <code>Collection</code> value
      */
     public void setActivities(Collection act) {
   activities = act;
     }
 
     /**
      * Describe <code>addActivity</code> method here.
      *
      * @param act an <code>Activity</code> value
      */
     public void addActivity(Activity act) {
   activities.add(act);
     }
 
     /**
      * Describe <code>addTransition</code> method here.
      *
      * @param id a <code>String</code> value
      * @param from an <code>Activity</code> value
      * @param to an <code>Activity</code> value
      */
     public void addTransition(String id, String group, int order, 
             Activity from, Activity to) {
   addTransition(id, group, order, from, to, null);
     }
 
     /**
      * Describe <code>addTransition</code> method here.
      *
      * @param id a <code>String</code> value
      * @param from an <code>Activity</code> value
      * @param to an <code>Activity</code> value
      * @param cond condition.
      */
     public void addTransition(String id, String group, int order, 
             Activity from, Activity to, String cond) {
   doCreateTransition(id, group, order, from, to, 
          Transition.COND_TYPE_CONDITION, cond);
     }
 
     /**
      * Gets a list of transitions for this process.
      * The method is public, because the transition manager needs
      * access to the transitions of a process.
      * @return list of transitions for this process
      * @throws RemoteException if a system-level error occurs.
      */
     public List transitions() throws RemoteException {
   return transitions;
     }
 
     /**
      * Provide a new unique activity key.
      *
      * @return the key.
      */
     protected Long createActivityKey () {
   throw new UnsupportedOperationException ();
     }
 
     /**
      * Describe <code>createActivity</code> method here.
      *
      * @param actElement an <code>Element</code> value
      * @param jm a <code>JoinAndSplitMode</code> value
      * @param sm a <code>JoinAndSplitMode</code> value
      * @return a <code>WfActivity</code> value
      */
     protected WfActivity createActivity 
   (Element actElement, Long blockId, 
    JoinAndSplitMode jm, JoinAndSplitMode sm) {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>requester</code> method here.
      *
      * @return a <code>WfRequester</code> value
      * @exception RemoteException if an error occurs
      */
     public WfRequester requester() throws RemoteException {
   return new WfRequester () {
     public Collection performers() throws RemoteException {
         throw new UnsupportedOperationException();
     }
     public boolean isMemberOfPerformers(WfProcess member) 
         throws RemoteException {
         throw new UnsupportedOperationException();
     }
     public void receiveEvent (WfAuditEvent e)
         throws InvalidPerformerException, RemoteException {
         throw new UnsupportedOperationException();
     }
       };
     }
 
     /**
      * Return the process definition directory.
      * While there is no immediate relation between a process
      * instance and the known process definitions, the definitions
      * nevertheless make up part of the environment of a process.
      * Specifically, this method is needed to start a sub-process
      * in an activity.
      * @return the process definition directory
      * @throws RemoteException if a system level error occurs.
      */
     public ProcessDefinitionDirectory processDefinitionDirectory () {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>getXPDL</code> method here.
      *
      * @return a <code>String</code> value
      */
     public String getXPDL() {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>steps</code> method here.
      *
      * @return a <code>Collection</code> value
      */
     public Collection steps() {
   return activities;
     }
 
     /**
      * Describe <code>processDefinition</code> method here.
      *
      * @return a <code>ProcessDefinition</code> value
      * @exception RemoteException if an error occurs
      */
     public ProcessDefinition processDefinition() throws RemoteException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Returns <code>true</code> if the process will be removed automatically
      * on completion.
      */
     public boolean removeOnClose () throws RemoteException {
   return false;
     }
 
     /**
      * Describe <code>history</code> method here.
      *
      * @return a <code>Collection</code> value
      * @exception RemoteException if an error occurs
      */
     public Collection history() throws RemoteException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>setRequester</code> method here.
      *
      * @param requester a <code>WfRequester</code> value
      * @exception RemoteException if an error occurs
      * @exception CannotChangeRequesterException if an error occurs
      */
     public void  setRequester(WfRequester requester)
   throws RemoteException,
          CannotChangeRequesterException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>activityByKey</code> method here.
      *
      * @param key a <code>String</code> value
      * @return an <code>Activity</code> value
      * @exception RemoteException if an error occurs
      * @exception InvalidKeyException if an error occurs
      */
     public Activity activityByKey (String key) throws 
   RemoteException, InvalidKeyException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Return an arbitrary activity with the given key. The activity
      * need not belong to this process.
      * @param key activity key
      * @return the activity
      * @throws InvalidKeyException if the activity cannot be found
      */
     protected ExtActivity lookupActivity (String key)
   throws InvalidKeyException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>processContext</code> method here.
      *
      * @return a <code>ProcessData</code> value
      * @exception RemoteException if an error occurs
      */
     public ProcessData processContext () throws RemoteException {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>complete</code> method here.
      *
      * @param activity a <code>Long</code> value
      * @param s a <code>State</code> value
      */
     public void complete (Long activity, State s) {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Describe <code>createTransitionRef</code> method here.
      *
      * @param serialNum a <code>long</code> value
      * @param fromActivity an <code>Activity</code> value
      * @param toActivity an <code>Activity</code> value
      */
     protected void createTransitionRef 
   (long serialNum, Activity fromActivity, Activity toActivity) {
   throw new UnsupportedOperationException();
     }
     
     /**
      * Create a new transition with given id, From Activity, To Activity.
      * @param id a <code>String</code> value
      * @param fromAct an <code>Activity</code> value
      * @param toAct an <code>Activity</code> value
      * @return the created transition.
      */
     protected Transition createTransition
   (String id, String group, int order, Activity fromAct, 
    Activity toAct) {
   return doCreateTransition (id,group,order,fromAct,toAct,
            Transition.COND_TYPE_CONDITION,null);
     }
 
     /**
      * Create a new transition with given id, From Activity, To Activity.
      * @param id a <code>String</code> value
      * @param fromAct an <code>Activity</code> value
      * @param toAct an <code>Activity</code> value
      * @param cond condition.
      * @return the created transition.
      */
     protected Transition doCreateTransition
   (String id, String group, int order, Activity fromAct, 
    Activity toAct, int condType, String cond) {
   Transition trans = new TransitionDefinition
       (paKey,id,group,order,fromAct,toAct,condType,cond);
   transitions.add(trans);
   return trans;
     }
 
     /**
      * Describe <code>activityRequesterInfo</code> method here.
      *
      * @param req a <code>WfRequester</code> value
      * @return a <code>WfAuditEvent</code> value
      */
     protected WfAuditEvent activityRequesterInfo(WfRequester req) {
   throw new UnsupportedOperationException();
     }
 
     /**
      * Returns an audit event object with process relevant information
      * initialized.
      * @return the process related information.
      */
     public WfAuditEvent auditEventBase() {
   return auditEventBase(null);
     }
 
     /**
      * Start a timer that will call <code>handleTimeout</code> at the
      * given date with the given info.
      * @param due target date
      * @param info the context
      */
     public void startTimer (Date due, Serializable info) {
     }
 
     /**
      * Stop all timers that this object has created.
      */
     public void stopTimers () {
     }
 
     //
     // Implement accessor methods for the persistent attributes
     //
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>key</code>.
      *
      * @return the value of key.
      */
     protected String getPaKey() {
   return paKey;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>name</code>.
      *
      * @return the value of name.
      * @see #setPaName
      */
     protected String getPaName() {
   return paName;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>name</code>.
      *
      * @param newName the new value of name.
      * @see #getPaName
      */
     protected void setPaName(String newName) {
   paName = newName;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>description</code>.
      *
      * @return the value of description.
      * @see #setPaDescription
      */
     protected String getPaDescription() {
   return paDescription;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>description</code>.
      *
      * @param newDescription the new value of description.
      * @see #getPaDescription
      */
     protected void setPaDescription(String newDescription) {
   paDescription = newDescription;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>priority</code>.
      *
      * @return the value of priority.
      * @see #setPaPriority
      */
     protected Priority getPaPriority() {
   return paPriority;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>priority</code>.
      *
      * @param newPriority the new value of priority.
      * @see #getPaPriority
      */
     protected void setPaPriority(Priority newPriority) {
   paPriority = newPriority;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>typedState</code>.
      *
      * @return the value of typedState.
      * @see #setPaTypedState
      */
     protected State getPaTypedState() {
   return paTypedState;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>lastStateTime</code>.
      *
      * @return the value of lastStateTime.
      * @see #setPaLastStateTime
      */
     protected Date getPaLastStateTime() {
   return paLastStateTime;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>lastStateTime</code>.
      *
      * @param newLastStateTime the new value of lastStateTime.
      * @see #getPaLastStateTime
      */
     protected void setPaLastStateTime(Date newLastStateTime) {
   paLastStateTime = newLastStateTime;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>typedState</code>.
      *
      * @param newTypedState the new value of typedState.
      * @see #getPaTypedState
      */
     protected void setPaTypedState(State newTypedState) {
   paTypedState = newTypedState;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>processMgr</code>.
      *
      * @return the value of processMgr.
      * @see #setPaProcessMgr
      */
     protected String getPaProcessMgr() {
   return paProcessMgr;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>processMgr</code>.
      *
      * @param newProcessMgr the new value of processMgr.
      * @see #getPaProcessMgr
      */
     protected void setPaProcessMgr(String newProcessMgr) {
   paProcessMgr = newProcessMgr;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>requester</code>.
      *
      * @return the value of requester.
      * @see #setPaRequester
      */
     protected WfRequester getPaRequester() {
   return paRequester;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>requester</code>.
      *
      * @param newRequester the new value of requester.
      * @see #getPaRequester
      */
     protected void setPaRequester(WfRequester newRequester) {
   paRequester = newRequester;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>processDef</code>.
      *
      * @return the value of processDef.
      * @see #setPaProcessDef
      */
     protected ProcessDefinition getPaProcessDef() {
   return paProcessDef;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>processDef</code>.
      *
      * @param newProcessDef the new value of processDef.
      * @see #getPaProcessDef
      */
     protected void setPaProcessDef(ProcessDefinition newProcessDef) {
   paProcessDef = newProcessDef;
     }
     
     /**
      * The getter method implementation for the persistent 
      * attribute <code>processData</code>.
      *
      * @return the value of processData.
      * @see #setPaProcessData
      */
     protected ProcessData getPaProcessData() {
   return paProcessData;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>processData</code>.
      *
      * @param newProcessData the new value of processData.
      * @see #getPaProcessData
      */
     protected void setPaProcessData(ProcessData newProcessData) {
   paProcessData = newProcessData;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>processMgrName</code>.
      *
      * @return the value of processMgrName.
      * @see #setPaProcessMgrName
      */
     protected String getPaProcessMgrName() {
   return paProcessMgrName;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>processMgrName</code>.
      *
      * @param newProcessMgrName the new value of processMgrName.
      * @see #getPaProcessMgrName
      */
     protected void setPaProcessMgrName(String newProcessMgrName) {
   paProcessMgrName = newProcessMgrName;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>processMgrVersion</code>.
      *
      * @see #setPaProcessMgrVersion
      * @return the value of processMgrVersion.
      */
     protected String getPaProcessMgrVersion() {
   return paProcessMgrVersion;
     }
 
     /**
      * The setter method implementation for the persistent 
      * attribute <code>processMgrVersion</code>.
      *
      * @param newProcessMgrVersion the new value of processMgrVersion.
      * @see #getPaProcessMgrVersion
      */
     protected void setPaProcessMgrVersion(String newProcessMgrVersion) {
   paProcessMgrVersion = newProcessMgrVersion;
     }
 
     /**
      * The getter method for the persistent attribute <code>id</code>.
      *
      * @return the value of process id.
      * @see #setPaId
      */
     protected String getPaId() {
   return paId;
     }
 
     /**
      * The setter method for the persistent attribute <code>Id</code>.
      *
      * @param newId the new value of process id.
      * @see #getPaId
      */
     protected void setPaId(String newId) {
   paId = newId;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>createTime</code>.
      *
      * @return the value of createTime.
      * @see #setPaCreateTime
      */
     protected Date getPaCreateTime() {
   return paCreateTime;
     }
 
     /**
      * The getter method implementation for the persistent 
      * attribute <code>blockDeadlines</code>.
      *
      * @see #setPaBlockDeadlines
      * @return the value of blockDeadlines.
      */
     protected Map getPaBlockDeadlines() {
   return new HashMap ();
     }
 
 }