Package | Description |
---|---|
fr.gouv.vitam.processing.common.automation | |
fr.gouv.vitam.processing.common.exception |
Provides common Exception classes for the Processing module.
|
fr.gouv.vitam.processing.management.api |
Provides API classes for the Processing Management module
|
fr.gouv.vitam.processing.management.core |
Provides core implementation for the Processing Management module.
|
fr.gouv.vitam.worker.common |
Provides common classes for the Worker module.
|
fr.gouv.vitam.worker.common.utils |
Provides common utility classes for the Worker module.
|
fr.gouv.vitam.worker.core.api |
Provides API definition for the Worker Core module.
|
fr.gouv.vitam.worker.core.exception | |
fr.gouv.vitam.worker.core.handler |
Provides Handler classes for the Worker Core module
|
fr.gouv.vitam.worker.core.impl |
Provides
|
fr.gouv.vitam.worker.core.plugin |
Plugin package in worker module
|
fr.gouv.vitam.worker.core.plugin.dip |
Modifier and Type | Method and Description |
---|---|
void |
IEventsState.cancel()
Cancel as soon as possible the processWorkflow, To do that, the step pauseCancelAction is updated to be
PauseOrCancelAction.ACTION_CANCEL Unlike pause, - The finally step should be executed, -
PauseOrCancelAction.ACTION_CANCEL have no impact on the finally step - The finally step cannot be cancelled
|
void |
IEventsState.next(WorkerParameters workerParameters)
Like a resume but pause at the next step
|
void |
IEventsState.replay(WorkerParameters workerParameters)
Replay the last executed step, or if it s stated, the step passed as a parameter
|
void |
IEventsState.resume(WorkerParameters workerParameters)
Do an evaluation of the State RUNNING If the state is not permitted a StateNotAllowedException is thrown Else
call doRunning method
|
Modifier and Type | Class and Description |
---|---|
class |
ArchiveUnitContainDataObjectException
Define a Archive Unit Contain Data Object Exception to be thrown when an error occurred, not a fatal error This kind
of exception occurs when an archive unit references a Binary Data Object instead of a Data Object Group
|
class |
ArchiveUnitContainSpecialCharactersException
Define a Processing Exception to be thrown when an archive unit contains a special character
|
class |
HandlerNotFoundException
HandlerNotFoundException thrown by worker when pool handler does not contain key of action handler
|
class |
MissingFieldException
Define Missig field Exception, will be thrown when mandatory field is missing
|
class |
ProcessingBadRequestException
Define a Processing Exception to be thrown when an error occurred, not a fatal error
|
class |
ProcessingDuplicatedVersionException
Define a Processing Exception to be thrown when an error occurred, not a fatal error
|
class |
ProcessingInternalServerException
Define a Processing Exception to be thrown when a fatal error occurred
|
class |
ProcessingMalformedDataException
Define a Processing Exception to be thrown when there is a line break or spaces where should not be
|
class |
ProcessingManifestReferenceException
Define a Processing Exception to be thrown when an error with reference occurred in the manifest, not a fatal error
|
class |
ProcessingObjectGroupNotFoundException
Define a Processing Exception to be thrown when GOT not found
|
class |
ProcessingStorageWorkspaceException
ProcessingStorageWorkspaceException thrown by ProcessDataManagement when an error occurs on workspace actions
|
class |
ProcessingUnauthorizeException
Define a Processing Exception to be thrown when an unauthorize operation is required
|
class |
ProcessingUnitLinkingException
Define a Processing Exception to be thrown when an error occurred, not a fatal error
|
class |
ProcessingUnitNotFoundException
Define a Processing Exception to be thrown when an error occurred, not a fatal error
|
class |
ProcessWorkflowNotFoundException
ProcessWorkflowNotFoundException manage workflow not found Exception
|
class |
StepAlreadyExecutedException
StepAlreadyExecutedException manage steps already executed Exception
|
class |
StepsNotFoundException
StepsNotFoundException manage steps not found Exception
|
class |
WorkerAlreadyExistsException
Worker already exists exception throws by engine
|
class |
WorkerFamilyNotFoundException
Worker Family not found exception throws by engine
|
class |
WorkerNotFoundException
Worker not found exception throws by engine
|
Modifier and Type | Method and Description |
---|---|
ItemStatus |
ProcessManagement.cancel(String operationId,
Integer tenantId)
Handle a cancel action for the corresponding process workflow
|
ProcessWorkflow |
ProcessManagement.init(WorkerParameters workerParameters,
String workflowId,
LogbookTypeProcess logbookTypeProcess,
Integer tenantId,
String contextId)
Init a new process workflow
|
ItemStatus |
ProcessManagement.next(WorkerParameters workerParameters,
Integer tenantId)
Handle a next action for the corresponding process workflow
|
ItemStatus |
ProcessManagement.pause(String operationId,
Integer tenantId)
Handle a pause action for the corresponding process workflow
|
ItemStatus |
ProcessManagement.replay(WorkerParameters workerParameters,
Integer tenantId)
Handle a replay action for the corresponding process workflow
|
ItemStatus |
ProcessManagement.resume(WorkerParameters workerParameters,
Integer tenantId)
Handle a resume action for the corresponding process workflow
|
Modifier and Type | Method and Description |
---|---|
void |
StateMachine.cancel() |
ItemStatus |
ProcessManagementImpl.cancel(String operationId,
Integer tenantId) |
protected void |
StateMachine.doCompleted()
Change the state of the process to completed Can be called only from running or pause state If running state, the
next step will be completed
|
protected void |
StateMachine.doReplay(WorkerParameters workerParameters,
ProcessState targetState)
Change state of the process to running Can be called only from pause state
|
protected void |
StateMachine.doRunning(WorkerParameters workerParameters,
ProcessState targetState)
Change state of the process to running Can be called only from pause state
|
protected void |
StateMachine.executeSteps(WorkerParameters workerParameters,
PauseRecover pauseRecover,
boolean backwards)
Execute steps of the workflow and manage index of the current step Call engine to execute the current step
|
ProcessWorkflow |
ProcessManagementImpl.init(WorkerParameters workerParameters,
String workflowId,
LogbookTypeProcess logbookTypeProcess,
Integer tenantId,
String contextId) |
void |
StateMachine.next(WorkerParameters workerParameters) |
ItemStatus |
ProcessManagementImpl.next(WorkerParameters workerParameters,
Integer tenantId) |
ItemStatus |
ProcessManagementImpl.pause(String operationId,
Integer tenantId) |
void |
StateMachine.replay(WorkerParameters workerParameters) |
ItemStatus |
ProcessManagementImpl.replay(WorkerParameters workerParameters,
Integer tenantId) |
void |
StateMachine.resume(WorkerParameters workerParameters) |
ItemStatus |
ProcessManagementImpl.resume(WorkerParameters workerParameters,
Integer tenantId) |
Modifier and Type | Method and Description |
---|---|
HandlerIO |
HandlerIO.addOuputResult(int rank,
Object object,
boolean asyncIO)
Add one output result (no delete)
|
HandlerIO |
HandlerIO.addOuputResult(int rank,
Object object,
boolean deleteLocal,
boolean asyncIO)
Add one output result
|
com.fasterxml.jackson.databind.JsonNode |
HandlerIO.getJsonFromWorkspace(String jsonFilePath)
Retrieve a json file as a
JsonNode from the workspace. |
List<URI> |
HandlerIO.getUriList(String containerName,
String folderName) |
void |
HandlerIO.transferFileToWorkspace(String workspacePath,
File sourceFile,
boolean toDelete,
boolean asyncIO)
Helper to write a file to Workspace
To be used when not specified within the Output Parameters |
void |
HandlerIO.transferInputStreamToWorkspace(String workspacePath,
InputStream inputStream,
Path filePath,
boolean asyncIO)
Helper to write an InputStream to Workspace
To be used when not specified within the Output Parameters |
void |
HandlerIO.transferJsonToWorkspace(String collectionName,
String workspacePath,
com.fasterxml.jackson.databind.JsonNode jsonNode,
boolean toDelete,
boolean asyncIO)
Helper to convert and write a file to Workspace
|
Modifier and Type | Method and Description |
---|---|
Map<String,Map<String,String>> |
SedaUtils.checkSupportedDataObjectVersion(WorkerParameters params)
check if the version list of the manifest.xml in workspace is valid
|
Map<String,Map<String,String>> |
SedaUtils.compareVersionList(XMLEventReader eventReader)
compare if the version list of manifest.xml is included in or equal to the version list of version.conf
|
long |
SedaUtils.computeTotalSizeOfObjectsInManifest(WorkerParameters params)
Compute the total size of objects listed in the manifest.xml file
|
ExtractUriResponse |
SedaUtils.getAllDigitalObjectUriFromManifest() |
SedaUtilInfo |
SedaUtils.getDataObjectInfo(XMLEventReader evenReader) |
Map<String,Object> |
SedaUtils.getMandatoryValues(WorkerParameters params)
get Message Identifier from seda
|
long |
SedaUtils.getManifestSize(WorkerParameters params)
Get the size of the manifest file
|
Map<String,List<DataObjectInfo>> |
SedaUtils.manifestVersionList(XMLEventReader evenReader) |
static void |
LogbookLifecycleWorkerHelper.setLifeCycleFinalEventStatusByStep(LogbookLifeCyclesClientHelper helper,
LogbookLifeCycleParameters logbookLifecycleParameters,
ItemStatus itemStatus) |
boolean |
ArchiveUnitUpdateUtils.updateCategoryRules(com.fasterxml.jackson.databind.node.ArrayNode rulesForCategory,
List<com.fasterxml.jackson.databind.JsonNode> listRulesByType,
UpdateMultiQuery query,
String key)
Method used to get update query for an archive unit
|
static void |
LogbookLifecycleWorkerHelper.updateLifeCycleForBegining(LogbookLifeCyclesClientHelper helper,
LogbookLifeCycleParameters logbookLifecycleParameters,
WorkerParameters params,
LogbookTypeProcess logbookTypeProcess) |
static void |
LogbookLifecycleWorkerHelper.updateLifeCycleStep(LogbookLifeCyclesClientHelper helper,
LogbookLifeCycleParameters logbookLifecycleParameters,
WorkerParameters params,
String lfcEventType,
LogbookTypeProcess logbookTypeProcess,
StatusCode statusCode,
String... additionalParams) |
Modifier and Type | Method and Description |
---|---|
void |
WorkerAction.checkMandatoryIOParameter(HandlerIO handler)
Check mandatory parameter
|
ItemStatus |
WorkerAction.execute(WorkerParameters param,
HandlerIO handler)
Execute an action
|
ItemStatus |
Worker.run(WorkerParameters workParams,
Step step)
Worker execute the step's actions
|
Modifier and Type | Class and Description |
---|---|
class |
InvalidRuleException
Invalid Rule Exception when compute rules
|
Modifier and Type | Method and Description |
---|---|
void |
RollBackActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
FinalizeLifecycleTraceabilityActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CommitLifeCycleActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
GenerateAuditReportActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
ExtractSedaActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
ListLifecycleTraceabilityActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckStorageAvailabilityActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
AccessionRegisterActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
VerifyTimeStampActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckIngestContractActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckSedaActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
ListArchiveUnitsActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckHeaderActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckNoObjectsActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckVersionActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
ListRunningIngestsActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
DummyHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
TransferNotificationActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckArchiveProfileRelationActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
VerifyMerkleTreeActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckArchiveProfileActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckOriginatingAgencyHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
PrepareAuditActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
PrepareStorageInfoActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckObjectsNumberActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckObjectUnitConsistencyActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckDataObjectPackageActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
void |
PrepareTraceabilityCheckProcessActionHandler.checkMandatoryIOParameter(HandlerIO handler) |
abstract void |
CommitLifeCycleActionHandler.commitLifeCycle(HandlerIO handlerIO,
String objectID,
String operationId)
Runs a commit process for the given object (Unit or ObjectGroup) and a given operation
|
void |
CommitLifeCycleUnitActionHandler.commitLifeCycle(HandlerIO handlerIO,
String objectID,
String operationId) |
ItemStatus |
GenerateAuditReportActionHandler.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
VerifyTimeStampActionHandler.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
DummyHandler.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
PrepareAuditActionHandler.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
CheckObjectUnitConsistencyActionHandler.execute(WorkerParameters params,
HandlerIO handler) |
ItemStatus |
PrepareTraceabilityCheckProcessActionHandler.execute(WorkerParameters param,
HandlerIO handler) |
com.fasterxml.jackson.databind.node.ObjectNode |
ExtractSedaActionHandler.extractSEDA(LogbookLifeCyclesClient logbookLifeCycleClient,
WorkerParameters params,
ItemStatus globalCompositeItemStatus,
UnitType workflowUnitType)
Split Element from InputStream and write it to workspace
|
static void |
HandlerUtils.saveMap(HandlerIO handlerIO,
Map<String,?> map,
int rank,
boolean removeTmpFile,
boolean asyncIO)
Save the given map as specified by the rank output argument
|
Modifier and Type | Method and Description |
---|---|
HandlerIO |
HandlerIOImpl.addOuputResult(int rank,
Object object,
boolean asyncIO) |
HandlerIO |
HandlerIOImpl.addOuputResult(int rank,
Object object,
boolean deleteLocal,
boolean asyncIO) |
com.fasterxml.jackson.databind.JsonNode |
HandlerIOImpl.getJsonFromWorkspace(String jsonFilePath) |
List<URI> |
HandlerIOImpl.getUriList(String containerName,
String folderName) |
ItemStatus |
WorkerImpl.run(WorkerParameters workParams,
Step step) |
void |
HandlerIOImpl.transferFileToWorkspace(String workspacePath,
File sourceFile,
boolean toDelete,
boolean asyncIO) |
void |
HandlerIOImpl.transferInputStreamToWorkspace(String workspacePath,
InputStream inputStream,
Path filePath,
boolean asyncIO) |
void |
HandlerIOImpl.transferJsonToWorkspace(String collectionName,
String objectName,
com.fasterxml.jackson.databind.JsonNode jsonNode,
boolean toDelete,
boolean asyncIO) |
Modifier and Type | Method and Description |
---|---|
void |
UpdateObjectGroupPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
StoreMetaDataObjectGroupActionPlugin.checkMandatoryIOParameter(HandlerIO handlerIO) |
void |
CheckClassificationLevelActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
RunningIngestsUpdateActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckIntegrityObjectPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CreateObjectSecureFileActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CreateUnitSecureFileActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
StoreMetaDataUnitActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
StoreObjectGroupActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
UnitsRulesComputePlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckConformityActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
AuditCheckObjectPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckExistenceObjectPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
IndexUnitActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
IndexObjectGroupActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
CheckArchiveUnitSchemaActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
FormatIdentificationActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
void |
ArchiveUnitRulesUpdateActionPlugin.checkMandatoryIOParameter(HandlerIO handler) |
ItemStatus |
UpdateObjectGroupPlugin.execute(WorkerParameters params,
HandlerIO handlerIO) |
ItemStatus |
StoreMetaDataObjectGroupActionPlugin.execute(WorkerParameters params,
HandlerIO actionDefinition) |
ItemStatus |
CheckIntegrityObjectPlugin.execute(WorkerParameters params,
HandlerIO handler) |
ItemStatus |
StoreMetaDataUnitActionPlugin.execute(WorkerParameters params,
HandlerIO actionDefinition) |
ItemStatus |
CheckConformityActionPlugin.execute(WorkerParameters params,
HandlerIO handler) |
ItemStatus |
AuditCheckObjectPlugin.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
CheckExistenceObjectPlugin.execute(WorkerParameters params,
HandlerIO handler) |
protected void |
CreateSecureFileActionPlugin.storeLifecycle(com.fasterxml.jackson.databind.JsonNode lifecycle,
String lfGuid,
HandlerIO handlerIO,
String lifecycleType) |
Modifier and Type | Method and Description |
---|---|
void |
CreateManifest.checkMandatoryIOParameter(HandlerIO handler) |
void |
PutBinaryOnWorkspace.checkMandatoryIOParameter(HandlerIO handler) |
void |
StoreDIP.checkMandatoryIOParameter(HandlerIO handler) |
ItemStatus |
CreateManifest.execute(WorkerParameters param,
HandlerIO handlerIO) |
ItemStatus |
PutBinaryOnWorkspace.execute(WorkerParameters param,
HandlerIO handler) |
ItemStatus |
StoreDIP.execute(WorkerParameters params,
HandlerIO handler) |
Map<String,String> |
ManifestBuilder.writeGOT(com.fasterxml.jackson.databind.JsonNode og)
write a GOT
|
Copyright © 2018 Vitam. All rights reserved.