Interface ProcessDataManagement
- All Known Implementing Classes:
WorkspaceProcessDataManagement
public interface ProcessDataManagement
Interface for process datas management service
(persist and restore workflow)
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbooleancreateFolder(String folderName) Create a folder with the name {folderName} if does not exist on the process containerbooleanCreate the process container (initialisation) if does not existgetDistributorIndex(String fileName) getProcessWorkflow(String folderName, String asyncId) Retrieve a workflow instance on process containergetProcessWorkflowFor(Integer tenantId, String folderName) Get process workflow map for tenantId and folderName (server id from serverIdentity)booleanisFolderExist(String folderName) Check if the folder with name {folderName} exists on process containerbooleanCheck if the process container existsvoidpersistDistributorIndex(String fileName, DistributorIndex distributorIndex) voidpersistProcessWorkflow(String folderName, ProcessWorkflow processWorkflow) Put process workflow instance in workspacebooleanremoveFolder(String folderName) Delete folder with name {folderName} if exists on process containerbooleanremoveOperationContainer(ProcessWorkflow processWorkflow, WorkspaceClientFactory workspaceClientFactory) voidremoveProcessWorkflow(String folderName, String asyncId) Delete process workflow from the workspace
-
Field Details
-
PROCESS_CONTAINER
Container name- See Also:
-
DISTRIBUTOR_INDEX
- See Also:
-
-
Method Details
-
createProcessContainer
Create the process container (initialisation) if does not exist- Returns:
- true if the container was created, false if it already exists
- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
isProcessContainerExist
Check if the process container exists- Returns:
- true if the container exists, false otherwise
- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
createFolder
Create a folder with the name {folderName} if does not exist on the process container- Parameters:
folderName- the name of the folder to create- Returns:
- true if the folder was created, false if it already exists
- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
isFolderExist
Check if the folder with name {folderName} exists on process container- Parameters:
folderName- the folder name to check- Returns:
- true if folder exists on process container, false otherwise
- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
removeFolder
Delete folder with name {folderName} if exists on process container- Parameters:
folderName- the folderName to delete- Returns:
- true if the folder was removed, false if it does not exist
- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
persistProcessWorkflow
void persistProcessWorkflow(String folderName, ProcessWorkflow processWorkflow) throws ProcessingStorageWorkspaceException, InvalidParseOperationException Put process workflow instance in workspace- Parameters:
folderName- the folder to put workflow instance on process containerprocessWorkflow- the instance to save- Throws:
ProcessingStorageWorkspaceException- when storage error occursInvalidParseOperationException- when serializing object to json fail
-
persistDistributorIndex
void persistDistributorIndex(String fileName, DistributorIndex distributorIndex) throws ProcessingStorageWorkspaceException, InvalidParseOperationException -
getDistributorIndex
Optional<DistributorIndex> getDistributorIndex(String fileName) throws ProcessingStorageWorkspaceException, InvalidParseOperationException -
getProcessWorkflow
ProcessWorkflow getProcessWorkflow(String folderName, String asyncId) throws ProcessingStorageWorkspaceException, InvalidParseOperationException Retrieve a workflow instance on process container- Parameters:
folderName- the folder on process container to get workflow instanceasyncId- the request id (asynchronous id)- Returns:
- the workflow instance
- Throws:
ProcessingStorageWorkspaceException- when storage error occursInvalidParseOperationException- when deserializing object to json fail
-
removeProcessWorkflow
void removeProcessWorkflow(String folderName, String asyncId) throws ProcessingStorageWorkspaceException Delete process workflow from the workspace- Parameters:
folderName- the folder on process container to remove workflow instanceasyncId- the request id (asynchronous id)- Throws:
ProcessingStorageWorkspaceException- when storage error occurs
-
getProcessWorkflowFor
Map<String,ProcessWorkflow> getProcessWorkflowFor(Integer tenantId, String folderName) throws ProcessingStorageWorkspaceException Get process workflow map for tenantId and folderName (server id from serverIdentity)- Parameters:
tenantId- the tenant IDfolderName- the folder name (server id from serverIdentity)- Returns:
- map of tenantID process for a server id
- Throws:
ProcessingStorageWorkspaceException- thrown if an error ocurred when loading process file
-
removeOperationContainer
boolean removeOperationContainer(ProcessWorkflow processWorkflow, WorkspaceClientFactory workspaceClientFactory)
-