mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
ALF-3974 Cleaned up various classes after the Form Processor refactor. Added @since tags to all new classes. Moved TaskUpdater, WorkflowBuilder and PackageManager into org.alfresco.repo.workflow.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21431 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
N Smith
275
source/java/org/alfresco/repo/workflow/PackageManager.java
Normal file
275
source/java/org/alfresco/repo/workflow/PackageManager.java
Normal file
@@ -0,0 +1,275 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
||||
*
|
||||
* This file is part of Alfresco
|
||||
*
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Alfresco 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 Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package org.alfresco.repo.workflow;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
||||
import org.alfresco.service.cmr.repository.ChildAssociationRef;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowException;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowService;
|
||||
import org.alfresco.service.namespace.NamespaceService;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.alfresco.service.namespace.RegexQNamePattern;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
|
||||
/**
|
||||
* This helper class is used to manage a workflow package. The manager is a
|
||||
* stateful object which accumulates all the changes to be made to the package
|
||||
* (such as adding and removing package items). These changes are then applied
|
||||
* to the package when either the create() or update() method is called.
|
||||
*
|
||||
* @since 3.4
|
||||
* @author Nick Smith
|
||||
*
|
||||
*/
|
||||
public class PackageManager
|
||||
{
|
||||
|
||||
private static final QName PCKG_CONTAINS = WorkflowModel.ASSOC_PACKAGE_CONTAINS;
|
||||
private static final QName PCKG_ASPECT= WorkflowModel.ASPECT_WORKFLOW_PACKAGE;
|
||||
private static final String CM_URL = NamespaceService.CONTENT_MODEL_1_0_URI;
|
||||
|
||||
/** Default Log */
|
||||
private final static Log LOGGER = LogFactory.getLog(PackageManager.class);
|
||||
|
||||
private final WorkflowService workflowService;
|
||||
private final NodeService nodeService;
|
||||
private final Log logger;
|
||||
|
||||
private final Set<NodeRef> addItems = new HashSet<NodeRef>();
|
||||
private final Set<NodeRef> removeItems = new HashSet<NodeRef>();
|
||||
|
||||
public PackageManager(WorkflowService workflowService,
|
||||
NodeService nodeService,
|
||||
Log logger)
|
||||
{
|
||||
this.workflowService = workflowService;
|
||||
this.nodeService = nodeService;
|
||||
this.logger = logger ==null ? LOGGER : logger;
|
||||
}
|
||||
|
||||
public void addItems(List<NodeRef> items)
|
||||
{
|
||||
addItems.addAll(items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a comma-separated list of {@link NodeRef} ids and adds the
|
||||
* specified NodeRefs to the package.
|
||||
*
|
||||
* @param items
|
||||
*/
|
||||
public void addItems(String items)
|
||||
{
|
||||
List<NodeRef> nodes = NodeRef.getNodeRefs(items);
|
||||
addItems(nodes);
|
||||
}
|
||||
|
||||
public void addItemsAsStrings(List<String> itemStrs)
|
||||
{
|
||||
for (String itemStr : itemStrs)
|
||||
{
|
||||
addItem(itemStr);
|
||||
}
|
||||
}
|
||||
|
||||
public void addItem(NodeRef item)
|
||||
{
|
||||
addItems.add(item);
|
||||
}
|
||||
|
||||
public void addItem(String itemStr)
|
||||
{
|
||||
addItem(new NodeRef(itemStr));
|
||||
}
|
||||
|
||||
public void removeItems(List<NodeRef> items)
|
||||
{
|
||||
removeItems.addAll(items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes a comma-separated list of {@link NodeRef} ids and adds the
|
||||
* specified NodeRefs to the package.
|
||||
*
|
||||
* @param items
|
||||
*/
|
||||
public void removeItems(String items)
|
||||
{
|
||||
List<NodeRef> nodes = NodeRef.getNodeRefs(items);
|
||||
removeItems(nodes);
|
||||
}
|
||||
|
||||
public void removeItemsAsStrings(List<String> itemStrs)
|
||||
{
|
||||
for (String itemStr : itemStrs)
|
||||
{
|
||||
removeItem(itemStr);
|
||||
}
|
||||
}
|
||||
|
||||
public void removeItem(NodeRef item)
|
||||
{
|
||||
removeItems.add(item);
|
||||
}
|
||||
|
||||
public void removeItem(String itemStr)
|
||||
{
|
||||
removeItem(new NodeRef(itemStr));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new Workflow package using the specified <code>container</code>.
|
||||
* If the <code>container</code> is null then a new container node is created.
|
||||
* Applies the specified updates to the package after it is created.
|
||||
* @param container
|
||||
* @return the package {@link NodeRef}.
|
||||
* @throws WorkflowException if the specified container is already package.
|
||||
*/
|
||||
public NodeRef create(NodeRef container) throws WorkflowException
|
||||
{
|
||||
NodeRef packageRef = workflowService.createPackage(container);
|
||||
update(packageRef);
|
||||
return packageRef;
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies the specified modifications to the package.
|
||||
* @param packageRef
|
||||
*/
|
||||
public void update(final NodeRef packageRef)
|
||||
{
|
||||
if(addItems.isEmpty() && removeItems.isEmpty())
|
||||
return;
|
||||
|
||||
AuthenticationUtil.runAs(new RunAsWork<Void>()
|
||||
{
|
||||
public Void doWork() throws Exception
|
||||
{
|
||||
checkPackage(packageRef);
|
||||
checkPackageItems(packageRef);
|
||||
addPackageItems(packageRef);
|
||||
removePackageItems(packageRef);
|
||||
return null;
|
||||
}
|
||||
|
||||
}, AuthenticationUtil.getSystemUserName());
|
||||
addItems.clear();
|
||||
removeItems.clear();
|
||||
}
|
||||
|
||||
|
||||
private void checkPackage(NodeRef packageRef)
|
||||
{
|
||||
if(packageRef == null
|
||||
|| nodeService.hasAspect(packageRef, PCKG_ASPECT)==false )
|
||||
{
|
||||
String msg = "The package NodeRef must implement the aspect: " + PCKG_ASPECT;
|
||||
throw new WorkflowException(msg);
|
||||
}
|
||||
}
|
||||
|
||||
private void removePackageItems(NodeRef packageRef)
|
||||
{
|
||||
for (NodeRef item : removeItems)
|
||||
{
|
||||
nodeService.removeChild(packageRef, item);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
private void addPackageItems(final NodeRef packageRef)
|
||||
{
|
||||
for (NodeRef item : addItems)
|
||||
{
|
||||
String name =
|
||||
(String) nodeService.getProperty(item, ContentModel.PROP_NAME);
|
||||
String localName = QName.createValidLocalName(name);
|
||||
QName qName = QName.createQName(CM_URL, localName);
|
||||
nodeService.addChild(packageRef, item, PCKG_CONTAINS, qName);
|
||||
}
|
||||
}
|
||||
|
||||
private List<NodeRef> getCurrentItems(NodeRef packageRef)
|
||||
{
|
||||
List<ChildAssociationRef> children = nodeService.getChildAssocs(
|
||||
packageRef, PCKG_CONTAINS, RegexQNamePattern.MATCH_ALL);
|
||||
ArrayList<NodeRef> results = new ArrayList<NodeRef>(children.size());
|
||||
for (ChildAssociationRef child : children)
|
||||
{
|
||||
results.add(child.getChildRef());
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
private void checkPackageItems(NodeRef packageRef)
|
||||
{
|
||||
List<NodeRef> currentitems = getCurrentItems(packageRef);
|
||||
Collection<NodeRef> intersection = CollectionUtils.intersection(addItems, removeItems);
|
||||
addItems.removeAll(intersection);
|
||||
removeItems.removeAll(intersection);
|
||||
for (NodeRef node : intersection)
|
||||
{
|
||||
if(logger.isDebugEnabled())
|
||||
logger.debug("Item was added and removed from package! Ignoring item: "+ node);
|
||||
}
|
||||
checkAddedItems(currentitems);
|
||||
checkRemovedItems(currentitems);
|
||||
}
|
||||
|
||||
private void checkRemovedItems(List<NodeRef> currentitems)
|
||||
{
|
||||
for (NodeRef removeItem : removeItems)
|
||||
{
|
||||
if(currentitems.contains(removeItem)==false)
|
||||
{
|
||||
removeItems.remove(removeItem);
|
||||
if (logger.isDebugEnabled())
|
||||
logger.debug("Ignoring item to remove, item not in package: " + removeItem);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void checkAddedItems(List<NodeRef> currentitems)
|
||||
{
|
||||
for (NodeRef addItem : addItems)
|
||||
{
|
||||
if (currentitems.contains(addItem))
|
||||
{
|
||||
addItems.remove(addItem);
|
||||
if (logger.isDebugEnabled())
|
||||
logger.debug("Ignoring item to add, item already in package: " + addItem);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
155
source/java/org/alfresco/repo/workflow/TaskUpdater.java
Normal file
155
source/java/org/alfresco/repo/workflow/TaskUpdater.java
Normal file
@@ -0,0 +1,155 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2009 Alfresco Software Limited.
|
||||
*
|
||||
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing"
|
||||
*/
|
||||
|
||||
package org.alfresco.repo.workflow;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowService;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowTask;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
|
||||
/**
|
||||
* A helper class for updating and transitioning {@link WorkflowTask
|
||||
* WorkflowTasks}. This is a stateful object that accumulates a set of updates
|
||||
* to a task and then commits all the updates when either the update() or
|
||||
* transition() method is called.
|
||||
*
|
||||
* @since 3.4
|
||||
* @author Nick Smith
|
||||
*/
|
||||
public class TaskUpdater
|
||||
{
|
||||
/** Logger */
|
||||
private static final Log LOGGER = LogFactory.getLog(TaskUpdater.class);
|
||||
|
||||
private final String taskId;
|
||||
private final WorkflowService workflowService;
|
||||
private final PackageManager packageMgr;
|
||||
|
||||
private final Map<QName, Serializable> properties = new HashMap<QName, Serializable>();
|
||||
private final Map<QName, List<NodeRef>> add = new HashMap<QName, List<NodeRef>>();
|
||||
private final Map<QName, List<NodeRef>> remove = new HashMap<QName, List<NodeRef>>();
|
||||
|
||||
public TaskUpdater(String taskId,
|
||||
WorkflowService workflowService,
|
||||
NodeService nodeService)
|
||||
{
|
||||
this.taskId = taskId;
|
||||
this.workflowService = workflowService;
|
||||
this.packageMgr = new PackageManager(workflowService, nodeService, LOGGER);
|
||||
}
|
||||
|
||||
|
||||
public void addProperty(QName name, Serializable value)
|
||||
{
|
||||
properties.put(name, value);
|
||||
}
|
||||
|
||||
public void addAssociation(QName name, List<NodeRef> value)
|
||||
{
|
||||
add.put(name, value);
|
||||
}
|
||||
|
||||
public void removeAssociation(QName name, List<NodeRef> value)
|
||||
{
|
||||
remove.put(name, value);
|
||||
}
|
||||
|
||||
public boolean changeAssociation(QName name, String nodeRefs, boolean isAdd)
|
||||
{
|
||||
List<NodeRef> value = NodeRef.getNodeRefs(nodeRefs, LOGGER);
|
||||
if (value == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
Map<QName, List<NodeRef>> map = getAssociationMap(isAdd);
|
||||
if (map != null)
|
||||
{
|
||||
map.put(name, value);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param suffix
|
||||
* @return
|
||||
*/
|
||||
private Map<QName, List<NodeRef>> getAssociationMap(boolean isAdd)
|
||||
{
|
||||
Map<QName, List<NodeRef>> map = null;
|
||||
if (isAdd)
|
||||
{
|
||||
map = add;
|
||||
}
|
||||
else
|
||||
{
|
||||
map = remove;
|
||||
}
|
||||
return map;
|
||||
}
|
||||
|
||||
public void addPackageItems(List<NodeRef> items)
|
||||
{
|
||||
packageMgr.addItems(items);
|
||||
}
|
||||
|
||||
public void removePackageItems(List<NodeRef> items)
|
||||
{
|
||||
packageMgr.removeItems(items);
|
||||
}
|
||||
|
||||
public WorkflowTask transition()
|
||||
{
|
||||
return transition(null);
|
||||
}
|
||||
|
||||
public WorkflowTask transition(String transitionId)
|
||||
{
|
||||
return workflowService.endTask(taskId, transitionId);
|
||||
}
|
||||
|
||||
public WorkflowTask update()
|
||||
{
|
||||
WorkflowTask task = workflowService.getTaskById(taskId);
|
||||
NodeRef packageNode = task.path.instance.workflowPackage;
|
||||
packageMgr.update(packageNode);
|
||||
|
||||
WorkflowTask result = workflowService.updateTask(taskId, properties, add, remove);
|
||||
properties.clear();
|
||||
add.clear();
|
||||
remove.clear();
|
||||
return result;
|
||||
}
|
||||
|
||||
}
|
||||
108
source/java/org/alfresco/repo/workflow/WorkflowBuilder.java
Normal file
108
source/java/org/alfresco/repo/workflow/WorkflowBuilder.java
Normal file
@@ -0,0 +1,108 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
||||
*
|
||||
* This file is part of Alfresco
|
||||
*
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Alfresco 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 Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package org.alfresco.repo.workflow;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowDefinition;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowException;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowInstance;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowPath;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowService;
|
||||
import org.alfresco.service.cmr.workflow.WorkflowTask;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
|
||||
/**
|
||||
* A helper class used to start workflows. The builder is a stateful object that
|
||||
* accumulates the various parameters and package items used to start the
|
||||
* workflow. The workflow is started when the build() method is called.
|
||||
*
|
||||
* @since 3.4
|
||||
* @author Nick Smith
|
||||
*/
|
||||
public class WorkflowBuilder
|
||||
{
|
||||
private final WorkflowService workflowService;
|
||||
private final PackageManager packageMgr;
|
||||
private final WorkflowDefinition definition;
|
||||
|
||||
private final Map<QName, Serializable> params = new HashMap<QName, Serializable>();
|
||||
private NodeRef packageNode = null;
|
||||
|
||||
public WorkflowBuilder(WorkflowDefinition definition, WorkflowService workflowService, NodeService nodeService)
|
||||
{
|
||||
this.workflowService = workflowService;
|
||||
this.packageMgr = new PackageManager(workflowService, nodeService, null);
|
||||
this.definition = definition;
|
||||
}
|
||||
|
||||
public void addParameter(QName name, Serializable value)
|
||||
{
|
||||
params.put(name, value);
|
||||
}
|
||||
|
||||
public void addAssociationParameter(QName name, List<NodeRef> values)
|
||||
{
|
||||
if(values instanceof Serializable)
|
||||
{
|
||||
params.put(name, (Serializable) values);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param packageNode the packageNode to set
|
||||
*/
|
||||
public void setPackageNode(NodeRef packageNode)
|
||||
{
|
||||
this.packageNode = packageNode;
|
||||
}
|
||||
|
||||
public void addPackageItems(List<NodeRef> items)
|
||||
{
|
||||
packageMgr.addItems(items);
|
||||
}
|
||||
|
||||
public WorkflowInstance build()
|
||||
{
|
||||
NodeRef packageRef = packageMgr.create(packageNode);
|
||||
params.put(WorkflowModel.ASSOC_PACKAGE, packageRef);
|
||||
WorkflowPath path = workflowService.startWorkflow(definition.id, params);
|
||||
signalStartTask(path);
|
||||
return path.instance;
|
||||
}
|
||||
|
||||
private void signalStartTask(WorkflowPath path)
|
||||
{
|
||||
List<WorkflowTask> tasks = workflowService.getTasksForWorkflowPath(path.id);
|
||||
if(tasks.size() == 1)
|
||||
{
|
||||
WorkflowTask startTask = tasks.get(0);
|
||||
workflowService.endTask(startTask.id, null);
|
||||
}
|
||||
else
|
||||
throw new WorkflowException("Start task not found! Expected 1 task but found: " + tasks.size());
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user