DocumentRoutingServiceImpl (Nuxeo ECM Projects 7.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.runtime.model.DefaultComponent
- - org.nuxeo.ecm.platform.routing.core.impl.DocumentRoutingServiceImpl

All Implemented Interfaces:

DocumentRoutingService, Adaptable, Component, Extensible, TimestampedService
```
public class DocumentRoutingServiceImpl
extends DefaultComponent
implements DocumentRoutingService
```
The implementation of the routing service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTOR_ACE_CREATOR`
`static String`	`CHAINS_TO_TYPE_XP`
`protected DocumentRoutingPersister`	`persister`
`static String`	`PERSISTER_XP`
`protected RepositoryInitializationHandler`	`repositoryInitializationHandler`
`static String`	`ROUTE_MODELS_IMPORTER_XP`
`protected RouteTemplateResourceRegistry`	`routeResourcesRegistry`
`protected Map<String,String>`	`typeToChain`
`protected Map<String,String>`	`undoChainIdFromDone`
`protected Map<String,String>`	`undoChainIdFromRunning`

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent
lastModified

Constructor Summary

Constructors
Constructor and Description

DocumentRoutingServiceImpl()

Constructors
Constructor and Description
`DocumentRoutingServiceImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activate(ComponentContext context)` Activates the component.
`void`	`addRouteElementToRoute(DocumentRef parentDocumentRef, int idx, DocumentRouteElement routeElement, CoreSession session)` Deprecated.
`void`	`addRouteElementToRoute(DocumentRef parentDocumentRef, String sourceName, DocumentRouteElement routeElement, CoreSession session)` Deprecated.
`void`	`cancelTask(CoreSession session, String taskId)` Cancels an open task.
`boolean`	`canUserValidateRoute(NuxeoPrincipal currentUser)` if the user can validate a route.
`boolean`	`canValidateRoute(DocumentModel documentRoute, CoreSession coreSession)` Checks if the principal that created the client session can validate the route
`void`	`cleanupDoneAndCanceledRouteInstances(String reprositoryName, int limit)` Query for the routes 'done' or 'canceled' and delete them.
`void`	`completeTask(String routeId, String taskId, Map<String,Object> data, String status, CoreSession session)` Completes a task on a give node.
`protected void`	`completeTask(String routeId, String nodeId, Task task, Map<String,Object> data, String status, CoreSession session)`
`DocumentRoute`	`createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session)` Deprecated.
`DocumentRoute`	`createNewInstance(DocumentRoute model, List<String> docIds, CoreSession session, boolean startInstance)` Create a new `DocumentRoute` instance from this `DocumentRoute` model.
`DocumentRoute`	`createNewInstance(DocumentRoute model, String documentId, CoreSession session)` Deprecated.
`DocumentRoute`	`createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance)` Deprecated.
`String`	`createNewInstance(String routeModelId, List<String> docIds, CoreSession session, boolean startInstance)` Creates a new route instance and optionally starts it.
`String`	`createNewInstance(String routeModelId, List<String> docIds, Map<String,Serializable> map, CoreSession session, boolean startInstance)` Creates a new route instance and optionally starts it.
`void`	`deactivate(ComponentContext context)` Deactivates the component.
`void`	`delegateTask(CoreSession session, String taskId, List<String> delegatedActors, String comment)` Reassigns the given task to the list of actors.
`int`	`doCleanupDoneAndCanceledRouteInstances(String reprositoryName, int limit)` Query for the routes 'done' or 'canceled' and delete them.
`void`	`endTask(CoreSession session, Task task, Map<String,Object> data, String status)` Ends a task.
`void`	`finishTask(CoreSession session, DocumentRoute route, Task task, boolean delete)` Finishes an open task.
`protected static void`	`fireEvent(String eventName, Map<String,Serializable> eventProperties, DocumentRoute route, CoreSession session)`
`protected void`	`fireEventAfterWorkflowStarted(DocumentRoute route, CoreSession session)`
`List<DocumentRoute>`	`getAvailableDocumentRoute(CoreSession session)` Return the list of available `DocumentRoute` document route.
`List<DocumentRoute>`	`getAvailableDocumentRouteModel(CoreSession session)` Return the list of available `DocumentRoute` model the user can start.
`protected static String`	`getDelegationACLName(String taskId)`
`protected static String`	`getDelegationACLName(Task task)`
`List<DocumentRoute>`	`getDocumentRelatedWorkflows(DocumentModel document, CoreSession session)`
`List<DocumentRoute>`	`getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId)`
`List<DocumentRoute>`	`getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states)` Return the list of related `DocumentRoute` in a state for a given attached document.
`protected FileManager`	`getFileManager()`
`String`	`getOperationChainId(String documentType)` Return the operation chain to run for a documentType.
`DocumentModelList`	`getOrderedRouteElement(String routeElementId, CoreSession session)` Get the children of the given stepFolder ordered by the ecm:pos metadata.
`List<DocumentRouteTableElement>`	`getRouteElements(DocumentRoute route, CoreSession session)` Deprecated. since 5.9.2 - Use only routes of type 'graph'
`protected List<DocumentRouteTableElement>`	`getRouteElements(DocumentRouteElement routeElementDocument, CoreSession session, List<DocumentRouteTableElement> routeElements, int depth)` Deprecated.
`String`	`getRouteModelDocIdWithId(CoreSession session, String id)` Returns the doc id of the route model with the given id
`List<URL>`	`getRouteModelTemplateResources()` Returns all the route models resource templates.
`DocumentRoute`	`getRouteModelWithId(CoreSession session, String id)` Returns the route model with the given id
`protected static String`	`getRoutingACLName(String taskId)`
`protected static String`	`getRoutingACLName(Task task)` Finds an ACL name specific to the task (there may be several tasks applying permissions to the same document).
`List<DocumentRoute>`	`getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session)`
`List<DocumentRoute>`	`getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session, String worflowModelName)`
`List<Task>`	`getTasks(DocumentModel document, String actorId, String workflowInstanceId, String worflowModelName, CoreSession session)`
`String`	`getUndoFromDoneOperationChainId(String documentType)` Return the operation chain to undo a step when the step is in done state.
`String`	`getUndoFromRunningOperationChainId(String documentType)` Return the operation chain to undo a step when the step is in running state.
`protected URL`	`getUrlFromPath(RouteModelResourceType res, RuntimeContext extensionContext)`
`List<DocumentModel>`	`getWorkflowInputDocuments(CoreSession session, Task task)` Gets the documents following the workflow to which the given task belongs
`void`	`grantPermissionToTaskAssignees(CoreSession session, String permission, List<DocumentModel> docs, Task task)` Grants on these documents the specified assignees permissions for this task.
`void`	`grantPermissionToTaskDelegatedActors(CoreSession session, String permission, List<DocumentModel> docs, Task task)` Grants on these documents the specified assignees permissions for this task to the tasks delegated actors.
`void`	`importAllRouteModels(CoreSession session)` Imports all the route models resource templates.
`DocumentRoute`	`importRouteModel(URL modelToImport, boolean overwrite, CoreSession session)` Creates a route model in the root models folder defined by the current persister.
`void`	`invalidateRouteModelsCache()`
`boolean`	`isLockedByCurrentUser(DocumentRoute routeModel, CoreSession session)` Verify is this `DocumentRoute` is already locked by the current user.
`boolean`	`isRoutable(DocumentModel doc)` Checks if the given document can be associated to a DocumentRoute.
`boolean`	`isWorkflowModel(DocumentRoute documentRoute)` Returns true id the document route is a model, false if it is just an instance i.e.
`void`	`lockDocumentRoute(DocumentRoute routeModel, CoreSession session)` Locks this `DocumentRoute` if not already locked by the current user.
`void`	`makeRoutingTasks(CoreSession coreSession, List<Task> tasks)` Deprecated.
`protected void`	`processElementsInFolder(DocumentModel doc, List<DocumentRouteTableElement> elements, RouteTable table, CoreSession session, int depth, RouteFolderElement folder)` Deprecated. since 5.9.2 - Use only routes of type 'graph'
`void`	`reassignTask(CoreSession session, String taskId, List<String> actors, String comment)` Reassigns the given task to the list of actors.
`void`	`registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)`
`void`	`registerRouteResource(RouteModelResourceType res, RuntimeContext context)` Registers a new route model template to be imported at application startup.
`void`	`removePermissionFromTaskAssignees(CoreSession session, List<DocumentModel> docs, Task task)` Removes on these documents the specified assignees permissions for this task.
`void`	`removePermissionsForTaskActors(CoreSession session, List<DocumentModel> docs, String taskId)` Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
`void`	`removePermissionsForTaskActors(CoreSession session, List<DocumentModel> docs, Task task)` Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
`void`	`removeRouteElement(DocumentRouteElement routeElement, CoreSession session)` Remove the given route element
`void`	`resumeInstance(String routeId, String nodeId, Map<String,Object> data, String status, CoreSession session)` Resumes a route instance on a give node.
`DocumentRoute`	`saveRouteAsNewModel(DocumentRoute instance, CoreSession session)` Save a route instance as a new model of route.
`List<DocumentModel>`	`searchRouteModels(CoreSession session, String searchString)` Returns the route models matching the `searchString`.
`protected void`	`setAclForActors(CoreSession session, String aclName, String permission, List<DocumentModel> docs, List<String> actors)`
`void`	`startInstance(String routeInstanceId, List<String> docIds, Map<String,Serializable> map, CoreSession session)` Starts an instance that was created with `DocumentRoutingService.createNewInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession, boolean)` but with `startInstance = false`.
`void`	`unlockDocumentRoute(DocumentRoute routeModel, CoreSession session)` Unlocks this `DocumentRoute`.If the document is not locked throws a `DocumentRouteNotLockedException`
`DocumentRoute`	`unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession)` Unlock the given `DocumentRoute` model under unrestricted session.
`void`	`unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)`
`void`	`updateRouteElement(DocumentRouteElement routeElement, CoreSession session)` Update the given route element
`protected void`	`updateTaskInfo(CoreSession session, GraphRoute graph, Task task, String status)`
`DocumentRoute`	`validateRouteModel(DocumentRoute routeModel, CoreSession userSession)` Validates the given `DocumentRoute` model by changing its lifecycle state and setting it and all its children in ReadOnly.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent
applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHAINS_TO_TYPE_XP
```
public static final String CHAINS_TO_TYPE_XP
```
    See Also:
    
    Constant Field Values
  - PERSISTER_XP
```
public static final String PERSISTER_XP
```
    See Also:
    
    Constant Field Values
  - ACTOR_ACE_CREATOR
```
public static final String ACTOR_ACE_CREATOR
```
    Since:
    
    7.10
    
    See Also:
    
    Constant Field Values
  - ROUTE_MODELS_IMPORTER_XP
```
public static final String ROUTE_MODELS_IMPORTER_XP
```
    See Also:
    
    Constant Field Values
  - typeToChain
```
protected Map<String,String> typeToChain
```
  - undoChainIdFromRunning
```
protected Map<String,String> undoChainIdFromRunning
```
  - undoChainIdFromDone
```
protected Map<String,String> undoChainIdFromDone
```
  - persister
```
protected DocumentRoutingPersister persister
```
  - routeResourcesRegistry
```
protected RouteTemplateResourceRegistry routeResourcesRegistry
```
  - repositoryInitializationHandler
```
protected RepositoryInitializationHandler repositoryInitializationHandler
```
- Constructor Detail
  - DocumentRoutingServiceImpl
```
public DocumentRoutingServiceImpl()
```
- Method Detail
  - registerContribution
```
public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)
```
    Overrides:
    
    registerContribution in class DefaultComponent
  - unregisterContribution
```
public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)
```
    Overrides:
    
    unregisterContribution in class DefaultComponent
  - fireEvent
```
protected static void fireEvent(String eventName,
                                Map<String,Serializable> eventProperties,
                                DocumentRoute route,
                                CoreSession session)
```
  - createNewInstance
```
public String createNewInstance(String routeModelId,
                                List<String> docIds,
                                Map<String,Serializable> map,
                                CoreSession session,
                                boolean startInstance)
```
    Description copied from interface: DocumentRoutingService
    
    Creates a new route instance and optionally starts it.
    If startInstance = false, then the route can be started later by calling DocumentRoutingService.startInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession).
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
    
    Parameters:
    
    routeModelId - the route model id
    
    docIds - the list of document bound to the instance
    
    map - the values to pass as initial workflow variables
    
    session - the session
    
    startInstance - if the route is automatically started
    
    Returns:
    
    the created route instance id
  - createNewInstance
```
public String createNewInstance(String routeModelId,
                                List<String> docIds,
                                CoreSession session,
                                boolean startInstance)
```
    Description copied from interface: DocumentRoutingService
    
    Creates a new route instance and optionally starts it.
    If startInstance = false, then the route can be started later by calling DocumentRoutingService.startInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession).
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
    
    Parameters:
    
    routeModelId - the route model id
    
    docIds - The list of document bound to the instance.
    
    session - the session
    
    startInstance - if the route is automatically started
    
    Returns:
    
    the created route instance id
  - createNewInstance
```
public DocumentRoute createNewInstance(DocumentRoute model,
                                       List<String> docIds,
                                       CoreSession session,
                                       boolean startInstance)
```
    Description copied from interface: DocumentRoutingService
    
    Create a new DocumentRoute instance from this DocumentRoute model.
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
    
    Parameters:
    
    model - The model used to create the instance.
    
    docIds - The list of document bound to the instance.
    
    startInstance - if the DocumentRoute is automatically started.
    
    Returns:
    
    the created DocumentRoute instance.
  - createNewInstance
```
@Deprecated
public DocumentRoute createNewInstance(DocumentRoute model,
                                                   String documentId,
                                                   CoreSession session,
                                                   boolean startInstance)
```
    Deprecated.
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
  - createNewInstance
```
@Deprecated
public DocumentRoute createNewInstance(DocumentRoute model,
                                                   List<String> documentIds,
                                                   CoreSession session)
```
    Deprecated.
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
  - createNewInstance
```
@Deprecated
public DocumentRoute createNewInstance(DocumentRoute model,
                                                   String documentId,
                                                   CoreSession session)
```
    Deprecated.
    
    Specified by:
    
    createNewInstance in interface DocumentRoutingService
  - startInstance
```
public void startInstance(String routeInstanceId,
                          List<String> docIds,
                          Map<String,Serializable> map,
                          CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Starts an instance that was created with DocumentRoutingService.createNewInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession, boolean) but with startInstance = false.
    
    Specified by:
    
    startInstance in interface DocumentRoutingService
    
    Parameters:
    
    routeInstanceId - the route instance id
    
    docIds - the list of document bound to the instance
    
    map - the values to pass as initial workflow variables
    
    session - the session
  - fireEventAfterWorkflowStarted
```
protected void fireEventAfterWorkflowStarted(DocumentRoute route,
                                             CoreSession session)
```
  - resumeInstance
```
public void resumeInstance(String routeId,
                           String nodeId,
                           Map<String,Object> data,
                           String status,
                           CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Resumes a route instance on a give node. Any remaining tasks on this node will be cancelled.
    Called by the UI action corresponding to a task button.
    
    Specified by:
    
    resumeInstance in interface DocumentRoutingService
    
    Parameters:
    
    routeId - the id of the route instance
    
    nodeId - the node id to resume on
    
    data - the data coming from UI form
    
    status - the status coming from UI form
    
    session - the session
  - completeTask
```
public void completeTask(String routeId,
                         String taskId,
                         Map<String,Object> data,
                         String status,
                         CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Completes a task on a give node. If this is the last task the workflow will continue.
    Called by the UI action corresponding to a task button.
    
    Specified by:
    
    completeTask in interface DocumentRoutingService
    
    Parameters:
    
    routeId - the id of the route instance
    
    taskId - the id of the task
    
    data - the data coming from UI form
    
    status - the status coming from UI form
    
    session - the session
  - completeTask
```
protected void completeTask(String routeId,
                            String nodeId,
                            Task task,
                            Map<String,Object> data,
                            String status,
                            CoreSession session)
```
  - getAvailableDocumentRouteModel
```
public List<DocumentRoute> getAvailableDocumentRouteModel(CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Return the list of available DocumentRoute model the user can start.
    
    Specified by:
    
    getAvailableDocumentRouteModel in interface DocumentRoutingService
    
    Parameters:
    
    session - The session of the user.
    
    Returns:
    
    A list of available DocumentRoute
  - getAvailableDocumentRoute
```
public List<DocumentRoute> getAvailableDocumentRoute(CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Return the list of available DocumentRoute document route.
    
    Specified by:
    
    getAvailableDocumentRoute in interface DocumentRoutingService
    
    Parameters:
    
    session - The session of the user.
    
    Returns:
    
    A list of available DocumentRoute
  - getOperationChainId
```
public String getOperationChainId(String documentType)
```
    Description copied from interface: DocumentRoutingService
    
    Return the operation chain to run for a documentType. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.
    
    Specified by:
    
    getOperationChainId in interface DocumentRoutingService
    
    Parameters:
    
    documentType - The document type
    
    Returns:
    
    The operation chain id.
  - getUndoFromRunningOperationChainId
```
public String getUndoFromRunningOperationChainId(String documentType)
```
    Description copied from interface: DocumentRoutingService
    
    Return the operation chain to undo a step when the step is in running state. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.
    
    Specified by:
    
    getUndoFromRunningOperationChainId in interface DocumentRoutingService
    
    Returns:
  - getUndoFromDoneOperationChainId
```
public String getUndoFromDoneOperationChainId(String documentType)
```
    Description copied from interface: DocumentRoutingService
    
    Return the operation chain to undo a step when the step is in done state. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.
    
    Specified by:
    
    getUndoFromDoneOperationChainId in interface DocumentRoutingService
    
    Returns:
  - unlockDocumentRouteUnrestrictedSession
```
public DocumentRoute unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel,
                                                            CoreSession userSession)
```
    Description copied from interface: DocumentRoutingService
    
    Unlock the given DocumentRoute model under unrestricted session.
    
    Specified by:
    
    unlockDocumentRouteUnrestrictedSession in interface DocumentRoutingService
    
    Returns:
    
    The unlocked route.
  - validateRouteModel
```
public DocumentRoute validateRouteModel(DocumentRoute routeModel,
                                        CoreSession userSession)
                                 throws DocumentRouteNotLockedException
```
    Description copied from interface: DocumentRoutingService
    
    Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.
    
    Specified by:
    
    validateRouteModel in interface DocumentRoutingService
    
    Returns:
    
    The validated route.
    
    Throws:
    
    DocumentRouteNotLockedException
  - getRouteElements
```
@Deprecated
public List<DocumentRouteTableElement> getRouteElements(DocumentRoute route,
                                                                    CoreSession session)
```
    Deprecated. since 5.9.2 - Use only routes of type 'graph'
    
    Description copied from interface: DocumentRoutingService
    
    Computes the list of elements DocumentRouteTableElement for this DocumentRoute.
    
    Specified by:
    
    getRouteElements in interface DocumentRoutingService
    
    session - The session used to query the DocumentRoute.
  - processElementsInFolder
```
@Deprecated
protected void processElementsInFolder(DocumentModel doc,
                                                   List<DocumentRouteTableElement> elements,
                                                   RouteTable table,
                                                   CoreSession session,
                                                   int depth,
                                                   RouteFolderElement folder)
```
    Deprecated. since 5.9.2 - Use only routes of type 'graph'
  - getRouteElements
```
@Deprecated
protected List<DocumentRouteTableElement> getRouteElements(DocumentRouteElement routeElementDocument,
                                                                       CoreSession session,
                                                                       List<DocumentRouteTableElement> routeElements,
                                                                       int depth)
```
    Deprecated.
  - getDocumentRoutesForAttachedDocument
```
public List<DocumentRoute> getDocumentRoutesForAttachedDocument(CoreSession session,
                                                                String attachedDocId)
```
    Specified by:
    
    getDocumentRoutesForAttachedDocument in interface DocumentRoutingService
    
    Returns:
    
    See Also:
    
    for route running or ready.
  - getDocumentRoutesForAttachedDocument
```
public List<DocumentRoute> getDocumentRoutesForAttachedDocument(CoreSession session,
                                                                String attachedDocId,
                                                                List<DocumentRouteElement.ElementLifeCycleState> states)
```
    Description copied from interface: DocumentRoutingService
    
    Return the list of related DocumentRoute in a state for a given attached document.
    
    Specified by:
    
    getDocumentRoutesForAttachedDocument in interface DocumentRoutingService
    
    Parameters:
    
    session - The session used to query the DocumentRoute.
    
    states - the list of states.
    
    Returns:
    
    A list of available DocumentRoute
  - canUserValidateRoute
```
public boolean canUserValidateRoute(NuxeoPrincipal currentUser)
```
    Description copied from interface: DocumentRoutingService
    
    if the user can validate a route.
    
    Specified by:
    
    canUserValidateRoute in interface DocumentRoutingService
  - canValidateRoute
```
public boolean canValidateRoute(DocumentModel documentRoute,
                                CoreSession coreSession)
```
    Description copied from interface: DocumentRoutingService
    
    Checks if the principal that created the client session can validate the route
    
    Specified by:
    
    canValidateRoute in interface DocumentRoutingService
  - addRouteElementToRoute
```
@Deprecated
public void addRouteElementToRoute(DocumentRef parentDocumentRef,
                                               int idx,
                                               DocumentRouteElement routeElement,
                                               CoreSession session)
                                        throws DocumentRouteNotLockedException
```
    Deprecated.
    
    Description copied from interface: DocumentRoutingService
    
    Add a route element in another route element.
    
    Specified by:
    
    addRouteElementToRoute in interface DocumentRoutingService
    
    Parameters:
    
    parentDocumentRef - The DocumentRef of the parent document.
    
    idx - The position of the document in its container.
    
    routeElement - The document to add.
    
    Throws:
    
    DocumentRouteNotLockedException
  - addRouteElementToRoute
```
@Deprecated
public void addRouteElementToRoute(DocumentRef parentDocumentRef,
                                               String sourceName,
                                               DocumentRouteElement routeElement,
                                               CoreSession session)
                                        throws DocumentRouteNotLockedException
```
    Deprecated.
    
    Description copied from interface: DocumentRoutingService
    
    Add a route element in another route element.
    If the parent element is in draft state, the routeElement is kept in draft state. Otherwise, the element is set to 'ready' state.
    
    Specified by:
    
    addRouteElementToRoute in interface DocumentRoutingService
    
    Parameters:
    
    parentDocumentRef - The DocumentRef of the parent document.
    
    sourceName - the name of the previous document in the container.
    
    routeElement - the document to add.
    
    Throws:
    
    DocumentRouteNotLockedException
  - removeRouteElement
```
public void removeRouteElement(DocumentRouteElement routeElement,
                               CoreSession session)
                        throws DocumentRouteNotLockedException
```
    Description copied from interface: DocumentRoutingService
    
    Remove the given route element
    
    Specified by:
    
    removeRouteElement in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteNotLockedException
  - getOrderedRouteElement
```
public DocumentModelList getOrderedRouteElement(String routeElementId,
                                                CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Get the children of the given stepFolder ordered by the ecm:pos metadata.
    
    Specified by:
    
    getOrderedRouteElement in interface DocumentRoutingService
    
    Returns:
  - lockDocumentRoute
```
public void lockDocumentRoute(DocumentRoute routeModel,
                              CoreSession session)
                       throws DocumentRouteAlredayLockedException
```
    Description copied from interface: DocumentRoutingService
    
    Locks this DocumentRoute if not already locked by the current user. If the document is already locked by another user and DocumentRouteAlredayLockedException is thrown
    
    Specified by:
    
    lockDocumentRoute in interface DocumentRoutingService
    
    session - The session used to lock the DocumentRoute.
    
    Throws:
    
    DocumentRouteAlredayLockedException
  - unlockDocumentRoute
```
public void unlockDocumentRoute(DocumentRoute routeModel,
                                CoreSession session)
                         throws DocumentRouteNotLockedException
```
    Description copied from interface: DocumentRoutingService
    
    Unlocks this DocumentRoute.If the document is not locked throws a DocumentRouteNotLockedException
    
    Specified by:
    
    unlockDocumentRoute in interface DocumentRoutingService
    
    session - The session used to lock the DocumentRoute.
    
    Throws:
    
    DocumentRouteNotLockedException
  - isLockedByCurrentUser
```
public boolean isLockedByCurrentUser(DocumentRoute routeModel,
                                     CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Verify is this DocumentRoute is already locked by the current user.
    
    Specified by:
    
    isLockedByCurrentUser in interface DocumentRoutingService
  - updateRouteElement
```
public void updateRouteElement(DocumentRouteElement routeElement,
                               CoreSession session)
                        throws DocumentRouteNotLockedException
```
    Description copied from interface: DocumentRoutingService
    
    Update the given route element
    
    Specified by:
    
    updateRouteElement in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteNotLockedException
  - saveRouteAsNewModel
```
public DocumentRoute saveRouteAsNewModel(DocumentRoute instance,
                                         CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Save a route instance as a new model of route.
    The place in which the new instance is persisted and its name depends on DocumentRoutingPersister. The route instance should be in either running, done or ready state. The new route model will be in draft state and won't have any attached documents.
    
    Specified by:
    
    saveRouteAsNewModel in interface DocumentRoutingService
    
    Parameters:
    
    instance - the instance from which we create a new model.
    
    Returns:
    
    the new model in draft state.
  - isRoutable
```
public boolean isRoutable(DocumentModel doc)
```
    Description copied from interface: DocumentRoutingService
    
    Checks if the given document can be associated to a DocumentRoute.
    
    Specified by:
    
    isRoutable in interface DocumentRoutingService
    
    Parameters:
    
    doc - the document
    
    Returns:
    
    true if the document can be routed
  - importAllRouteModels
```
public void importAllRouteModels(CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Imports all the route models resource templates.
    
    Specified by:
    
    importAllRouteModels in interface DocumentRoutingService
    
    Parameters:
    
    session - the core session to use
  - importRouteModel
```
public DocumentRoute importRouteModel(URL modelToImport,
                                      boolean overwrite,
                                      CoreSession session)
```
    Description copied from interface: DocumentRoutingService
    
    Creates a route model in the root models folder defined by the current persister. The templateResource is a zip tree xml export of a route document and it is imported using the core-io importer.
    
    Specified by:
    
    importRouteModel in interface DocumentRoutingService
  - getFileManager
```
protected FileManager getFileManager()
```
  - activate
```
public void activate(ComponentContext context)
```
    Description copied from interface: Component
    
    Activates the component.
    This method is called by the runtime when a component is activated.
    
    Specified by:
    
    activate in interface Component
    
    Overrides:
    
    activate in class DefaultComponent
    
    Parameters:
    
    context - the runtime context
  - deactivate
```
public void deactivate(ComponentContext context)
```
    Description copied from interface: Component
    
    Deactivates the component.
    This method is called by the runtime when a component is deactivated.
    
    Specified by:
    
    deactivate in interface Component
    
    Overrides:
    
    deactivate in class DefaultComponent
    
    Parameters:
    
    context - the runtime context
  - getRouteModelTemplateResources
```
public List<URL> getRouteModelTemplateResources()
```
    Description copied from interface: DocumentRoutingService
    
    Returns all the route models resource templates. Use the routeModelImporter extension point to contribute new resources.
    
    Specified by:
    
    getRouteModelTemplateResources in interface DocumentRoutingService
  - searchRouteModels
```
public List<DocumentModel> searchRouteModels(CoreSession session,
                                             String searchString)
```
    Description copied from interface: DocumentRoutingService
    
    Returns the route models matching the searchString.
    
    Specified by:
    
    searchRouteModels in interface DocumentRoutingService
  - registerRouteResource
```
public void registerRouteResource(RouteModelResourceType res,
                                  RuntimeContext context)
```
    Description copied from interface: DocumentRoutingService
    
    Registers a new route model template to be imported at application startup.
    
    Specified by:
    
    registerRouteResource in interface DocumentRoutingService
    
    Parameters:
    
    res - the resource
  - getUrlFromPath
```
protected URL getUrlFromPath(RouteModelResourceType res,
                             RuntimeContext extensionContext)
```
  - getRouteModelWithId
```
public DocumentRoute getRouteModelWithId(CoreSession session,
                                         String id)
```
    Description copied from interface: DocumentRoutingService
    
    Returns the route model with the given id
    
    Specified by:
    
    getRouteModelWithId in interface DocumentRoutingService
  - getRouteModelDocIdWithId
```
public String getRouteModelDocIdWithId(CoreSession session,
                                       String id)
```
    Description copied from interface: DocumentRoutingService
    
    Returns the doc id of the route model with the given id
    
    Specified by:
    
    getRouteModelDocIdWithId in interface DocumentRoutingService
  - makeRoutingTasks
```
@Deprecated
public void makeRoutingTasks(CoreSession coreSession,
                                         List<Task> tasks)
```
    Deprecated.
    
    Description copied from interface: DocumentRoutingService
    
    Marks the tasks as Routing tasks.
    This allows the related documents to be adapted to RoutingTask.
    
    Specified by:
    
    makeRoutingTasks in interface DocumentRoutingService
    
    Parameters:
    
    coreSession - the session
    
    tasks - the tasks
  - endTask
```
public void endTask(CoreSession session,
                    Task task,
                    Map<String,Object> data,
                    String status)
```
    Description copied from interface: DocumentRoutingService
    
    Ends a task. If this is the last task the workflow will continue.
    
    Specified by:
    
    endTask in interface DocumentRoutingService
    
    status - name of the button clicked to submit the task form
  - getWorkflowInputDocuments
```
public List<DocumentModel> getWorkflowInputDocuments(CoreSession session,
                                                     Task task)
```
    Description copied from interface: DocumentRoutingService
    
    Gets the documents following the workflow to which the given task belongs
    
    Specified by:
    
    getWorkflowInputDocuments in interface DocumentRoutingService
    
    Returns:
  - grantPermissionToTaskAssignees
```
public void grantPermissionToTaskAssignees(CoreSession session,
                                           String permission,
                                           List<DocumentModel> docs,
                                           Task task)
```
    Description copied from interface: DocumentRoutingService
    
    Grants on these documents the specified assignees permissions for this task.
    
    Specified by:
    
    grantPermissionToTaskAssignees in interface DocumentRoutingService
    
    Parameters:
    
    session - the session
    
    permission - the permission
    
    docs - the documents
    
    task - the task
  - grantPermissionToTaskDelegatedActors
```
public void grantPermissionToTaskDelegatedActors(CoreSession session,
                                                 String permission,
                                                 List<DocumentModel> docs,
                                                 Task task)
```
    Description copied from interface: DocumentRoutingService
    
    Grants on these documents the specified assignees permissions for this task to the tasks delegated actors.
    
    Specified by:
    
    grantPermissionToTaskDelegatedActors in interface DocumentRoutingService
    
    Parameters:
    
    session - the session
    
    permission - the permission
    
    docs - the documents
    
    task - the task
  - removePermissionFromTaskAssignees
```
public void removePermissionFromTaskAssignees(CoreSession session,
                                              List<DocumentModel> docs,
                                              Task task)
```
    Description copied from interface: DocumentRoutingService
    
    Removes on these documents the specified assignees permissions for this task.
    
    Specified by:
    
    removePermissionFromTaskAssignees in interface DocumentRoutingService
    
    Parameters:
    
    session - the session
    
    docs - the documents
    
    task - the task
  - removePermissionsForTaskActors
```
public void removePermissionsForTaskActors(CoreSession session,
                                           List<DocumentModel> docs,
                                           String taskId)
```
    Description copied from interface: DocumentRoutingService
    
    Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
    
    Specified by:
    
    removePermissionsForTaskActors in interface DocumentRoutingService
    
    Parameters:
    
    session - the session
    
    docs - the documents
    
    taskId - the taskId
    
    Since:
    
    7.4
  - removePermissionsForTaskActors
```
public void removePermissionsForTaskActors(CoreSession session,
                                           List<DocumentModel> docs,
                                           Task task)
```
    Description copied from interface: DocumentRoutingService
    
    Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
    
    Specified by:
    
    removePermissionsForTaskActors in interface DocumentRoutingService
    
    Parameters:
    
    session - the session
    
    docs - the documents
    
    task - the task
  - getRoutingACLName
```
protected static String getRoutingACLName(Task task)
```
    Finds an ACL name specific to the task (there may be several tasks applying permissions to the same document).
  - getRoutingACLName
```
protected static String getRoutingACLName(String taskId)
```
    Since:
    
    7.4
  - getDelegationACLName
```
protected static String getDelegationACLName(Task task)
```
  - getDelegationACLName
```
protected static String getDelegationACLName(String taskId)
```
    Since:
    
    7.4
  - finishTask
```
public void finishTask(CoreSession session,
                       DocumentRoute route,
                       Task task,
                       boolean delete)
                throws DocumentRouteException
```
    Description copied from interface: DocumentRoutingService
    
    Finishes an open task. All permissions granted to the tasks assignees on the document following the worklflow are removed. Doesn't resume the workflow as the completeTask method. Not executed using an unrestricted session.
    
    Specified by:
    
    finishTask in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteException
  - cancelTask
```
public void cancelTask(CoreSession session,
                       String taskId)
                throws DocumentRouteException
```
    Description copied from interface: DocumentRoutingService
    
    Cancels an open task. If the task was created by an workflow, all permissions granted to the tasks assignees on the document following the worklflow are removed. Doesn't resume the workflow as the completeTask method.
    
    Specified by:
    
    cancelTask in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteException
  - updateTaskInfo
```
protected void updateTaskInfo(CoreSession session,
                              GraphRoute graph,
                              Task task,
                              String status)
```
  - reassignTask
```
public void reassignTask(CoreSession session,
                         String taskId,
                         List<String> actors,
                         String comment)
                  throws DocumentRouteException
```
    Description copied from interface: DocumentRoutingService
    
    Reassigns the given task to the list of actors. Removes the permissions granted on the document following the workflow to the current task assignees and grants them to the new actors.
    
    Specified by:
    
    reassignTask in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteException
  - delegateTask
```
public void delegateTask(CoreSession session,
                         String taskId,
                         List<String> delegatedActors,
                         String comment)
                  throws DocumentRouteException
```
    Description copied from interface: DocumentRoutingService
    
    Reassigns the given task to the list of actors. Grants to new delegated actors the same permissions as the task assignees on the document following the workflow .
    
    Specified by:
    
    delegateTask in interface DocumentRoutingService
    
    Throws:
    
    DocumentRouteException
  - setAclForActors
```
protected void setAclForActors(CoreSession session,
                               String aclName,
                               String permission,
                               List<DocumentModel> docs,
                               List<String> actors)
```
  - cleanupDoneAndCanceledRouteInstances
```
public void cleanupDoneAndCanceledRouteInstances(String reprositoryName,
                                                 int limit)
```
    Description copied from interface: DocumentRoutingService
    
    Query for the routes 'done' or 'canceled' and delete them. The max no of the routes that will be deleted is specified by the 'limit' parameter. When the limit is '0' all the completed routes are deleted. The routes to be deleted are ordered ascending by their creation date.
    
    Specified by:
    
    cleanupDoneAndCanceledRouteInstances in interface DocumentRoutingService
  - doCleanupDoneAndCanceledRouteInstances
```
public int doCleanupDoneAndCanceledRouteInstances(String reprositoryName,
                                                  int limit)
```
    Description copied from interface: DocumentRoutingService
    
    Query for the routes 'done' or 'canceled' and delete them. The max no of the routes that will be deleted is specified by the 'limit' parameter. When the limit is '0' all the completed routes are deleted. The routes to be deleted are ordered ascending by their creation date.
    
    Specified by:
    
    doCleanupDoneAndCanceledRouteInstances in interface DocumentRoutingService
    
    Returns:
    
    the number of cleaned up workflow instance
  - invalidateRouteModelsCache
```
public void invalidateRouteModelsCache()
```
    Specified by:
    
    invalidateRouteModelsCache in interface DocumentRoutingService
  - getTasks
```
public List<Task> getTasks(DocumentModel document,
                           String actorId,
                           String workflowInstanceId,
                           String worflowModelName,
                           CoreSession session)
```
    Specified by:
    
    getTasks in interface DocumentRoutingService
    
    Returns:
    
    Since:
    
    7.2
  - getDocumentRelatedWorkflows
```
public List<DocumentRoute> getDocumentRelatedWorkflows(DocumentModel document,
                                                       CoreSession session)
```
    Specified by:
    
    getDocumentRelatedWorkflows in interface DocumentRoutingService
    
    Returns:
    
    Since:
    
    7.2
  - getRunningWorkflowInstancesLaunchedByCurrentUser
```
public List<DocumentRoute> getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session)
```
    Specified by:
    
    getRunningWorkflowInstancesLaunchedByCurrentUser in interface DocumentRoutingService
    
    Since:
    
    7.2
  - getRunningWorkflowInstancesLaunchedByCurrentUser
```
public List<DocumentRoute> getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session,
                                                                            String worflowModelName)
```
    Specified by:
    
    getRunningWorkflowInstancesLaunchedByCurrentUser in interface DocumentRoutingService
    
    Since:
    
    7.2
  - isWorkflowModel
```
public boolean isWorkflowModel(DocumentRoute documentRoute)
```
    Returns true id the document route is a model, false if it is just an instance i.e. a running workflow.
    
    Specified by:
    
    isWorkflowModel in interface DocumentRoutingService
    
    Since:
    
    7.2

Class DocumentRoutingServiceImpl

Field Summary

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

Constructor Summary

Method Summary

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

Methods inherited from class java.lang.Object

Field Detail

CHAINS_TO_TYPE_XP

PERSISTER_XP

ACTOR_ACE_CREATOR

ROUTE_MODELS_IMPORTER_XP

typeToChain

undoChainIdFromRunning

undoChainIdFromDone

persister

routeResourcesRegistry

repositoryInitializationHandler

Constructor Detail

DocumentRoutingServiceImpl

Method Detail

registerContribution

unregisterContribution

fireEvent

createNewInstance

createNewInstance

createNewInstance

createNewInstance

createNewInstance

createNewInstance

startInstance

fireEventAfterWorkflowStarted

resumeInstance

completeTask

completeTask

getAvailableDocumentRouteModel

getAvailableDocumentRoute

getOperationChainId

getUndoFromRunningOperationChainId

getUndoFromDoneOperationChainId

unlockDocumentRouteUnrestrictedSession

validateRouteModel

getRouteElements

processElementsInFolder

getRouteElements

getDocumentRoutesForAttachedDocument

getDocumentRoutesForAttachedDocument

canUserValidateRoute

canValidateRoute

addRouteElementToRoute

addRouteElementToRoute

removeRouteElement

getOrderedRouteElement

lockDocumentRoute

unlockDocumentRoute

isLockedByCurrentUser

updateRouteElement

saveRouteAsNewModel

isRoutable

importAllRouteModels

importRouteModel

getFileManager

activate

deactivate

getRouteModelTemplateResources

searchRouteModels

registerRouteResource

getUrlFromPath

getRouteModelWithId

getRouteModelDocIdWithId

makeRoutingTasks

endTask

getWorkflowInputDocuments

grantPermissionToTaskAssignees

grantPermissionToTaskDelegatedActors

removePermissionFromTaskAssignees

removePermissionsForTaskActors

removePermissionsForTaskActors

getRoutingACLName

getRoutingACLName