fr.gouv.vitam.worker.common.utils

Class SedaUtils

java.lang.Object

fr.gouv.vitam.worker.common.utils.SedaUtils

public class SedaUtils
extends Object

SedaUtils to read or split element from SEDA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SedaUtils.CheckSedaValidationStatus Check Seda Validation status values

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_DATAOBJECT_VERSION
static String	NAMESPACE_URI
static String	NB_AU_EXISTING nbAUExisting: number of the AU already existing
static String	VALID_DATAOBJECT_VERSION
static String	XSI_URI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SedaUtils(HandlerIO handlerIO)

Method Summary

Modifier and Type	Method and Description
SedaUtils.CheckSedaValidationStatus	checkSedaValidation(WorkerParameters params, ItemStatus itemStatus) The method is used to validate SEDA by XSD
Map<String,Map<String,String>>	checkSupportedDataObjectVersion(WorkerParameters params) check if the version list of the manifest.xml in workspace is valid
Map<String,Map<String,String>>	compareVersionList(XMLEventReader eventReader) compare if the version list of manifest.xml is included in or equal to the version list of version.conf
long	computeTotalSizeOfObjectsInManifest(WorkerParameters params) Compute the total size of objects listed in the manifest.xml file
ExtractUriResponse	getAllDigitalObjectUriFromManifest()
Map<String,String>	getBinaryDataObjectIdToGroupId()
Map<String,String>	getBinaryDataObjectIdToGuid()
SedaUtilInfo	getDataObjectInfo(XMLEventReader evenReader)
Map<String,Object>	getMandatoryValues(WorkerParameters params) get Message Identifier from seda
long	getManifestSize(WorkerParameters params) Get the size of the manifest file
Map<String,List<String>>	getObjectGroupIdToBinaryDataObjectId()
Map<String,String>	getObjectGroupIdToGuid()
Map<String,String>	getUnitIdToGroupId()
Map<String,String>	getUnitIdToGuid()
Map<String,List<DataObjectInfo>>	manifestVersionList(XMLEventReader evenReader)

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_URI

public static final String NAMESPACE_URI

See Also:

Constant Field Values

XSI_URI

public static final String XSI_URI

See Also:

Constant Field Values

NB_AU_EXISTING

public static final String NB_AU_EXISTING

nbAUExisting: number of the AU already existing

See Also:

Constant Field Values

INVALID_DATAOBJECT_VERSION

public static final String INVALID_DATAOBJECT_VERSION

See Also:

Constant Field Values

VALID_DATAOBJECT_VERSION

public static final String VALID_DATAOBJECT_VERSION

See Also:

Constant Field Values

Constructor Detail

SedaUtils

protected SedaUtils(HandlerIO handlerIO)

Method Detail

getBinaryDataObjectIdToGuid

public Map<String,String> getBinaryDataObjectIdToGuid()

Returns:

A map reflects BinaryDataObject and File(GUID)

getObjectGroupIdToBinaryDataObjectId

public Map<String,List<String>> getObjectGroupIdToBinaryDataObjectId()

Returns:

A map reflects relation ObjectGroupId and BinaryDataObjectId

getObjectGroupIdToGuid

public Map<String,String> getObjectGroupIdToGuid()

Returns:

A map reflects ObjectGroup and File(GUID)

getUnitIdToGuid

public Map<String,String> getUnitIdToGuid()

Returns:

A map reflects Unit and File(GUID)

getBinaryDataObjectIdToGroupId

public Map<String,String> getBinaryDataObjectIdToGroupId()

Returns:

A map reflects BinaryDataObject and ObjectGroup

getUnitIdToGroupId

public Map<String,String> getUnitIdToGroupId()

Returns:

A map reflects Unit and ObjectGroup

getMandatoryValues

public Map<String,Object> getMandatoryValues(WorkerParameters params)
                                      throws ProcessingException

get Message Identifier from seda

Parameters:

params - parameters of workspace server

Returns:

message id

Throws:

ProcessingException - throw when can't read or extract message id from SEDA

checkSedaValidation

public SedaUtils.CheckSedaValidationStatus checkSedaValidation(WorkerParameters params,
                                                               ItemStatus itemStatus)

The method is used to validate SEDA by XSD

Parameters:

params - worker parameter

Returns:

a status representing the validation of the file

getAllDigitalObjectUriFromManifest

public ExtractUriResponse getAllDigitalObjectUriFromManifest()
                                                      throws ProcessingException

Returns:

ExtractUriResponse - Object ExtractUriResponse contains listURI, listMessages and value boolean(error).

Throws:

ProcessingException - - throw when error in execution.

checkSupportedDataObjectVersion

public Map<String,Map<String,String>> checkSupportedDataObjectVersion(WorkerParameters params)
                                                               throws ProcessingException

check if the version list of the manifest.xml in workspace is valid

Parameters:

params - worker parameter

Returns:

map containing unsupported version

Throws:

ProcessingException - throws when error occurs

getDataObjectInfo

public SedaUtilInfo getDataObjectInfo(XMLEventReader evenReader)
                               throws ProcessingException

Parameters:

evenReader - of seda

Returns:

Seda Info object

Throws:

ProcessingException - if cannot get BinaryObject info

manifestVersionList

public Map<String,List<DataObjectInfo>> manifestVersionList(XMLEventReader evenReader)
                                                     throws ProcessingException

Parameters:

evenReader - XMLEventReader for the file manifest.xml

Returns:

List of version for file manifest.xml

Throws:

ProcessingException - when error in execution

compareVersionList

public Map<String,Map<String,String>> compareVersionList(XMLEventReader eventReader)
                                                  throws ProcessingException

compare if the version list of manifest.xml is included in or equal to the version list of version.conf

Parameters:

eventReader - xml event reader

Returns:

map containing the error code and the unsupported version

Throws:

ProcessingException - when error in execution

computeTotalSizeOfObjectsInManifest

public long computeTotalSizeOfObjectsInManifest(WorkerParameters params)
                                         throws ProcessingException

Compute the total size of objects listed in the manifest.xml file

Parameters:

params - worker parameters

Returns:

the computed size of all BinaryObjects

Throws:

ProcessingException - when error in getting binary object info

getManifestSize

public long getManifestSize(WorkerParameters params)
                     throws ProcessingException

Get the size of the manifest file

Parameters:

params - worker parameters

Returns:

the size of the manifest

Throws:

ProcessingException - if json seda data is null or seda does not contain size attribute