Package org.mycore.pi.handle

Class MCREpicService

java.lang.Object

org.mycore.pi.MCRPIService<T>

org.mycore.pi.MCRPIJobService<MCRHandle>

org.mycore.pi.handle.MCREpicService

public class MCREpicService
extends MCRPIJobService<MCRHandle>

Nested Class Summary

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

MCRPIJobService.PiJobAction

Field Summary

Fields

Modifier and Type	Field	Description
String	baseURL	This is a alternative to mcr.baseurl mostly for testing purposes
String	endpoint	The url to the actual epic api endpoint e.g. https://epic.grnet.gr/api/v2/, http://pid.gwdg.de/
static final String	EPIC_KEY
ConcurrentHashMap<String,ReentrantLock>	idLockMap
String	metadataIndex	The Index which should be used in the handle object.
String	metadataType	The Type which should be used in the Handle Object.
static final String	OBJECT_ID_KEY
String	password	The password which will be used by the epic client
String	transformerID	This can be used to store metadata as a Handle Object.
String	username	The Username which will be used by the epic client

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

Method Summary

Modifier and Type	Method	Description
protected void	delete(MCRHandle identifier, MCRBase obj, String additional)	Should handle deletion of a Object with the PI.
protected void	deleteJob(Map<String,String> parameters)
protected Optional<String>	getJobInformation(Map<String,String> contextParameters)	Result of this will be passed to MCRJobAction.name()
protected String	getURLForObject(String objectId)
MCRPI	insertIdentifierToDatabase(MCRBase obj, String additional, MCRHandle identifier)
protected void	registerIdentifier(MCRBase obj, String additional, MCRHandle pi)
protected void	registerJob(Map<String,String> parameters)
protected void	update(MCRHandle identifier, MCRBase obj, String additional)	Should handle updates of a Object with the PI.
protected 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

Field Details

EPIC_KEY

public static final String EPIC_KEY

See Also:

• Constant Field Values

OBJECT_ID_KEY

public static final String OBJECT_ID_KEY

See Also:

• Constant Field Values

username

public String username

The Username which will be used by the epic client

password

public String password

The password which will be used by the epic client

endpoint

public String endpoint

The url to the actual epic api endpoint e.g. https://epic.grnet.gr/api/v2/, http://pid.gwdg.de/

baseURL

public String baseURL

This is a alternative to mcr.baseurl mostly for testing purposes

transformerID

public String transformerID

This can be used to store metadata as a Handle Object. The Transformer will be used to convert the Object to an String.

metadataType

public String metadataType

The Type which should be used in the Handle Object.

metadataIndex

public String metadataIndex

The Index which should be used in the handle object.

idLockMap

public ConcurrentHashMap<String,ReentrantLock> idLockMap

Constructor Details

MCREpicService

public MCREpicService()

Method Details

insertIdentifierToDatabase

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

Overrides:

insertIdentifierToDatabase in class MCRPIService<MCRHandle>

registerIdentifier

protected void registerIdentifier(MCRBase obj,
 String additional,
 MCRHandle pi)
                           throws MCRPersistentIdentifierException

Specified by:

registerIdentifier in class MCRPIService<MCRHandle>

Throws:

MCRPersistentIdentifierException

delete

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

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(MCRHandle 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<MCRHandle>

Parameters:

identifier - the Identifier

obj - the deleted object

Throws:

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

deleteJob

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

Specified by:

deleteJob in class MCRPIJobService<MCRHandle>

Throws:

MCRPersistentIdentifierException

updateJob

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

Specified by:

updateJob in class MCRPIJobService<MCRHandle>

Throws:

MCRPersistentIdentifierException

getURLForObject

protected String getURLForObject(String objectId)

registerJob

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

Specified by:

registerJob in class MCRPIJobService<MCRHandle>

Throws:

MCRPersistentIdentifierException

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

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.