inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-14 17:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged BRANCHES/DEV/BELARUS/HEAD_2010_08_04 to HEAD:

Browse Source 
21592 & 21649: Workflow REST APIs for retrieving workflow instance collections

Includes:
ALF-3900: F62 REST API to get all workflow instances
ALF-3901: F64 REST API to get all workflow instances of a particular workflow definition
ALF-3905: F65 REST API to get a filtered list of workflow instances of a particular workflow definition (by initiator, state, date, priority)
ALF-3906: F63 REST API to get a filtered list of workflow instances (by initiator, status, date, priority)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21671 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Gavin Cornwell
2010-08-06 21:19:09 +00:00
parent eaee7edec3
commit 5a053460df
7 changed files with 387 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
config/alfresco/templates/webscripts/org/alfresco/repository/workflow/workflow-instances.get.desc.xml Normal file
View File

@@ -0,0 +1,9 @@
<webscript>
<shortname>Get Workflow Instance Collection</shortname>
<description>Retrieves all workflow instances, the returned list can be optionally filtered by the state of the workflow instance and by the authority that initiated the workflow instance.</description>
<url>/api/workflow-instances?state={state?}&amp;initiator={initiator?}&amp;priority={priority?}</url>
<url>/api/workflow-definitions/{workflow_definition_id}/workflow-instances?state={state?}&amp;initiator={initiator?}&amp;date={date?}&amp;priority={priority?}</url>
<format default="json"/>
<authentication>user</authentication>
<transaction allow="readonly">required</transaction>
</webscript>

12
config/alfresco/templates/webscripts/org/alfresco/repository/workflow/workflow-instances.get.json.ftl Normal file
View File

@@ -0,0 +1,12 @@
<#-- Workflow Instances collection -->
<#import "task.lib.ftl" as taskLib />
{
"data":
[
<#list workflowInstances as workflowInstance>
<@taskLib.workflowInstanceJSON workflowInstance=workflowInstance />
<#if workflowInstance_has_next>,</#if>
</#list>
]
}

5
config/alfresco/web-scripts-application-context.xml
View File

@@ -816,6 +816,11 @@
class="org.alfresco.repo.web.scripts.workflow.WorkflowInstanceGet"
parent="abstractWorkflowWebScript"></bean>
<!-- Retrieves all workflow instances. -->
<bean id="webscript.org.alfresco.repository.workflow.workflow-instances.get"
class="org.alfresco.repo.web.scripts.workflow.WorkflowInstancesGet"
parent="abstractWorkflowWebScript"></bean>
<!-- -->
<!-- Audit Service REST API -->
<!-- -->

195
source/java/org/alfresco/repo/web/scripts/workflow/WorkflowInstancesGet.java Normal file
View File

@@ -0,0 +1,195 @@
/*
* 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.web.scripts.workflow;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.workflow.WorkflowModel;
import org.alfresco.service.cmr.workflow.WorkflowDefinition;
import org.alfresco.service.cmr.workflow.WorkflowInstance;
import org.alfresco.service.cmr.workflow.WorkflowTask;
import org.springframework.extensions.surf.util.ISO8601DateFormat;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* @author unknown
* @since 3.4
*
*/
public class WorkflowInstancesGet extends AbstractWorkflowWebscript
{
public static final String PARAM_STATE = "state";
public static final String PARAM_INITIATOR = "initiator";
public static final String PARAM_DATE = "date";
public static final String PARAM_PRIORITY = "priority";
public static final String PARAM_DEFINITION_ID = "workflow_definition_id";
@Override
protected Map<String, Object> buildModel(WorkflowModelBuilder modelBuilder, WebScriptRequest req, Status status, Cache cache)
{
Map<String, String> params = req.getServiceMatch().getTemplateVars();
// get request parameters
Map<String, String> filters = new HashMap<String, String>(4);
filters.put(PARAM_STATE, req.getParameter(PARAM_STATE));
filters.put(PARAM_INITIATOR, req.getParameter(PARAM_INITIATOR));
filters.put(PARAM_DATE, req.getParameter(PARAM_DATE));
filters.put(PARAM_PRIORITY, req.getParameter(PARAM_PRIORITY));
String workflowDefinitionId = params.get(PARAM_DEFINITION_ID);
List<WorkflowInstance> workflows = new ArrayList<WorkflowInstance>();
if (workflowDefinitionId != null)
{
// list workflows for specified workflow definition
workflows.addAll(workflowService.getWorkflows(workflowDefinitionId));
}
else
{
List<WorkflowDefinition> workflowDefinitions = workflowService.getAllDefinitions();
// list workflows for all definitions
for (WorkflowDefinition workflowDefinition : workflowDefinitions)
{
workflows.addAll(workflowService.getWorkflows(workflowDefinition.getId()));
}
}
// filter result
List<Map<String, Object>> results = new ArrayList<Map<String,Object>>(workflows.size());
for (WorkflowInstance workflow : workflows)
{
if (matches(workflow, filters, modelBuilder))
{
results.add(modelBuilder.buildSimple(workflow));
}
}
Map<String, Object> model = new HashMap<String, Object>();
// build the model for ftl
model.put("workflowInstances", results);
return model;
}
/*
* If workflow instance matches at list one filter value or if no filter was specified, then it will included in response
*/
private boolean matches(WorkflowInstance workflowInstance, Map<String, String> filters, WorkflowModelBuilder modelBuilder)
{
// by default we assume that workflow instance should be included to response
boolean result = true;
boolean firstFilter = true;
for (String key : filters.keySet())
{
String filterValue = filters.get(key);
// skip null filters (null value means that filter was not specified)
if (filterValue != null)
{
// some of the filter was specified, so the decision to include or not workflow to response
// based on matching to filter parameter (by default false)
if (firstFilter)
{
result = false;
firstFilter = false;
}
boolean matches = false;
if (key.equals(PARAM_STATE))
{
WorkflowState filter = WorkflowState.getState(filterValue);
if (filter != null)
{
if (filter.equals(WorkflowState.COMPLETED) && !workflowInstance.isActive() || filter.equals(WorkflowState.ACTIVE) && workflowInstance.isActive())
{
matches = true;
}
}
}
else if (key.equals(PARAM_DATE))
{
// only workflows that was started after specified time are returned
if (workflowInstance.getStartDate().getTime() >= ISO8601DateFormat.parse(filterValue.replaceAll(" ", "+")).getTime())
{
matches = true;
}
}
else if (key.equals(PARAM_INITIATOR))
{
if (workflowInstance.getInitiator() != null && nodeService.exists(workflowInstance.getInitiator()) && filterValue.equals(nodeService.getProperty(workflowInstance.getInitiator(), ContentModel.PROP_USERNAME)))
{
matches = true;
}
}
else if (key.equals(PARAM_PRIORITY))
{
WorkflowTask startTask = modelBuilder.getStartTaskForWorkflow(workflowInstance);
if (startTask != null && filterValue.equals(startTask.getProperties().get(WorkflowModel.PROP_WORKFLOW_PRIORITY).toString()))
{
matches = true;
}
}
// update global result
result = result || matches;
}
}
return result;
}
private enum WorkflowState
{
ACTIVE ("active"),
COMPLETED ("completed");
String value;
WorkflowState(String value)
{
this.value = value;
}
static WorkflowState getState(String value)
{
for (WorkflowState state : WorkflowState.values())
{
if (state.value.equals(value))
{
return state;
}
}
return null;
}
}
}

2
source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilder.java
View File

@@ -227,7 +227,7 @@ public class WorkflowModelBuilder
model.put(TASK_WORKFLOW_INSTANCE_END_DATE, ISO8601DateFormat.format(workflowInstance.getEndDate()));
}
if (workflowInstance.getInitiator() == null)
if (workflowInstance.getInitiator() == null || !nodeService.exists(workflowInstance.getInitiator()))
{
model.put(TASK_WORKFLOW_INSTANCE_INITIATOR, null);
}

30
source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilderTest.java
View File

@@ -217,6 +217,33 @@ public class WorkflowModelBuilderTest extends TestCase
assertEquals(workflowDefinition.getDescription(), model.get(WorkflowModelBuilder.WORKFLOW_DEFINITION_DESCRIPTION));
}
@SuppressWarnings("unchecked")
public void testBuildWorkflowInstance() throws Exception
{
WorkflowInstance workflowInstance = makeWorkflowInstance(null);
Map<String, Object> model = builder.buildSimple(workflowInstance);
assertEquals(workflowInstance.getId(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_ID));
assertTrue(model.containsKey(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_URL));
assertEquals(workflowInstance.getDefinition().getName(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_NAME));
assertEquals(workflowInstance.getDefinition().getTitle(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_TITLE));
assertEquals(workflowInstance.getDefinition().getDescription(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_DESCRIPTION));
assertEquals(workflowInstance.isActive(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_IS_ACTIVE));
assertEquals(ISO8601DateFormat.format(workflowInstance.getStartDate()), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_START_DATE));
assertEquals(ISO8601DateFormat.format(workflowInstance.getEndDate()), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_END_DATE));
Map<String, Object> initiator = (Map<String, Object>) model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_INITIATOR);
if (initiator != null)
{
assertEquals(userName, initiator.get(WorkflowModelBuilder.PERSON_USER_NAME));
assertEquals(firstName, initiator.get(WorkflowModelBuilder.PERSON_FIRST_NAME));
assertEquals(lastName, initiator.get(WorkflowModelBuilder.PERSON_LAST_NAME));
}
assertTrue(model.containsKey(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_DEFINITION_URL));
}
@SuppressWarnings("unchecked")
public void testBuildWorkflowInstanceDetailed() throws Exception
{
@@ -239,9 +266,12 @@ public class WorkflowModelBuilderTest extends TestCase
assertEquals(ISO8601DateFormat.format(workflowInstance.getEndDate()), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_END_DATE));
Map<String, Object> initiator = (Map<String, Object>) model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_INITIATOR);
if (initiator != null)
{
assertEquals(userName, initiator.get(WorkflowModelBuilder.PERSON_USER_NAME));
assertEquals(firstName, initiator.get(WorkflowModelBuilder.PERSON_FIRST_NAME));
assertEquals(lastName, initiator.get(WorkflowModelBuilder.PERSON_LAST_NAME));
}
assertEquals(workflowInstance.getContext().toString(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_CONTEXT));
assertEquals(workflowInstance.getWorkflowPackage().toString(), model.get(WorkflowModelBuilder.TASK_WORKFLOW_INSTANCE_PACKAGE));

132
source/java/org/alfresco/repo/web/scripts/workflow/WorkflowRestApiTest.java
View File

@@ -19,6 +19,7 @@
package org.alfresco.repo.web.scripts.workflow;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
@@ -66,6 +67,7 @@ public class WorkflowRestApiTest extends BaseWebScriptTest
private static final String URL_TASKS = "api/task-instances";
private static final String URL_WORKFLOW_DEFINITIONS = "api/workflow-definitions";
private static final String URL_WORKFLOW_INSTANCES = "api/workflow-instances";
private static final String URL_WORKFLOW_INSTANCES_FOR_DEFINITION = "api/workflow-definitions/{0}/workflow-instances";
private TestPersonManager personManager;
private WorkflowService workflowService;
@@ -392,6 +394,99 @@ public class WorkflowRestApiTest extends BaseWebScriptTest
assertTrue(tasks.length() > 1);
}
public void testWorkflowInstancesGet() throws Exception
{
//Start workflow as USER1 and assign task to USER2.
personManager.setUser(USER1);
WorkflowDefinition adhocDef = workflowService.getDefinitionByName("jbpm$wf:adhoc");
Map<QName, Serializable> params = new HashMap<QName, Serializable>();
params.put(WorkflowModel.ASSOC_ASSIGNEE, personManager.get(USER2));
Date dueDate = new Date();
params.put(WorkflowModel.PROP_DUE_DATE, dueDate);
params.put(WorkflowModel.PROP_WORKFLOW_PRIORITY, 1);
params.put(WorkflowModel.ASSOC_PACKAGE, packageRef);
params.put(WorkflowModel.PROP_CONTEXT, packageRef);
WorkflowPath adhocPath = workflowService.startWorkflow(adhocDef.getId(), params);
WorkflowTask startTask = workflowService.getTasksForWorkflowPath(adhocPath.getId()).get(0);
WorkflowInstance adhocInstance = startTask.getPath().getInstance();
// Get Workflow Instance Collection
Response response = sendRequest(new GetRequest(URL_WORKFLOW_INSTANCES), 200);
assertEquals(Status.STATUS_OK, response.getStatus());
String jsonStr = response.getContentAsString();
JSONObject json = new JSONObject(jsonStr);
JSONArray result = json.getJSONArray("data");
assertNotNull(result);
for (int i = 0; i < result.length(); i++)
{
checkSimpleWorkflowInstanceResponse(result.getJSONObject(i));
}
Response forDefinitionResponse = sendRequest(new GetRequest(MessageFormat.format(URL_WORKFLOW_INSTANCES_FOR_DEFINITION, adhocDef.getId())), 200);
assertEquals(Status.STATUS_OK, forDefinitionResponse.getStatus());
String forDefinitionJsonStr = forDefinitionResponse.getContentAsString();
JSONObject forDefinitionJson = new JSONObject(forDefinitionJsonStr);
JSONArray forDefinitionResult = forDefinitionJson.getJSONArray("data");
assertNotNull(forDefinitionResult);
for (int i = 0; i < forDefinitionResult.length(); i++)
{
checkSimpleWorkflowInstanceResponse(forDefinitionResult.getJSONObject(i));
}
// filter by initiator
String initiatorFilter = "?initiator=" + USER1;
Response initiatorFilteredResponse = sendRequest(new GetRequest(URL_WORKFLOW_INSTANCES + initiatorFilter), 200);
assertEquals(Status.STATUS_OK, initiatorFilteredResponse.getStatus());
String initiatorFilteredJsonStr = initiatorFilteredResponse.getContentAsString();
JSONObject initiatorFilteredJson = new JSONObject(initiatorFilteredJsonStr);
JSONArray initiatorFilteredResult = initiatorFilteredJson.getJSONArray("data");
assertNotNull(initiatorFilteredResult);
assertEquals(1, initiatorFilteredResult.length());
assertEquals(adhocInstance.getId(), initiatorFilteredResult.getJSONObject(0).getString("id"));
// filter by date
String dateFilter = "?date=" + ISO8601DateFormat.format(adhocInstance.startDate);
Response dateFilteredResponse = sendRequest(new GetRequest(URL_WORKFLOW_INSTANCES + dateFilter), 200);
assertEquals(Status.STATUS_OK, dateFilteredResponse.getStatus());
String dateFilteredJsonStr = dateFilteredResponse.getContentAsString();
JSONObject dateFilteredJson = new JSONObject(dateFilteredJsonStr);
JSONArray dateFilteredResult = dateFilteredJson.getJSONArray("data");
assertNotNull(dateFilteredResult);
assertTrue(dateFilteredResult.length() > 0);
// filter by priority
String priorityFilter = "?priority=1";
Response priorityFilteredResponse = sendRequest(new GetRequest(URL_WORKFLOW_INSTANCES + priorityFilter), 200);
assertEquals(Status.STATUS_OK, priorityFilteredResponse.getStatus());
String priorityFilteredJsonStr = priorityFilteredResponse.getContentAsString();
JSONObject priorityFilteredJson = new JSONObject(priorityFilteredJsonStr);
JSONArray priorityFilteredResult = priorityFilteredJson.getJSONArray("data");
assertNotNull(priorityFilteredResult);
assertTrue(priorityFilteredResult.length() > 1);
// filter by state
String stateFilter = "?state=active";
Response stateFilteredResponse = sendRequest(new GetRequest(URL_WORKFLOW_INSTANCES + stateFilter), 200);
assertEquals(Status.STATUS_OK, stateFilteredResponse.getStatus());
String stateFilteredJsonStr = stateFilteredResponse.getContentAsString();
JSONObject stateFilteredJson = new JSONObject(stateFilteredJsonStr);
JSONArray stateFilteredResult = stateFilteredJson.getJSONArray("data");
assertNotNull(stateFilteredResult);
assertTrue(stateFilteredResult.length() > 1);
}
@Override
protected void setUp() throws Exception
{
@@ -449,4 +544,41 @@ public class WorkflowRestApiTest extends BaseWebScriptTest
}
}
}
private void checkSimpleWorkflowInstanceResponse(JSONObject json) throws JSONException
{
assertTrue(json.has("id"));
assertTrue(json.getString("id").length() > 0);
assertTrue(json.has("url"));
assertTrue(json.getString("url").startsWith(URL_WORKFLOW_INSTANCES));
assertTrue(json.has("name"));
assertTrue(json.getString("name").length() > 0);
assertTrue(json.has("title"));
assertTrue(json.getString("title").length() > 0);
assertTrue(json.has("description"));
assertTrue(json.getString("description").length() > 0);
assertTrue(json.has("isActive"));
assertTrue(json.has("startDate"));
assertTrue(json.getString("startDate").length() > 0);
assertTrue(json.has("endDate"));
assertTrue(json.has("initiator"));
Object initiator = json.get("initiator");
if (!initiator.equals(JSONObject.NULL))
{
assertTrue(((JSONObject)initiator).has("userName"));
assertTrue(((JSONObject)initiator).has("firstName"));
assertTrue(((JSONObject)initiator).has("lastName"));
}
assertTrue(json.has("definitionUrl"));
assertTrue(json.getString("definitionUrl").startsWith(URL_WORKFLOW_DEFINITIONS));
}
}