Package org.mycore.pi.doi

Class MCRDOIBaseService

java.lang.Object

org.mycore.pi.MCRPIService<T>

org.mycore.pi.MCRPIJobService<MCRDigitalObjectIdentifier>

org.mycore.pi.doi.MCRDOIBaseService

Direct Known Subclasses:

MCRCrossrefService, MCRDOIService

public abstract class MCRDOIBaseService
extends MCRPIJobService<MCRDigitalObjectIdentifier>

A doi Base Service which contains common DOI registration code.

Nested Class Summary

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

MCRPIJobService.PiJobAction

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONTEXT_DOI
protected static final String	CONTEXT_OBJ

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

Method Summary

Modifier and Type	Method	Description
protected boolean	checkJobValid(String mycoreID, MCRPIJobService.PiJobAction action)
protected abstract String	getDefaultSchemaPath()
protected Optional<String>	getJobInformation(Map<String,String> contextParameters)	Result of this will be passed to MCRJobAction.name()
String	getPassword()
Schema	getSchema()
protected MCRContentTransformer	getTransformer()
String	getTransformerID()
String	getUsername()
protected void	initCommonProperties()
MCRPI	insertIdentifierToDatabase(MCRBase obj, String additional, MCRDigitalObjectIdentifier identifier)
protected Date	provideRegisterDate(MCRBase obj, String additional)
static Schema	resolveSchema(String schemaURLString)
void	setPassword(String password)
void	setSchema(Schema schema)
void	setTransformerID(String transformerID)
void	setUsername(String username)
protected void	startRegisterJob(MCRBase obj, MCRDigitalObjectIdentifier newDOI)
protected abstract Document	transform(MCRBase obj, String pi)
void	update(MCRDigitalObjectIdentifier doi, MCRBase obj, String additional)	Should handle updates of a Object with the PI.
protected void	validateDocument(String id, Document resultDocument)

Methods inherited from class org.mycore.pi.MCRPIJobService

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

Methods inherited from class org.mycore.pi.MCRPIService

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

Field Details

CONTEXT_OBJ

protected static final String CONTEXT_OBJ

See Also:

• Constant Field Values

CONTEXT_DOI

protected static final String CONTEXT_DOI

See Also:

• Constant Field Values

Constructor Details

MCRDOIBaseService

public MCRDOIBaseService()

Method Details

initCommonProperties

protected void initCommonProperties()

resolveSchema

public static Schema resolveSchema(String schemaURLString)

getDefaultSchemaPath

protected abstract String getDefaultSchemaPath()

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<MCRDigitalObjectIdentifier>

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.

checkJobValid

protected boolean checkJobValid(String mycoreID,
 MCRPIJobService.PiJobAction action)

update

public void update(MCRDigitalObjectIdentifier doi,
 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<MCRDigitalObjectIdentifier>

Parameters:

doi - the Identifier

obj - the deleted object

Throws:

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

insertIdentifierToDatabase

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

Overrides:

insertIdentifierToDatabase in class MCRPIService<MCRDigitalObjectIdentifier>

startRegisterJob

protected void startRegisterJob(MCRBase obj,
 MCRDigitalObjectIdentifier newDOI)

getTransformer

protected MCRContentTransformer getTransformer()

validateDocument

protected void validateDocument(String id,
 Document resultDocument)
                         throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

provideRegisterDate

protected Date provideRegisterDate(MCRBase obj,
 String additional)

Overrides:

provideRegisterDate in class MCRPIService<MCRDigitalObjectIdentifier>

transform

protected abstract Document transform(MCRBase obj,
 String pi)
                               throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getSchema

public Schema getSchema()

setSchema

public void setSchema(Schema schema)

getTransformerID

public String getTransformerID()

setTransformerID

public void setTransformerID(String transformerID)