Package org.mycore.pi.purl

Class MCRPURLService

java.lang.Object

org.mycore.pi.MCRPIService<T>

org.mycore.pi.MCRPIJobService<MCRPURL>

org.mycore.pi.purl.MCRPURLService

public class MCRPURLService
extends MCRPIJobService<MCRPURL>

Nested Class Summary

Nested classes/interfaces inherited from class org.mycore.pi.MCRPIJobService

MCRPIJobService.PiJobAction

Field Summary

Fields inherited from class org.mycore.pi.MCRPIJobService

CREATION_PREDICATE, JOB_API_USER_PROPERTY, REGISTRATION_PREDICATE

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
MCRPURLService()

Method Summary

Modifier and Type	Method	Description
protected String	buildTargetURL(String objId)
protected void	delete(MCRPURL identifier, MCRBase obj, String additional)	Should handle deletion of a Object with the PI.
void	deleteJob(Map<String,String> parameters)
protected void	doWithPURLManager(Consumer<MCRPURLManager> action)
protected Optional<String>	getJobInformation(Map<String,String> contextParameters)	Result of this will be passed to MCRJobAction.name()
MCRPI	insertIdentifierToDatabase(MCRBase obj, String additional, MCRPURL identifier)
protected void	registerIdentifier(MCRBase obj, String additional, MCRPURL purl)
void	registerJob(Map<String,String> parameters)
protected void	update(MCRPURL purl, MCRBase obj, String additional)	Should handle updates of a Object with the PI.
void	updateJob(Map<String,String> parameters)

Methods inherited from class org.mycore.pi.MCRPIJobService

addDeleteJob, addRegisterJob, addUpdateJob, checkConfiguration, getAction, getRegistrationCondition, parseIdentifier, rollbackDeleteJob, rollbackRegisterJob, rollbackUpdateJob, runAsJobUser, updateRegistrationDate, updateStartRegistrationDate, validateJobUserRights

Methods inherited from class org.mycore.pi.MCRPIService

addFlagToObject, getCreationPredicate, getGenerator, getGson, getMetadataService, getNewIdentifier, getPredicateInstance, getProperties, getRegistrationPredicate, getServiceID, getTableEntry, getType, hasFlag, hasFlag, hasRegistrationStarted, init, isCreated, isRegistered, onDelete, onUpdate, provideRegisterDate, register, register, register, removeFlagFromObject, requireNotEmptyProperty, setProperties, updateFlag, 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

MCRPURLService

public MCRPURLService()

Method Details

registerJob

public void registerJob(Map<String,String> parameters)
                 throws MCRPersistentIdentifierException

Specified by:

registerJob in class MCRPIJobService<MCRPURL>

Throws:

MCRPersistentIdentifierException

buildTargetURL

protected String buildTargetURL(String objId)

getJobInformation

protected Optional<String> getJobInformation(Map<String,String> contextParameters)

Description copied from class: MCRPIJobService

Result of this will be passed to MCRJobAction.name()

Specified by:

getJobInformation in class MCRPIJobService<MCRPURL>

Parameters:

contextParameters - the parameters of the job

Returns:

Some Information what this job will do or just Optional.empty(), then a default message is generated.

updateJob

public void updateJob(Map<String,String> parameters)
               throws MCRPersistentIdentifierException

Specified by:

updateJob in class MCRPIJobService<MCRPURL>

Throws:

MCRPersistentIdentifierException

deleteJob

public void deleteJob(Map<String,String> parameters)

Specified by:

deleteJob in class MCRPIJobService<MCRPURL>

insertIdentifierToDatabase

public MCRPI insertIdentifierToDatabase(MCRBase obj,
 String additional,
 MCRPURL identifier)

Overrides:

insertIdentifierToDatabase in class MCRPIService<MCRPURL>

registerIdentifier

protected void registerIdentifier(MCRBase obj,
 String additional,
 MCRPURL purl)
                           throws MCRPersistentIdentifierException

Specified by:

registerIdentifier in class MCRPIService<MCRPURL>

Throws:

MCRPersistentIdentifierException

delete

protected void delete(MCRPURL 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<MCRPURL>

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(MCRPURL purl,
 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<MCRPURL>

Parameters:

purl - the Identifier

obj - the deleted object

Throws:

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

doWithPURLManager

protected void doWithPURLManager(Consumer<MCRPURLManager> action)