Package org.mycore.pi.urn.rest

Class MCRURNGranularRESTService

java.lang.Object

org.mycore.pi.MCRPIService<MCRDNBURN>

org.mycore.pi.urn.rest.MCRURNGranularRESTService

public class MCRURNGranularRESTService
extends MCRPIService<MCRDNBURN>

Service for assigning granular URNs to Derivate. You can call it with a Derivate-ID and it will assign a Base-URN for the Derivate and granular URNs for every file in the Derivate (except IgnoreFileNames). If you then add a file to Derivate you can call with Derivate-ID and additional path of the file. E.g. mir_derivate_00000060 and /image1.jpg

Inscriber is ignored with this MCRPIService

Configuration Parameter(s):

IgnoreFileNames

Comma seperated list of regex file which should not have a urn assigned. Default: mets\\.xml

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MCRURNGranularRESTService.MCRPICreationException

Field Summary

Fields inherited from class org.mycore.pi.MCRPIService

GENERATOR_CONFIG_PREFIX, GENERATOR_PROPERTY_KEY, METADATA_SERVICE_CONFIG_PREFIX, METADATA_SERVICE_PROPERTY_KEY, PI_FLAG, REGISTRATION_CONFIG_PREFIX, TRANSLATE_PREFIX

Constructor Summary

Constructors

Constructor	Description
MCRURNGranularRESTService()
MCRURNGranularRESTService(Function<MCRDerivate,Stream<MCRPath>> derivateFileStreamFunc)

Method Summary

Modifier and Type	Method	Description
MCRDNBURN	createNewURN(MCRDerivate deriv)
protected void	delete(MCRDNBURN identifier, MCRBase obj, String additional)	Should handle deletion of a Object with the PI.
MCRDNBURN	register(MCRBase obj, String filePath, boolean updateObject)	Validates everything, registers a new Identifier, inserts the identifier to object metadata and writes a information to the Database.
protected void	registerIdentifier(MCRBase obj, String additional, MCRDNBURN urn)
protected void	update(MCRDNBURN identifier, MCRBase obj, String additional)	Should handle updates of a Object with the PI.
void	updateFlag(MCRObjectID id, String additional, MCRPI mcrpi)

Methods inherited from class org.mycore.pi.MCRPIService

addFlagToObject, checkConfiguration, getCreationPredicate, getGenerator, getGson, getMetadataService, getNewIdentifier, getPredicateInstance, getProperties, getRegistrationPredicate, getServiceID, getTableEntry, getType, hasFlag, hasFlag, hasRegistrationStarted, init, insertIdentifierToDatabase, isCreated, isRegistered, onDelete, onUpdate, provideRegisterDate, register, register, removeFlagFromObject, requireNotEmptyProperty, setProperties, updateFlagsInDatabase, validateAlreadyCreated, validatePermission, validateRegistration, validateRegistration

Methods inherited from class java.lang.Object

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

Constructor Details

MCRURNGranularRESTService

public MCRURNGranularRESTService()

MCRURNGranularRESTService

public MCRURNGranularRESTService(Function<MCRDerivate,Stream<MCRPath>> derivateFileStreamFunc)

Method Details

register

public MCRDNBURN register(MCRBase obj,
 String filePath,
 boolean updateObject)
                   throws MCRAccessException,
MCRActiveLinkException,
MCRPersistentIdentifierException

Description copied from class: MCRPIService

Validates everything, registers a new Identifier, inserts the identifier to object metadata and writes a information to the Database.

Overrides:

register in class MCRPIService<MCRDNBURN>

Parameters:

obj - the object which has to be identified

filePath - additional information for the persistent identifier

updateObject - if true this method calls MCRMetadataManager.update(MCRBase)

Returns:

the assigned Identifier

Throws:

MCRAccessException - the current User doesn't have the rights to insert the Identifier to Metadata

MCRActiveLinkException - the MCRPIMetadataService lets MCRMetadataManager.update(MCRObject) throw this

MCRPersistentIdentifierException - see org.mycore.pi.exceptions

createNewURN

public MCRDNBURN createNewURN(MCRDerivate deriv)

registerIdentifier

protected void registerIdentifier(MCRBase obj,
 String additional,
 MCRDNBURN urn)
                           throws MCRPersistentIdentifierException

Specified by:

registerIdentifier in class MCRPIService<MCRDNBURN>

Throws:

MCRPersistentIdentifierException

delete

protected void delete(MCRDNBURN identifier,
 MCRBase obj,
 String additional)
               throws MCRPersistentIdentifierException

Description copied from class: MCRPIService

Should handle deletion of a Object with the PI. E.g. The MCRDOIService sets the active flag in Datacite datacentre to false.

Specified by:

delete in class MCRPIService<MCRDNBURN>

Parameters:

identifier - the Identifier

obj - the deleted object

Throws:

MCRPersistentIdentifierException - to abort deletion of the object or if something went wrong, (e.g. MCRDOIService throws if not a superuser tries to delete the object)

update

protected void update(MCRDNBURN identifier,
 MCRBase obj,
 String additional)
               throws MCRPersistentIdentifierException

Description copied from class: MCRPIService

Should handle updates of a Object with the PI. E.g. The MCRDOIService sends the updated metadata to the Datacite datacentre.

Specified by:

update in class MCRPIService<MCRDNBURN>

Parameters:

identifier - the Identifier

obj - the deleted object

Throws:

MCRPersistentIdentifierException - to abort update of the object or if something went wrong.

updateFlag

public void updateFlag(MCRObjectID id,
 String additional,
 MCRPI mcrpi)

Overrides:

updateFlag in class MCRPIService<MCRDNBURN>