Package org.mycore.pi

Class MCRPIJobService<T extends MCRPersistentIdentifier>

java.lang.Object

org.mycore.pi.MCRPIService<T>

org.mycore.pi.MCRPIJobService<T>

Type Parameters:

T -

Direct Known Subclasses:

MCRDOIBaseService, MCREpicService, MCRPURLService

public abstract class MCRPIJobService<T extends MCRPersistentIdentifier>
extends MCRPIService<T>

Implementation of a MCRPIService which helps to outsource a registration task to a MCRJob e.G. send a POST request to a REST api

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MCRPIJobService.PiJobAction

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CREATION_PREDICATE
static final String	JOB_API_USER_PROPERTY
protected static final String	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
MCRPIJobService(String identType)

Method Summary

Modifier and Type	Method	Description
protected void	addDeleteJob(Map<String,String> contextParameters)
protected void	addRegisterJob(Map<String,String> contextParameters)	Adds a register job which will be called in the persistent MCRJob environment in a extra thread.
protected void	addUpdateJob(Map<String,String> contextParameters)
protected void	checkConfiguration()	Checks the service parameters.
protected abstract void	deleteJob(Map<String,String> parameters)
protected MCRPIJobService.PiJobAction	getAction(Map<String,String> contextParameters)
protected abstract Optional<String>	getJobInformation(Map<String,String> contextParameters)	Result of this will be passed to MCRJobAction.name()
protected Predicate<MCRBase>	getRegistrationCondition()	Deprecated.
protected Optional<T>	parseIdentifier(String identifier)	Tries to parse a identifier with a specific type.
protected abstract void	registerJob(Map<String,String> parameters)
protected void	rollbackDeleteJob(Map<String,String> parameters)	Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.
protected void	rollbackRegisterJob(Map<String,String> parameters)	Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.
protected void	rollbackUpdateJob(Map<String,String> parameters)	Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.
void	runAsJobUser(org.mycore.pi.MCRPIJobService.PIRunnable task)
protected abstract void	updateJob(Map<String,String> parameters)
protected void	updateRegistrationDate(MCRObjectID mycoreID, String additional, Date date)	Can be used to update the registration date in the database.
protected void	updateStartRegistrationDate(MCRObjectID mycoreID, String additional, Date date)	Can be used to update the startRegistration date in the database.
protected void	validateJobUserRights(MCRObjectID id)	If you use updateRegistrationDate(MCRObjectID, String, Date) or updateStartRegistrationDate(MCRObjectID, String, Date) then you should validate if the user has the rights for this.

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, insertIdentifierToDatabase, isCreated, isRegistered, onDelete, onUpdate, provideRegisterDate, register, register, register, registerIdentifier, removeFlagFromObject, requireNotEmptyProperty, setProperties, update, 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

JOB_API_USER_PROPERTY

public static final String JOB_API_USER_PROPERTY

See Also:

• Constant Field Values

REGISTRATION_PREDICATE

protected static final String REGISTRATION_PREDICATE

See Also:

• Constant Field Values

CREATION_PREDICATE

protected static final String CREATION_PREDICATE

See Also:

• Constant Field Values

Constructor Details

MCRPIJobService

public MCRPIJobService(String identType)

Method Details

deleteJob

protected abstract void deleteJob(Map<String,String> parameters)
                           throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

updateJob

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

Throws:

MCRPersistentIdentifierException

registerJob

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

Throws:

MCRPersistentIdentifierException

rollbackDeleteJob

protected void rollbackDeleteJob(Map<String,String> parameters)
                          throws MCRPersistentIdentifierException

Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.

Parameters:

parameters - the parameters which was passed to addDeleteJob(Map)

Throws:

MCRPersistentIdentifierException - throw MCRPersistentIdentifierException if something goes wrong during rollback

rollbackUpdateJob

protected void rollbackUpdateJob(Map<String,String> parameters)
                          throws MCRPersistentIdentifierException

Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.

Parameters:

parameters - the parameters which was passed to updateJob(Map)

Throws:

MCRPersistentIdentifierException - throw MCRPersistentIdentifierException if something goes wrong during rollback

rollbackRegisterJob

protected void rollbackRegisterJob(Map<String,String> parameters)
                            throws MCRPersistentIdentifierException

Hook in to rollback mechanism of MCRJobAction.rollback() by overwriting this method.

Parameters:

parameters - the parameters which was passed to addRegisterJob(Map)

Throws:

MCRPersistentIdentifierException - throw MCRPersistentIdentifierException if something goes wrong during rollback

addDeleteJob

protected void addDeleteJob(Map<String,String> contextParameters)

See Also:

• addRegisterJob(Map)

addUpdateJob

protected void addUpdateJob(Map<String,String> contextParameters)

See Also:

• addRegisterJob(Map)

addRegisterJob

protected void addRegisterJob(Map<String,String> contextParameters)

Adds a register job which will be called in the persistent MCRJob environment in a extra thread.

Parameters:

contextParameters - pass parameters which are needed to register the PI. The parameter action and registrationServiceID will be added, because they are necessary to reassign the job to the right MCRPIJobService and method.

validateJobUserRights

protected void validateJobUserRights(MCRObjectID id)
                              throws MCRPersistentIdentifierException

If you use updateRegistrationDate(MCRObjectID, String, Date) or updateStartRegistrationDate(MCRObjectID, String, Date) then you should validate if the user has the rights for this. This methods validates this and throws a handsome exception.

Parameters:

id - of the object

Throws:

MCRPersistentIdentifierException

updateRegistrationDate

protected void updateRegistrationDate(MCRObjectID mycoreID,
 String additional,
 Date date)

Can be used to update the registration date in the database. The most MCRPIJobService only add the pi to the object and then to the database, with registration date of null. Later the job will register the pi and then change the registration date to the right value. If you use this methods from a job you should have called validateJobUserRights(org.mycore.datamodel.metadata.MCRObjectID) before!

Parameters:

mycoreID - the id of the MCRBase which has the pi assigned

additional - information like path to a file

date - the new registration date

updateStartRegistrationDate

protected void updateStartRegistrationDate(MCRObjectID mycoreID,
 String additional,
 Date date)

Can be used to update the startRegistration date in the database. The most MCRPIJobService only add the pi to the object and then to the database, with registration or startRegistration date of null. After a job is created the Registration service should update the date. If you use this methods from a job you should have called validateJobUserRights(org.mycore.datamodel.metadata.MCRObjectID) before!

Parameters:

mycoreID - the id of the MCRBase which has the pi assigned

additional - information like path to a file

date - the new registration date

parseIdentifier

protected Optional<T> parseIdentifier(String identifier)

Tries to parse a identifier with a specific type.

Parameters:

identifier - the identifier to parse

Returns:

parsed identifier or Optional.empty() if there is no parser for the type or the parser can't parse the identifier

Throws:

ClassCastException - when type does not match the type of T

getJobInformation

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

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

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.

runAsJobUser

public void runAsJobUser(org.mycore.pi.MCRPIJobService.PIRunnable task)
                  throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

getAction

protected MCRPIJobService.PiJobAction getAction(Map<String,String> contextParameters)

getRegistrationCondition

@Deprecated
protected Predicate<MCRBase> getRegistrationCondition()

Deprecated.

This function is replaced by getRegistrationPredicate() in parent class MCRPIJobService

Returns:

the registration predicate

See Also:

• MCRPIJobService

checkConfiguration

protected void checkConfiguration()
                           throws MCRConfigurationException

Description copied from class: MCRPIService

Checks the service parameters.

Overrides:

checkConfiguration in class MCRPIService<T extends MCRPersistentIdentifier>

Throws:

MCRConfigurationException - if parameter is missing or wrong!