com.wewebu.ow.server.ecmimpl.alfresco.bpm.rest

Class AlfrescoRESTFulFactory

java.lang.Object

com.wewebu.ow.server.ecmimpl.alfresco.bpm.rest.AlfrescoRESTFulFactory

public class AlfrescoRESTFulFactory
extends Object

Factory to create RESTful resources for the new Alfresco Workflow Public REST API.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

4.2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	WORKFLOW_PUBLIC_REST_API_PATH

Constructor Summary

Constructors

Constructor and Description
AlfrescoRESTFulFactory(String baseURL, org.alfresco.wd.ext.restlet.auth.OwRestletAuthenticationHandler authHandler, Locale currentLocale, NativeValueConverterFactory converterFactory) Constructor for REST-Connection handler

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getCallUrl(String actionUri) Returns a full URL based on provided action URI, will cache the full URL and return it again if the action URI is requested again.
AlfrescoRESTFulFactoryOld	getOldAPIFactory() Deprecated. Will be removed in the future. Only temporary into service until the new API exposes enough information about the tasks.
ProcessDefinitionsResource	processDefinitionsResource(OperationContext context)
ProcessDefinitionStartFormModelResource	processDefinitionStartFormModelResource(String processDefinitionId)
ProcessesResource	processesResource()
ProcessImageResource	processImageResource(String processId)
ProcessInstanceResource	processInstance(String processId)
ProcessInstanceItemResource	processInstanceItem(String processId, String itemGuidId)
ProcessInstanceItemsResource	processInstanceItems(String processId)
void	release() Call this when you have finished working with this factory.
TaskFormModelResource	taskFormModelResource(String taskId)
TaskInstanceResource	taskInstanceResource(String taskId, String selectStatement) Creates a resource for working with a task instance.
TaskInstancesResource	taskInstancesForProcessResource(String processId)
TaskInstancesResource	taskInstancesResource(String assignee, String candidateUser, String candidateGroup, Status status, com.wewebu.ow.server.field.OwSearchNode filterCriteria_p, OperationContext context) Builds a restlet for the /tasks resource.
TaskInstanceStateResource	taskInstanceStateResource(String taskInstanceId)
TaskInstanceVariableResource	taskInstanceVariableResource(String taskId, String variableName)
TaskInstanceVariablesResource	taskInstanceVariablesResource(String taskId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WORKFLOW_PUBLIC_REST_API_PATH

protected static final String WORKFLOW_PUBLIC_REST_API_PATH

See Also:

Constant Field Values

Constructor Detail

AlfrescoRESTFulFactory

public AlfrescoRESTFulFactory(String baseURL,
                      org.alfresco.wd.ext.restlet.auth.OwRestletAuthenticationHandler authHandler,
                      Locale currentLocale,
                      NativeValueConverterFactory converterFactory)

Constructor for REST-Connection handler

Parameters:

baseURL - String base part of URL

authHandler - OwRestletAuthenticationHandler

currentLocale - Locale

converterFactory - NativeValueConverterFactory

Method Detail

processDefinitionsResource

public ProcessDefinitionsResource processDefinitionsResource(OperationContext context)
                                                      throws OwRestException

Returns:

a REST resource for accessing the process-definitions service.

Throws:

OwRestException - thrown if something goes wrong with the creation of the REST resource.

processDefinitionStartFormModelResource

public ProcessDefinitionStartFormModelResource processDefinitionStartFormModelResource(String processDefinitionId)
                                                                                throws OwRestException

Throws:

OwRestException

taskFormModelResource

public TaskFormModelResource taskFormModelResource(String taskId)
                                            throws OwRestException

Throws:

OwRestException

processesResource

public ProcessesResource processesResource()
                                    throws OwRestException

Throws:

OwRestException

taskInstanceResource

public TaskInstanceResource taskInstanceResource(String taskId,
                                        String selectStatement)
                                          throws OwRestException

Creates a resource for working with a task instance.

Parameters:

taskId - the ID of the task that will be updated.

selectStatement - comma separated list of the names of the fields that should be updated (this is needed for a partial update).

Returns:

a resource that you can use to update a task.

Throws:

OwRestException

taskInstancesResource

public TaskInstancesResource taskInstancesResource(String assignee,
                                          String candidateUser,
                                          String candidateGroup,
                                          Status status,
                                          com.wewebu.ow.server.field.OwSearchNode filterCriteria_p,
                                          OperationContext context)
                                            throws OwRestException

Builds a restlet for the /tasks resource.

Parameters:

assignee - - return only tasks for which the assignee is this user.

candidateUser - - return only tasks for which this user is a candidate.

candidateGroup - - return only tasks for which this group is a candidate.

status - - only return tasks with a given status.

filterCriteria_p - - additional filtering based on tasks' variables should be expressed as a OwSearchNode.

Returns:

a resource which you can call to get a list of tasks matching the specified criteria.

Throws:

OwRestException

taskInstancesForProcessResource

public TaskInstancesResource taskInstancesForProcessResource(String processId)
                                                      throws OwRestException

Throws:

OwRestException

processInstanceItems

public ProcessInstanceItemsResource processInstanceItems(String processId)
                                                  throws OwRestException

Throws:

OwRestException

processInstanceItem

public ProcessInstanceItemResource processInstanceItem(String processId,
                                              String itemGuidId)
                                                throws OwRestException

Throws:

OwRestException

processInstance

public ProcessInstanceResource processInstance(String processId)
                                        throws OwRestException

Throws:

OwRestException

processImageResource

public ProcessImageResource processImageResource(String processId)
                                          throws OwRestException

Throws:

OwRestException

taskInstanceVariableResource

public TaskInstanceVariableResource taskInstanceVariableResource(String taskId,
                                                        String variableName)
                                                          throws OwRestException

Throws:

OwRestException

taskInstanceVariablesResource

public TaskInstanceVariablesResource taskInstanceVariablesResource(String taskId)
                                                            throws OwRestException

Throws:

OwRestException

taskInstanceStateResource

public TaskInstanceStateResource taskInstanceStateResource(String taskInstanceId)
                                                    throws OwRestException

Throws:

OwRestException

getCallUrl

protected String getCallUrl(String actionUri)

Returns a full URL based on provided action URI, will cache the full URL and return it again if the action URI is requested again.

Parameters:

actionUri - String URI of the action

Returns:

String full URL for requested action URI

release

public void release()

Call this when you have finished working with this factory. It will release all Restlet client connectors.

getOldAPIFactory

public AlfrescoRESTFulFactoryOld getOldAPIFactory()

Deprecated. Will be removed in the future. Only temporary into service until the new API exposes enough information about the tasks.

Returns:

the oldAPIFactory