inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Workflow Service:

Browse Source 
1) Fix bug in retrieving completed tasks for an authority - unfortunately, this is not provided OOTB by jBPM!, so extended in their recommended way
2) Support for creating a Workflow Package (a container of content that's routed through the workflow) - can create a new container or provide an existing one (e.g. a versioned folder, layered folder).  Provide appropriate patch for creating workflow system folder in repository etc.
3) Collapsed WorkflowDefinitionComponent into WorkflowComponent interface

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@3522 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
David Caruana
2006-08-15 18:14:27 +00:00
parent b29838ab8f
commit 86d5ef460c
20 changed files with 497 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
config/alfresco/bootstrap/system.xml
View File

@@ -42,6 +42,7 @@
</cm:person> </cm:person>
</sys:children> </sys:children>
</sys:container> </sys:container>
<sys:container view:childName="${system.workflow_container.childname}"/>
</sys:children> </sys:children>
</sys:container> </sys:container>

1
config/alfresco/import-export-context.xml
View File

@@ -255,6 +255,7 @@
<prop key="spaces.guest_home.childname">${spaces.guest_home.childname}</prop> <prop key="spaces.guest_home.childname">${spaces.guest_home.childname}</prop>
<prop key="system.system_container.childname">${system.system_container.childname}</prop> <prop key="system.system_container.childname">${system.system_container.childname}</prop>
<prop key="system.people_container.childname">${system.people_container.childname}</prop> <prop key="system.people_container.childname">${system.people_container.childname}</prop>
<prop key="system.workflow_container.childname">${system.workflow_container.childname}</prop>
<prop key="spaces.dictionary.childname">${spaces.dictionary.childname}</prop> <prop key="spaces.dictionary.childname">${spaces.dictionary.childname}</prop>
<prop key="spaces.templates.childname">${spaces.templates.childname}</prop> <prop key="spaces.templates.childname">${spaces.templates.childname}</prop>
<prop key="spaces.templates.content.childname">${spaces.templates.content.childname}</prop> <prop key="spaces.templates.content.childname">${spaces.templates.content.childname}</prop>

5
config/alfresco/messages/patch-service.properties
View File

@@ -74,4 +74,7 @@ patch.topLevelGroupParentChildAssociationTypePatch.err.sys_path_not_found=Requir
patch.topLevelGroupParentChildAssociationTypePatch.err.auth_path_not_found=Required authority path not found: {0} patch.topLevelGroupParentChildAssociationTypePatch.err.auth_path_not_found=Required authority path not found: {0}
patch.actionRuleDecouplingPatch.description=Migrate existing rules to the updated model where rules are decoupled from actions. patch.actionRuleDecouplingPatch.description=Migrate existing rules to the updated model where rules are decoupled from actions.
patch.actionRuleDecouplingPatch.result=Updated {0} rules. patch.actionRuleDecouplingPatch.result=Updated {0} rules.
patch.systemWorkflowFolder.description=Ensures the existence of the system workflow container.
patch.systemWorkflowFolder.result.created=Created system workflow container {0}.

10
config/alfresco/patch/patch-services-context.xml
View File

@@ -379,4 +379,14 @@
<property name="targetSchema"><value>15</value></property> <property name="targetSchema"><value>15</value></property>
</bean> </bean>
<bean id="patch.systemWorkflowFolderPatch" class="org.alfresco.repo.admin.patch.impl.SystemWorkflowFolderPatch" parent="basePatch">
<property name="id"><value>patch.systemWorkflowFolderPatch</value></property>
<property name="description"><value>patch.systemWorkflowFolder.description</value></property>
<property name="fixesFromSchema"><value>0</value></property>
<property name="fixesToSchema"><value>15</value></property>
<property name="targetSchema"><value>16</value></property>
<property name="workflowPackageImpl" ref="workflowPackageImpl"/>
</bean>
</beans> </beans>

4
config/alfresco/repository.properties
View File

@@ -105,6 +105,10 @@ spaces.scripts.childname=app:scripts
system.system_container.childname=sys:system system.system_container.childname=sys:system
system.people_container.childname=sys:people system.people_container.childname=sys:people
# Folders for storing workflow related info
system.workflow_container.childname=sys:workflow
# Are user names case sensitive? # Are user names case sensitive?
# ============================== # ==============================
# #

2
config/alfresco/version.properties
View File

@@ -19,4 +19,4 @@ version.build=@build-number@
# Schema number # Schema number
version.schema=15 version.schema=16

9
config/alfresco/workflow-context.xml
View File

@@ -28,6 +28,15 @@
<bean id="workflowServiceImpl" class="org.alfresco.repo.workflow.WorkflowServiceImpl"> <bean id="workflowServiceImpl" class="org.alfresco.repo.workflow.WorkflowServiceImpl">
<property name="BPMEngineRegistry" ref="bpm_engineRegistry"/> <property name="BPMEngineRegistry" ref="bpm_engineRegistry"/>
<property name="workflowPackageComponent" ref="workflowPackageImpl"/>
</bean>
<bean id="workflowPackageImpl" class="org.alfresco.repo.workflow.WorkflowPackageImpl">
<property name="importerBootstrap" ref="spacesBootstrap"/>
<property name="fileFolderService" ref="fileFolderService"/>
<property name="searchService" ref="searchService"/>
<property name="nodeService" ref="nodeService"/>
<property name="namespaceService" ref="namespaceService"/>
</bean> </bean>
<!-- --> <!-- -->

51
source/java/org/alfresco/repo/admin/patch/impl/SystemWorkflowFolderPatch.java Normal file
View File

@@ -0,0 +1,51 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.repo.admin.patch.impl;
import org.alfresco.i18n.I18NUtil;
import org.alfresco.repo.admin.patch.AbstractPatch;
import org.alfresco.repo.workflow.WorkflowPackageImpl;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Ensures the system folder for Workflows is created.
*
* @author davidc
*/
public class SystemWorkflowFolderPatch extends AbstractPatch
{
private static final String MSG_CREATED = "patch.systemWorkflowFolder.result.created";
private WorkflowPackageImpl workflowPackageImpl;
public void setWorkflowPackageImpl(WorkflowPackageImpl workflowPackageImpl)
{
this.workflowPackageImpl = workflowPackageImpl;
}
/* (non-Javadoc)
* @see org.alfresco.repo.admin.patch.AbstractPatch#applyInternal()
*/
@Override
protected String applyInternal() throws Exception
{
NodeRef systemContainer = workflowPackageImpl.createSystemWorkflowContainer();
return I18NUtil.getMessage(MSG_CREATED, systemContainer);
}
}

4
source/java/org/alfresco/repo/workflow/BPMEngine.java
View File

@@ -62,10 +62,6 @@ public class BPMEngine implements InitializingBean
throw new WorkflowException("Engine Id not specified"); throw new WorkflowException("Engine Id not specified");
} }
if (this instanceof WorkflowDefinitionComponent)
{
registry.registerWorkflowDefinitionComponent(engineId, (WorkflowDefinitionComponent)this);
}
if (this instanceof WorkflowComponent) if (this instanceof WorkflowComponent)
{ {
registry.registerWorkflowComponent(engineId, (WorkflowComponent)this); registry.registerWorkflowComponent(engineId, (WorkflowComponent)this);

42
source/java/org/alfresco/repo/workflow/BPMEngineRegistry.java
View File

@@ -30,7 +30,6 @@ import org.apache.commons.logging.LogFactory;
* Responsible for managing the list of registered BPM Engines for the * Responsible for managing the list of registered BPM Engines for the
* following components: * following components:
* *
* - Workflow Definition Component
* - Workflow Component * - Workflow Component
* - Task Component * - Task Component
* *
@@ -44,7 +43,6 @@ public class BPMEngineRegistry
/** Logging support */ /** Logging support */
private static Log logger = LogFactory.getLog("org.alfresco.repo.workflow"); private static Log logger = LogFactory.getLog("org.alfresco.repo.workflow");
private Map<String, WorkflowDefinitionComponent> workflowDefinitionComponents;
private Map<String, WorkflowComponent> workflowComponents; private Map<String, WorkflowComponent> workflowComponents;
private Map<String, TaskComponent> taskComponents; private Map<String, TaskComponent> taskComponents;
@@ -54,50 +52,10 @@ public class BPMEngineRegistry
*/ */
public BPMEngineRegistry() public BPMEngineRegistry()
{ {
workflowDefinitionComponents = new HashMap<String, WorkflowDefinitionComponent>();
workflowComponents = new HashMap<String, WorkflowComponent>(); workflowComponents = new HashMap<String, WorkflowComponent>();
taskComponents = new HashMap<String, TaskComponent>(); taskComponents = new HashMap<String, TaskComponent>();
} }
/**
* Register a BPM Engine Workflow Definition Component
*
* @param engineId engine id
* @param engine implementing engine
*/
public void registerWorkflowDefinitionComponent(String engineId, WorkflowDefinitionComponent engine)
{
if (workflowDefinitionComponents.containsKey(engineId))
{
throw new WorkflowException("Workflow Definition Component already registered for engine id '" + engineId + "'");
}
workflowDefinitionComponents.put(engineId, engine);
if (logger.isInfoEnabled())
logger.info("Registered Workflow Definition Component '" + engineId + "' (" + engine.getClass() + ")");
}
/**
* Gets all registered Workflow Definition Components
*
* @return array of engine ids
*/
public String[] getWorkflowDefinitionComponents()
{
return workflowDefinitionComponents.keySet().toArray(new String[workflowDefinitionComponents.keySet().size()]);
}
/**
* Gets a specific BPM Engine Workflow Definition Component
*
* @param engineId engine id
* @return the Workflow Definition Component
*/
public WorkflowDefinitionComponent getWorkflowDefinitionComponent(String engineId)
{
return workflowDefinitionComponents.get(engineId);
}
/** /**
* Register a BPM Engine Workflow Component * Register a BPM Engine Workflow Component
* *

58
source/java/org/alfresco/repo/workflow/WorkflowComponent.java
View File

@@ -16,10 +16,12 @@
*/ */
package org.alfresco.repo.workflow; package org.alfresco.repo.workflow;
import java.io.InputStream;
import java.io.Serializable; import java.io.Serializable;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.service.cmr.workflow.WorkflowDefinition;
import org.alfresco.service.cmr.workflow.WorkflowInstance; import org.alfresco.service.cmr.workflow.WorkflowInstance;
import org.alfresco.service.cmr.workflow.WorkflowPath; import org.alfresco.service.cmr.workflow.WorkflowPath;
import org.alfresco.service.cmr.workflow.WorkflowTask; import org.alfresco.service.cmr.workflow.WorkflowTask;
@@ -34,6 +36,62 @@ import org.alfresco.service.namespace.QName;
public interface WorkflowComponent public interface WorkflowComponent
{ {
//
// Workflow Definition Support
//
/**
* Deploy a Workflow Definition
*
* @param workflowDefinition the content object containing the definition
* @param mimetype (optional) the mime type of the workflow definition
* @return workflow definition
*/
public WorkflowDefinition deployDefinition(InputStream workflowDefinition, String mimetype);
/**
* Is the specified Workflow Definition already deployed?
*
* Note: the notion of "already deployed" may differ between bpm engines. For example,
* different versions of the same process may be considered equal.
*
* @param workflowDefinition the definition to check
* @param mimetype the mimetype of the definition
* @return true => already deployed
*/
public boolean isDefinitionDeployed(InputStream workflowDefinition, String mimetype);
/**
* Undeploy an exisiting Workflow Definition
*
* TODO: Determine behaviour when "in-flight" workflow instances exist
*
* @param workflowDefinitionId the id of the definition to undeploy
*/
public void undeployDefinition(String workflowDefinitionId);
/**
* Gets all deployed Workflow Definitions
*
* @return the deployed workflow definitions
*/
public List<WorkflowDefinition> getDefinitions();
/**
* Gets a Workflow Definition by unique Id
*
* @param workflowDefinitionId the workflow definition id
* @return the deployed workflow definition
*/
public WorkflowDefinition getDefinitionById(String workflowDefinitionId);
//
// Workflow Instance Support
//
/** /**
* Start a Workflow Instance * Start a Workflow Instance
* *

79
source/java/org/alfresco/repo/workflow/WorkflowDefinitionComponent.java
View File

@@ -1,79 +0,0 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.repo.workflow;
import java.io.InputStream;
import java.util.List;
import org.alfresco.service.cmr.workflow.WorkflowDefinition;
/**
* SPI to be implemented by a BPM Engine that provides Workflow Definition management.
*
* @author davidc
*/
public interface WorkflowDefinitionComponent
{
/**
* Deploy a Workflow Definition
*
* @param workflowDefinition the content object containing the definition
* @param mimetype (optional) the mime type of the workflow definition
* @return workflow definition
*/
public WorkflowDefinition deployDefinition(InputStream workflowDefinition, String mimetype);
/**
* Is the specified Workflow Definition already deployed?
*
* Note: the notion of "already deployed" may differ between bpm engines. For example,
* different versions of the same process may be considered equal.
*
* @param workflowDefinition the definition to check
* @param mimetype the mimetype of the definition
* @return true => already deployed
*/
public boolean isDefinitionDeployed(InputStream workflowDefinition, String mimetype);
/**
* Undeploy an exisiting Workflow Definition
*
* TODO: Determine behaviour when "in-flight" workflow instances exist
*
* @param workflowDefinitionId the id of the definition to undeploy
*/
public void undeployDefinition(String workflowDefinitionId);
/**
* Gets all deployed Workflow Definitions
*
* @return the deployed workflow definitions
*/
public List<WorkflowDefinition> getDefinitions();
/**
* Gets a Workflow Definition by unique Id
*
* @param workflowDefinitionId the workflow definition id
* @return the deployed workflow definition
*/
public WorkflowDefinition getDefinitionById(String workflowDefinitionId);
}

3
source/java/org/alfresco/repo/workflow/WorkflowModel.java
View File

@@ -41,5 +41,8 @@ public interface WorkflowModel
static final QName TYPE_WORKFLOW_TASK = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "workflowTask"); static final QName TYPE_WORKFLOW_TASK = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "workflowTask");
static final QName PROP_CONTEXT = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "context"); static final QName PROP_CONTEXT = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "context");
static final QName ASSOC_PACKAGE = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "package"); static final QName ASSOC_PACKAGE = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "package");
// workflow package
static final QName ASPECT_WORKFLOW_PACKAGE = QName.createQName(NamespaceService.BPM_MODEL_1_0_URI, "workflowPackage");
} }

43
source/java/org/alfresco/repo/workflow/WorkflowPackageComponent.java Normal file
View File

@@ -0,0 +1,43 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.repo.workflow;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Contract for managing Workflow Packages. A package is a container
* of Content that's routed through a Workflow.
*
* @author davidc
*/
public interface WorkflowPackageComponent
{
/**
* Create a Workflow Package (a container of content to route through the Workflow).
*
* If an existing container is supplied, it's supplemented with the workflow package aspect.
*
* @param container (optional) a pre-created container (e.g. folder, versioned folder or layered folder)
* @return the workflow package
*/
public NodeRef createPackage(NodeRef container);
// TODO: Support for finding packages via meta-data of WorkflowPackage aspect
}

210
source/java/org/alfresco/repo/workflow/WorkflowPackageImpl.java Normal file
View File

@@ -0,0 +1,210 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.repo.workflow;
import java.util.ArrayList;
import java.util.List;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.importer.ImporterBootstrap;
import org.alfresco.service.cmr.model.FileFolderService;
import org.alfresco.service.cmr.model.FileInfo;
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.search.SearchService;
import org.alfresco.service.cmr.workflow.WorkflowException;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.GUID;
/**
* Alfresco implementation of Workflow Package where the package is stored
* within the Alfresco Repository.
*
* @author davidc
*/
public class WorkflowPackageImpl implements WorkflowPackageComponent
{
private final static String PACKAGE_FOLDER = "Workflow Packages";
// service dependencies
private ImporterBootstrap bootstrap;
private SearchService searchService;
private NodeService nodeService;
private NamespaceService namespaceService;
private FileFolderService fileFolderService;
private NodeRef systemWorkflowContainer = null;
/**
* @param bootstrap the importer bootstrap for the store to place workflow items into
*/
public void setImporterBootstrap(ImporterBootstrap bootstrap)
{
this.bootstrap = bootstrap;
}
/**
* @param fileFolderService file folder service
*/
public void setFileFolderService(FileFolderService fileFolderService)
{
this.fileFolderService = fileFolderService;
}
/**
* @param searchService search service
*/
public void setSearchService(SearchService searchService)
{
this.searchService = searchService;
}
/**
* @param nodeService node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @param namespaceService namespace service
*/
public void setNamespaceService(NamespaceService namespaceService)
{
this.namespaceService = namespaceService;
}
/* (non-Javadoc)
* @see org.alfresco.repo.workflow.WorkflowPackageComponent#createPackage(org.alfresco.service.cmr.repository.NodeRef)
*/
public NodeRef createPackage(NodeRef container)
{
// create a container, if one is not specified
if (container == null)
{
// create simple folder in workflow system folder
NodeRef system = getSystemWorkflowContainer();
// TODO: Consider structuring this folder, if number of children becomes an issue
List<String> folders = new ArrayList<String>();
folders.add(PACKAGE_FOLDER);
folders.add(GUID.generate());
FileInfo containerFolder = fileFolderService.makeFolders(system, folders, ContentModel.TYPE_FOLDER);
container = containerFolder.getNodeRef();
}
// attach workflow package
if (nodeService.hasAspect(container, WorkflowModel.ASPECT_WORKFLOW_PACKAGE))
{
throw new WorkflowException("Container '" + container + "' is already a workflow package.");
}
nodeService.addAspect(container, WorkflowModel.ASPECT_WORKFLOW_PACKAGE, null);
// return container
return container;
}
/**
* Gets the system workflow container for storing workflow related items
*
* @return the system workflow container
*/
private NodeRef getSystemWorkflowContainer()
{
if (systemWorkflowContainer == null)
{
NodeRef systemContainer = findSystemContainer();
systemWorkflowContainer = findSystemWorkflowContainer(systemContainer);
if (systemWorkflowContainer == null)
{
throw new WorkflowException("Unable to find system workflow folder - does not exist.");
}
}
return systemWorkflowContainer;
}
/**
* Finds the system workflow container
*
* @param systemContainer the system container
* @return the system workflow container
*/
private NodeRef findSystemWorkflowContainer(NodeRef systemContainer)
{
String path = bootstrap.getConfiguration().getProperty("system.workflow_container.childname");
if (path == null)
{
throw new WorkflowException("Unable to locate workflow system container - path not specified");
}
List<NodeRef> nodeRefs = searchService.selectNodes(systemContainer, path, null, namespaceService, false);
if (nodeRefs != null && nodeRefs.size() > 0)
{
systemWorkflowContainer = nodeRefs.get(0);
}
return systemWorkflowContainer;
}
/**
* Finds the system container
*
* @return the system container
*/
private NodeRef findSystemContainer()
{
String path = bootstrap.getConfiguration().getProperty("system.system_container.childname");
if (path == null)
{
throw new WorkflowException("Unable to locate system container - path not specified");
}
NodeRef root = nodeService.getRootNode(bootstrap.getStoreRef());
List<NodeRef> nodeRefs = searchService.selectNodes(root, path, null, namespaceService, false);
if (nodeRefs == null || nodeRefs.size() == 0)
{
throw new WorkflowException("Unable to locate system container - path not found");
}
return nodeRefs.get(0);
}
/**
* Creates the System Workflow Container
*
* @return the system workflow container
*/
public NodeRef createSystemWorkflowContainer()
{
NodeRef systemContainer = findSystemContainer();
NodeRef systemWorkflowContainer = findSystemWorkflowContainer(systemContainer);
if (systemWorkflowContainer == null)
{
String name = bootstrap.getConfiguration().getProperty("system.workflow_container.childname");
QName qname = QName.createQName(name, namespaceService);
ChildAssociationRef childRef = nodeService.createNode(systemContainer, ContentModel.ASSOC_CHILDREN, qname, ContentModel.TYPE_FOLDER);
systemWorkflowContainer = childRef.getChildRef();
}
return systemWorkflowContainer;
}
}

43
source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java
View File

@@ -43,6 +43,7 @@ import org.alfresco.service.namespace.QName;
public class WorkflowServiceImpl implements WorkflowService public class WorkflowServiceImpl implements WorkflowService
{ {
private BPMEngineRegistry registry; private BPMEngineRegistry registry;
private WorkflowPackageComponent workflowPackageComponent;
/** /**
@@ -55,13 +56,23 @@ public class WorkflowServiceImpl implements WorkflowService
this.registry = registry; this.registry = registry;
} }
/**
* Sets the Workflow Package Component
*
* @param workflowPackage workflow package component
*/
public void setWorkflowPackageComponent(WorkflowPackageComponent workflowPackageComponent)
{
this.workflowPackageComponent = workflowPackageComponent;
}
/* (non-Javadoc) /* (non-Javadoc)
* @see org.alfresco.service.cmr.workflow.WorkflowService#deployDefinition(java.lang.String, java.io.InputStream, java.lang.String) * @see org.alfresco.service.cmr.workflow.WorkflowService#deployDefinition(java.lang.String, java.io.InputStream, java.lang.String)
*/ */
public WorkflowDefinition deployDefinition(String engineId, InputStream workflowDefinition, String mimetype) public WorkflowDefinition deployDefinition(String engineId, InputStream workflowDefinition, String mimetype)
{ {
WorkflowDefinitionComponent component = getWorkflowDefinitionComponent(engineId); WorkflowComponent component = getWorkflowComponent(engineId);
return component.deployDefinition(workflowDefinition, mimetype); return component.deployDefinition(workflowDefinition, mimetype);
} }
@@ -70,7 +81,7 @@ public class WorkflowServiceImpl implements WorkflowService
*/ */
public boolean isDefinitionDeployed(String engineId, InputStream workflowDefinition, String mimetype) public boolean isDefinitionDeployed(String engineId, InputStream workflowDefinition, String mimetype)
{ {
WorkflowDefinitionComponent component = getWorkflowDefinitionComponent(engineId); WorkflowComponent component = getWorkflowComponent(engineId);
return component.isDefinitionDeployed(workflowDefinition, mimetype); return component.isDefinitionDeployed(workflowDefinition, mimetype);
} }
@@ -89,7 +100,7 @@ public class WorkflowServiceImpl implements WorkflowService
public void undeployDefinition(String workflowDefinitionId) public void undeployDefinition(String workflowDefinitionId)
{ {
String engineId = BPMEngineRegistry.getEngineId(workflowDefinitionId); String engineId = BPMEngineRegistry.getEngineId(workflowDefinitionId);
WorkflowDefinitionComponent component = getWorkflowDefinitionComponent(engineId); WorkflowComponent component = getWorkflowComponent(engineId);
component.undeployDefinition(workflowDefinitionId); component.undeployDefinition(workflowDefinitionId);
} }
@@ -99,10 +110,10 @@ public class WorkflowServiceImpl implements WorkflowService
public List<WorkflowDefinition> getDefinitions() public List<WorkflowDefinition> getDefinitions()
{ {
List<WorkflowDefinition> definitions = new ArrayList<WorkflowDefinition>(10); List<WorkflowDefinition> definitions = new ArrayList<WorkflowDefinition>(10);
String[] ids = registry.getWorkflowDefinitionComponents(); String[] ids = registry.getWorkflowComponents();
for (String id: ids) for (String id: ids)
{ {
WorkflowDefinitionComponent component = registry.getWorkflowDefinitionComponent(id); WorkflowComponent component = registry.getWorkflowComponent(id);
definitions.addAll(component.getDefinitions()); definitions.addAll(component.getDefinitions());
} }
return Collections.unmodifiableList(definitions); return Collections.unmodifiableList(definitions);
@@ -114,7 +125,7 @@ public class WorkflowServiceImpl implements WorkflowService
public WorkflowDefinition getDefinitionById(String workflowDefinitionId) public WorkflowDefinition getDefinitionById(String workflowDefinitionId)
{ {
String engineId = BPMEngineRegistry.getEngineId(workflowDefinitionId); String engineId = BPMEngineRegistry.getEngineId(workflowDefinitionId);
WorkflowDefinitionComponent component = getWorkflowDefinitionComponent(engineId); WorkflowComponent component = getWorkflowComponent(engineId);
return component.getDefinitionById(workflowDefinitionId); return component.getDefinitionById(workflowDefinitionId);
} }
@@ -254,25 +265,9 @@ public class WorkflowServiceImpl implements WorkflowService
/* (non-Javadoc) /* (non-Javadoc)
* @see org.alfresco.service.cmr.workflow.WorkflowService#createPackage(java.lang.String, org.alfresco.service.cmr.repository.NodeRef) * @see org.alfresco.service.cmr.workflow.WorkflowService#createPackage(java.lang.String, org.alfresco.service.cmr.repository.NodeRef)
*/ */
public NodeRef createPackage(String workflowDefinitionId, NodeRef container) public NodeRef createPackage(NodeRef container)
{ {
// TODO return workflowPackageComponent.createPackage(container);
throw new UnsupportedOperationException();
}
/**
* Gets the Workflow Definition Component registered against the specified BPM Engine Id
*
* @param engineId engine id
*/
private WorkflowDefinitionComponent getWorkflowDefinitionComponent(String engineId)
{
WorkflowDefinitionComponent component = registry.getWorkflowDefinitionComponent(engineId);
if (component == null)
{
throw new WorkflowException("Workflow Definition Component for engine id '" + engineId + "' is not registered");
}
return component;
} }
/** /**

13
source/java/org/alfresco/repo/workflow/WorkflowServiceImplTest.java
View File

@@ -19,6 +19,8 @@ package org.alfresco.repo.workflow;
import java.util.List; import java.util.List;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
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.WorkflowDefinition;
import org.alfresco.service.cmr.workflow.WorkflowPath; import org.alfresco.service.cmr.workflow.WorkflowPath;
import org.alfresco.service.cmr.workflow.WorkflowService; import org.alfresco.service.cmr.workflow.WorkflowService;
@@ -33,11 +35,13 @@ import org.alfresco.util.BaseSpringTest;
public class WorkflowServiceImplTest extends BaseSpringTest public class WorkflowServiceImplTest extends BaseSpringTest
{ {
WorkflowService workflowService; WorkflowService workflowService;
NodeService nodeService;
//@Override //@Override
protected void onSetUpInTransaction() throws Exception protected void onSetUpInTransaction() throws Exception
{ {
workflowService = (WorkflowService)applicationContext.getBean(ServiceRegistry.WORKFLOW_SERVICE.getLocalName()); workflowService = (WorkflowService)applicationContext.getBean(ServiceRegistry.WORKFLOW_SERVICE.getLocalName());
nodeService = (NodeService)applicationContext.getBean(ServiceRegistry.NODE_SERVICE.getLocalName());
} }
public void testGetWorkflowDefinitions() public void testGetWorkflowDefinitions()
@@ -60,4 +64,13 @@ public class WorkflowServiceImplTest extends BaseSpringTest
assertNotNull(path.instance); assertNotNull(path.instance);
assertEquals(workflowDef.id, path.instance.definition.id); assertEquals(workflowDef.id, path.instance.definition.id);
} }
public void testWorkflowPackage()
{
NodeRef nodeRef = workflowService.createPackage(null);
assertNotNull(nodeRef);
assertTrue(nodeService.hasAspect(nodeRef, WorkflowModel.ASPECT_WORKFLOW_PACKAGE));
setComplete();
}
} }

67
source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java
View File

@@ -34,7 +34,6 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.workflow.BPMEngine; import org.alfresco.repo.workflow.BPMEngine;
import org.alfresco.repo.workflow.TaskComponent; import org.alfresco.repo.workflow.TaskComponent;
import org.alfresco.repo.workflow.WorkflowComponent; import org.alfresco.repo.workflow.WorkflowComponent;
import org.alfresco.repo.workflow.WorkflowDefinitionComponent;
import org.alfresco.repo.workflow.WorkflowModel; import org.alfresco.repo.workflow.WorkflowModel;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.AspectDefinition; import org.alfresco.service.cmr.dictionary.AspectDefinition;
@@ -55,6 +54,8 @@ import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition;
import org.alfresco.service.cmr.workflow.WorkflowTaskState; import org.alfresco.service.cmr.workflow.WorkflowTaskState;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
import org.hibernate.Query;
import org.hibernate.Session;
import org.hibernate.proxy.HibernateProxy; import org.hibernate.proxy.HibernateProxy;
import org.jbpm.JbpmContext; import org.jbpm.JbpmContext;
import org.jbpm.JbpmException; import org.jbpm.JbpmException;
@@ -81,7 +82,7 @@ import org.springmodules.workflow.jbpm31.JbpmTemplate;
* @author davidc * @author davidc
*/ */
public class JBPMEngine extends BPMEngine public class JBPMEngine extends BPMEngine
implements WorkflowDefinitionComponent, WorkflowComponent, TaskComponent implements WorkflowComponent, TaskComponent
{ {
// Implementation dependencies // Implementation dependencies
protected DictionaryService dictionaryService; protected DictionaryService dictionaryService;
@@ -91,6 +92,16 @@ public class JBPMEngine extends BPMEngine
protected PersonService personService; protected PersonService personService;
private JbpmTemplate jbpmTemplate; private JbpmTemplate jbpmTemplate;
// Note: jBPM query which is not provided out-of-the-box
// TODO: Check jBPM 3.2 and get this implemented in jBPM
private final static String COMPLETED_TASKS_QUERY =
"select ti " +
"from org.jbpm.taskmgmt.exe.TaskInstance as ti " +
"where ti.actorId = :actorId " +
"and ti.isOpen = false " +
"and ti.end is not null";
/** /**
* Sets the JBPM Template used for accessing JBoss JBPM in the correct context * Sets the JBPM Template used for accessing JBoss JBPM in the correct context
* *
@@ -528,27 +539,61 @@ public class JBPMEngine extends BPMEngine
public List<WorkflowTask> doInJbpm(JbpmContext context) public List<WorkflowTask> doInJbpm(JbpmContext context)
{ {
// retrieve tasks assigned to authority // retrieve tasks assigned to authority
TaskMgmtSession taskSession = context.getTaskMgmtSession(); List<TaskInstance> tasks;
List<TaskInstance> tasks = taskSession.findTaskInstances(authority); if (state.equals(WorkflowTaskState.IN_PROGRESS))
{
TaskMgmtSession taskSession = context.getTaskMgmtSession();
tasks = taskSession.findTaskInstances(authority);
}
else
{
// Note: This method is not implemented by jBPM
tasks = findCompletedTaskInstances(context, authority);
}
// convert tasks to appropriate service response format
List<WorkflowTask> workflowTasks = new ArrayList<WorkflowTask>(tasks.size()); List<WorkflowTask> workflowTasks = new ArrayList<WorkflowTask>(tasks.size());
for (TaskInstance task : tasks) for (TaskInstance task : tasks)
{ {
if (getWorkflowTaskState(task).equals(state)) WorkflowTask workflowTask = createWorkflowTask(task);
{ workflowTasks.add(workflowTask);
WorkflowTask workflowTask = createWorkflowTask(task);
workflowTasks.add(workflowTask);
}
} }
return workflowTasks; return workflowTasks;
} }
/**
* Gets the completed task list for the specified actor
*
* TODO: This method provides a query that's not in JBPM! Look to have JBPM implement this.
*
* @param jbpmContext the jbpm context
* @param actorId the actor to retrieve tasks for
* @return the tasks
*/
private List findCompletedTaskInstances(JbpmContext jbpmContext, String actorId)
{
List result = null;
try
{
Session session = jbpmContext.getSession();
Query query = session.createQuery(COMPLETED_TASKS_QUERY);
query.setString("actorId", actorId);
result = query.list();
}
catch (Exception e)
{
throw new JbpmException("Couldn't get completed task instances list for actor '" + actorId + "'", e);
}
return result;
}
}); });
} }
catch(JbpmException e) catch(JbpmException e)
{ {
throw new WorkflowException("Failed to retrieve tasks assigned to authority '" + authority + "'", e); throw new WorkflowException("Failed to retrieve tasks assigned to authority '" + authority + "' in state '" + state + "'", e);
} }
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see org.alfresco.repo.workflow.TaskComponent#getPooledTasks(java.util.List) * @see org.alfresco.repo.workflow.TaskComponent#getPooledTasks(java.util.List)
*/ */

18
source/java/org/alfresco/repo/workflow/jbpm/JBPMEngineTest.java
View File

@@ -28,7 +28,6 @@ import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.workflow.BPMEngineRegistry; import org.alfresco.repo.workflow.BPMEngineRegistry;
import org.alfresco.repo.workflow.TaskComponent; import org.alfresco.repo.workflow.TaskComponent;
import org.alfresco.repo.workflow.WorkflowComponent; import org.alfresco.repo.workflow.WorkflowComponent;
import org.alfresco.repo.workflow.WorkflowDefinitionComponent;
import org.alfresco.repo.workflow.WorkflowModel; import org.alfresco.repo.workflow.WorkflowModel;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@@ -53,7 +52,6 @@ import org.springframework.core.io.ClassPathResource;
*/ */
public class JBPMEngineTest extends BaseSpringTest public class JBPMEngineTest extends BaseSpringTest
{ {
WorkflowDefinitionComponent workflowDefinitionComponent;
WorkflowComponent workflowComponent; WorkflowComponent workflowComponent;
TaskComponent taskComponent; TaskComponent taskComponent;
WorkflowDefinition testWorkflowDef; WorkflowDefinition testWorkflowDef;
@@ -64,18 +62,17 @@ public class JBPMEngineTest extends BaseSpringTest
protected void onSetUpInTransaction() throws Exception protected void onSetUpInTransaction() throws Exception
{ {
BPMEngineRegistry registry = (BPMEngineRegistry)applicationContext.getBean("bpm_engineRegistry"); BPMEngineRegistry registry = (BPMEngineRegistry)applicationContext.getBean("bpm_engineRegistry");
workflowDefinitionComponent = registry.getWorkflowDefinitionComponent("jbpm");
workflowComponent = registry.getWorkflowComponent("jbpm"); workflowComponent = registry.getWorkflowComponent("jbpm");
taskComponent = registry.getTaskComponent("jbpm"); taskComponent = registry.getTaskComponent("jbpm");
// deploy test process definition // deploy test process definition
ClassPathResource processDef = new ClassPathResource("org/alfresco/repo/workflow/jbpm/test_processdefinition.xml"); ClassPathResource processDef = new ClassPathResource("org/alfresco/repo/workflow/jbpm/test_processdefinition.xml");
assertFalse(workflowDefinitionComponent.isDefinitionDeployed(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML)); assertFalse(workflowComponent.isDefinitionDeployed(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML));
testWorkflowDef = workflowDefinitionComponent.deployDefinition(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML); testWorkflowDef = workflowComponent.deployDefinition(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML);
assertNotNull(testWorkflowDef); assertNotNull(testWorkflowDef);
assertEquals("Test", testWorkflowDef.name); assertEquals("Test", testWorkflowDef.name);
assertEquals("1", testWorkflowDef.version); assertEquals("1", testWorkflowDef.version);
assertTrue(workflowDefinitionComponent.isDefinitionDeployed(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML)); assertTrue(workflowComponent.isDefinitionDeployed(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML));
// get valid node ref // get valid node ref
NodeService nodeService = (NodeService)applicationContext.getBean(ServiceRegistry.NODE_SERVICE.getLocalName()); NodeService nodeService = (NodeService)applicationContext.getBean(ServiceRegistry.NODE_SERVICE.getLocalName());
@@ -85,7 +82,7 @@ public class JBPMEngineTest extends BaseSpringTest
public void testGetWorkflowDefinitions() public void testGetWorkflowDefinitions()
{ {
List<WorkflowDefinition> workflowDefs = workflowDefinitionComponent.getDefinitions(); List<WorkflowDefinition> workflowDefs = workflowComponent.getDefinitions();
assertNotNull(workflowDefs); assertNotNull(workflowDefs);
assertTrue(workflowDefs.size() > 0); assertTrue(workflowDefs.size() > 0);
} }
@@ -94,7 +91,7 @@ public class JBPMEngineTest extends BaseSpringTest
public void testDeployWorkflow() throws Exception public void testDeployWorkflow() throws Exception
{ {
ClassPathResource processDef = new ClassPathResource("org/alfresco/repo/workflow/jbpm/test_processdefinition.xml"); ClassPathResource processDef = new ClassPathResource("org/alfresco/repo/workflow/jbpm/test_processdefinition.xml");
testWorkflowDef = workflowDefinitionComponent.deployDefinition(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML); testWorkflowDef = workflowComponent.deployDefinition(processDef.getInputStream(), MimetypeMap.MIMETYPE_XML);
assertNotNull(testWorkflowDef); assertNotNull(testWorkflowDef);
assertEquals("Test", testWorkflowDef.name); assertEquals("Test", testWorkflowDef.name);
assertEquals("2", testWorkflowDef.version); assertEquals("2", testWorkflowDef.version);
@@ -343,8 +340,13 @@ public class JBPMEngineTest extends BaseSpringTest
WorkflowTask updatedTask = taskComponent.endTask(tasks1.get(0).id, null); WorkflowTask updatedTask = taskComponent.endTask(tasks1.get(0).id, null);
assertNotNull(updatedTask); assertNotNull(updatedTask);
assertEquals(WorkflowTaskState.COMPLETED, updatedTask.state); assertEquals(WorkflowTaskState.COMPLETED, updatedTask.state);
List<WorkflowTask> completedTasks = taskComponent.getAssignedTasks("System", WorkflowTaskState.COMPLETED);
assertNotNull(completedTasks);
assertEquals(1, completedTasks.size());
assertEquals(WorkflowTaskState.COMPLETED, completedTasks.get(0).state);
} }
public void testGetTask() public void testGetTask()
{ {
WorkflowDefinition workflowDef = getTestDefinition(); WorkflowDefinition workflowDef = getTestDefinition();

7
source/java/org/alfresco/service/cmr/workflow/WorkflowService.java
View File

@@ -212,12 +212,13 @@ public interface WorkflowService
public WorkflowTask endTask(String taskId, String transition); public WorkflowTask endTask(String taskId, String transition);
/** /**
* Create a Workflow Package (a container of content to route through the Workflow) * Create a Workflow Package (a container of content to route through the Workflow).
*
* If an existing container is supplied, it's supplemented with the workflow package aspect.
* *
* @param workflowDefinitionId workflow definition id
* @param container (optional) a pre-created container (e.g. folder, versioned folder or layered folder) * @param container (optional) a pre-created container (e.g. folder, versioned folder or layered folder)
* @return the workflow package * @return the workflow package
*/ */
public NodeRef createPackage(String workflowDefinitionId, NodeRef container); public NodeRef createPackage(NodeRef container);
} }