Package org.mycore.pi

Class MCRPIService<T extends MCRPersistentIdentifier>

java.lang.Object

org.mycore.pi.MCRPIService<T>

Direct Known Subclasses:

MCRPIJobService, MCRURNGranularOAIService, MCRURNGranularRESTService, MCRURNOAIService

public abstract class MCRPIService<T extends MCRPersistentIdentifier>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERATOR_CONFIG_PREFIX
static final String	GENERATOR_PROPERTY_KEY
static final String	METADATA_SERVICE_CONFIG_PREFIX
protected static final String	METADATA_SERVICE_PROPERTY_KEY
static final String	PI_FLAG
static final String	REGISTRATION_CONFIG_PREFIX
protected static final String	TRANSLATE_PREFIX

Constructor Summary

Constructors

Constructor	Description
MCRPIService(String identifierType)

Method Summary

Modifier and Type	Method	Description
static void	addFlagToObject(MCRBase obj, MCRPI databaseEntry)
protected void	checkConfiguration()	Checks the service parameters.
protected abstract void	delete(T identifier, MCRBase obj, String additional)	Should handle deletion of a Object with the PI.
protected Predicate<MCRBase>	getCreationPredicate()
protected MCRPIGenerator<T>	getGenerator()
protected static com.google.gson.Gson	getGson()
MCRPIMetadataService<T>	getMetadataService()
protected T	getNewIdentifier(MCRBase id, String additional)
static Predicate<MCRBase>	getPredicateInstance(String predicateProperty)
protected final Map<String,String>	getProperties()
protected Predicate<MCRBase>	getRegistrationPredicate()
final String	getServiceID()
protected MCRPI	getTableEntry(MCRObjectID id, String additional)
final String	getType()
static boolean	hasFlag(MCRBase obj, String additional, MCRPIRegistrationInfo mcrpi)
static boolean	hasFlag(MCRObjectID id, String additional, MCRPIRegistrationInfo mcrpi)
boolean	hasRegistrationStarted(MCRObjectID id, String additional)
void	init(String prop)
MCRPI	insertIdentifierToDatabase(MCRBase obj, String additional, T identifier)
boolean	isCreated(MCRObjectID id, String additional)
boolean	isRegistered(MCRObjectID id, String additional)
protected final void	onDelete(T identifier, MCRBase obj, String additional)
protected final void	onUpdate(T identifier, MCRBase obj, String additional)
protected Date	provideRegisterDate(MCRBase obj, String additional)
T	register(MCRBase obj)	Adds a identifier to the object.
T	register(MCRBase obj, String additional)	shorthand for register(MCRBase, String, boolean) with update = true
T	register(MCRBase obj, String additional, boolean updateObject)	Validates everything, registers a new Identifier, inserts the identifier to object metadata and writes a information to the Database.
protected abstract void	registerIdentifier(MCRBase obj, String additional, T pi)
static MCRPI	removeFlagFromObject(MCRBase obj, MCRPI databaseEntry)	Removes a flag from a MCRObject
protected String	requireNotEmptyProperty(String propertyName)	Validates a property of this service
void	setProperties(Map<String,String> properties)
protected abstract void	update(T identifier, MCRBase obj, String additional)	Should handle updates of a Object with the PI.
void	updateFlag(MCRObjectID id, String additional, MCRPI mcrpi)
static void	updateFlagsInDatabase(MCRBase obj)
protected void	validateAlreadyCreated(MCRObjectID id, String additional)
protected void	validatePermission(MCRBase obj, boolean writePermission)
void	validateRegistration(MCRBase obj, String additional)	Validates if an object can get an Identifier assigned from this service!
void	validateRegistration(MCRBase obj, String additional, boolean checkWritePermission)

Methods inherited from class java.lang.Object

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

Field Details

REGISTRATION_CONFIG_PREFIX

public static final String REGISTRATION_CONFIG_PREFIX

See Also:

• Constant Field Values

GENERATOR_CONFIG_PREFIX

public static final String GENERATOR_CONFIG_PREFIX

See Also:

• Constant Field Values

METADATA_SERVICE_CONFIG_PREFIX

public static final String METADATA_SERVICE_CONFIG_PREFIX

See Also:

• Constant Field Values

PI_FLAG

public static final String PI_FLAG

See Also:

• Constant Field Values

GENERATOR_PROPERTY_KEY

public static final String GENERATOR_PROPERTY_KEY

See Also:

• Constant Field Values

METADATA_SERVICE_PROPERTY_KEY

protected static final String METADATA_SERVICE_PROPERTY_KEY

See Also:

• Constant Field Values

TRANSLATE_PREFIX

protected static final String TRANSLATE_PREFIX

See Also:

• Constant Field Values

Constructor Details

MCRPIService

public MCRPIService(String identifierType)

Method Details

init

public void init(String prop)

getGson

protected static com.google.gson.Gson getGson()

getServiceID

public final String getServiceID()

checkConfiguration

protected void checkConfiguration()
                           throws MCRConfigurationException

Checks the service parameters.

Throws:

MCRConfigurationException - if parameter is missing or wrong!

getMetadataService

public MCRPIMetadataService<T> getMetadataService()

getGenerator

protected MCRPIGenerator<T> getGenerator()

addFlagToObject

public static void addFlagToObject(MCRBase obj,
 MCRPI databaseEntry)

removeFlagFromObject

public static MCRPI removeFlagFromObject(MCRBase obj,
 MCRPI databaseEntry)

Removes a flag from a MCRObject

Parameters:

obj - the object

databaseEntry - the database entry

Returns:

the remove entry parsed from json or null

hasFlag

public static boolean hasFlag(MCRObjectID id,
 String additional,
 MCRPIRegistrationInfo mcrpi)

hasFlag

public static boolean hasFlag(MCRBase obj,
 String additional,
 MCRPIRegistrationInfo mcrpi)

validatePermission

protected void validatePermission(MCRBase obj,
 boolean writePermission)
                           throws MCRAccessException

Throws:

MCRAccessException

validateAlreadyCreated

protected void validateAlreadyCreated(MCRObjectID id,
 String additional)
                               throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

validateRegistration

public void validateRegistration(MCRBase obj,
 String additional)
                          throws MCRPersistentIdentifierException,
MCRAccessException

Validates if an object can get an Identifier assigned from this service! Better call super when overwrite!

Parameters:

obj -

Throws:

MCRPersistentIdentifierException - see org.mycore.pi.exceptions

MCRAccessException - if the user does not have the rights to assign a pi to the specific object

validateRegistration

public void validateRegistration(MCRBase obj,
 String additional,
 boolean checkWritePermission)
                          throws MCRPersistentIdentifierException,
MCRAccessException

Throws:

MCRPersistentIdentifierException

MCRAccessException

register

public T register(MCRBase obj,
 String additional)
           throws MCRAccessException,
MCRActiveLinkException,
MCRPersistentIdentifierException,
ExecutionException,
InterruptedException

shorthand for register(MCRBase, String, boolean) with update = true

Throws:

MCRAccessException

MCRActiveLinkException

MCRPersistentIdentifierException

ExecutionException

InterruptedException

register

public T register(MCRBase obj)
           throws MCRAccessException,
MCRActiveLinkException,
MCRPersistentIdentifierException,
ExecutionException,
InterruptedException

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

Parameters:

obj - the object which has to be identified

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

ExecutionException

InterruptedException

register

public T register(MCRBase obj,
 String additional,
 boolean updateObject)
           throws MCRAccessException,
MCRActiveLinkException,
MCRPersistentIdentifierException,
ExecutionException,
InterruptedException

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

Parameters:

obj - the object which has to be identified

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

ExecutionException

InterruptedException

provideRegisterDate

protected Date provideRegisterDate(MCRBase obj,
 String additional)

insertIdentifierToDatabase

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

updateFlagsInDatabase

public static void updateFlagsInDatabase(MCRBase obj)

getType

public final String getType()

registerIdentifier

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

Throws:

MCRPersistentIdentifierException

onDelete

protected final void onDelete(T identifier,
 MCRBase obj,
 String additional)
                       throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

onUpdate

protected final void onUpdate(T identifier,
 MCRBase obj,
 String additional)
                       throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

delete

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

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

Parameters:

identifier - the Identifier

obj - the deleted object

additional -

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 abstract void update(T identifier,
 MCRBase obj,
 String additional)
                        throws MCRPersistentIdentifierException

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

Parameters:

identifier - the Identifier

obj - the deleted object

additional -

Throws:

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

isCreated

public boolean isCreated(MCRObjectID id,
 String additional)

isRegistered

public boolean isRegistered(MCRObjectID id,
 String additional)

hasRegistrationStarted

public boolean hasRegistrationStarted(MCRObjectID id,
 String additional)

getProperties

protected final Map<String,String> getProperties()

setProperties

public void setProperties(Map<String,String> properties)

getNewIdentifier

protected T getNewIdentifier(MCRBase id,
 String additional)
                      throws MCRPersistentIdentifierException

Throws:

MCRPersistentIdentifierException

getTableEntry

protected MCRPI getTableEntry(MCRObjectID id,
 String additional)

updateFlag

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

requireNotEmptyProperty

protected String requireNotEmptyProperty(String propertyName)
                                  throws MCRConfigurationException

Validates a property of this service

Parameters:

propertyName - the property to check

Returns:

the property

Throws:

MCRConfigurationException - if property is not set or empty

getCreationPredicate

protected Predicate<MCRBase> getCreationPredicate()

getRegistrationPredicate

protected Predicate<MCRBase> getRegistrationPredicate()

getPredicateInstance

public static Predicate<MCRBase> getPredicateInstance(String predicateProperty)