Package org.mycore.ocfl

Class MCROCFLXMLMetadataManager

java.lang.Object

org.mycore.ocfl.MCROCFLXMLMetadataManager

All Implemented Interfaces:

MCRXMLMetadataManagerAdapter

public class MCROCFLXMLMetadataManager
extends Object
implements MCRXMLMetadataManagerAdapter

Manages persistence of MCRObject and MCRDerivate xml metadata. Provides methods to create, retrieve, update and delete object metadata using OCFL

Constructor Summary

Constructors

Constructor	Description
MCROCFLXMLMetadataManager()

Method Summary

Modifier and Type	Method	Description
void	create(MCRObjectID mcrid, MCRContent xml, Date lastModified)	Stores metadata of a new MCRObject in the persistent store.
void	create(MCRObjectID mcrid, MCRContent xml, Date lastModified, String user)
void	delete(MCRObjectID mcrid)	Delete metadata in store.
void	delete(MCRObjectID mcrid, Date date, String user)
boolean	exists(MCRObjectID mcrid)	Checks if an object with the given MCRObjectID exists in the store.
int	getHighestStoredID(String project, String type)	This method returns the highest stored ID number for a given MCRObjectID base, or 0 if no object is stored for this type and project.
long	getLastModified(String ocflObjectId)
long	getLastModified(MCRObjectID id)	Returns the time when the xml data of a MCRObject was last modified.
MCRCache.ModifiedHandle	getLastModifiedHandle(MCRObjectID id, long expire, TimeUnit unit)
Collection<String>	getObjectBaseIds()	Returns all used base ids of MCRObjects/MCRDerivates.
Collection<String>	getObjectTypes()	Returns all stored object types of MCRObjects/MCRDerivates.
edu.wisc.library.ocfl.api.OcflRepository	getRepository()
String	getRepositoryKey()
IntStream	getStoredIDs(String project, String type)
List<String>	listIDs()	Lists all MCRObjectIDs of all types and projects stored in any metadata store
List<String>	listIDsForBase(String base)	Lists all MCRObjectIDs stored for the given base, which is {project}_{type}
List<String>	listIDsOfType(String type)	Lists all MCRObjectIDs stored for the given object type, for all projects
List<MCROCFLMetadataVersion>	listRevisions(MCRObjectID id)	Lists all versions of this metadata object available in the subversion repository.
void	reload()	Reads configuration properties, checks and creates base directories and builds the singleton.
MCRContent	retrieveContent(MCRObjectID mcrid)	Retrieves the (latest) content of a metadata object.
MCRContent	retrieveContent(MCRObjectID mcrid, String revision)	Retrieves the content of a specific revision of a metadata object.
List<MCRObjectIDDate>	retrieveObjectDates(List<String> ids)	Returns an enhanced list of object ids and their last modified date
void	setRepositoryKey(String repositoryKey)
void	update(MCRObjectID mcrid, MCRContent xml, Date lastModified)	Updates metadata of existing MCRObject in the persistent store.
void	update(MCRObjectID mcrid, MCRContent xml, Date lastModified, String user)
void	verifyStore(String base)	Try to validate a store.

Methods inherited from class java.lang.Object

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

Constructor Details

MCROCFLXMLMetadataManager

public MCROCFLXMLMetadataManager()

Method Details

getRepository

public edu.wisc.library.ocfl.api.OcflRepository getRepository()

getRepositoryKey

public String getRepositoryKey()

setRepositoryKey

public void setRepositoryKey(String repositoryKey)

reload

public void reload()

Description copied from interface: MCRXMLMetadataManagerAdapter

Reads configuration properties, checks and creates base directories and builds the singleton.

Specified by:

reload in interface MCRXMLMetadataManagerAdapter

verifyStore

public void verifyStore(String base)

Description copied from interface: MCRXMLMetadataManagerAdapter

Try to validate a store.

Specified by:

verifyStore in interface MCRXMLMetadataManagerAdapter

Parameters:

base - The base ID of a to-be-validated store

create

public void create(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified)
            throws MCRPersistenceException

Description copied from interface: MCRXMLMetadataManagerAdapter

Stores metadata of a new MCRObject in the persistent store.

Specified by:

create in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException - the object couldn't be created due persistence problems

create

public void create(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified,
 String user)
            throws MCRPersistenceException

Throws:

MCRPersistenceException

delete

public void delete(MCRObjectID mcrid)
            throws MCRPersistenceException

Description copied from interface: MCRXMLMetadataManagerAdapter

Delete metadata in store.

Specified by:

delete in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the MCRObjectID

Throws:

MCRPersistenceException - if an error occurs during the deletion

delete

public void delete(MCRObjectID mcrid,
 Date date,
 String user)
            throws MCRPersistenceException

Throws:

MCRPersistenceException

update

public void update(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified)
            throws MCRPersistenceException

Description copied from interface: MCRXMLMetadataManagerAdapter

Updates metadata of existing MCRObject in the persistent store.

Specified by:

update in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the MCRObjectID

xml - the xml metadata of the MCRObject

lastModified - the date of last modification to set

Throws:

MCRPersistenceException

update

public void update(MCRObjectID mcrid,
 MCRContent xml,
 Date lastModified,
 String user)
            throws MCRPersistenceException

Throws:

MCRPersistenceException

retrieveContent

public MCRContent retrieveContent(MCRObjectID mcrid)
                           throws IOException

Description copied from interface: MCRXMLMetadataManagerAdapter

Retrieves the (latest) content of a metadata object.

Specified by:

retrieveContent in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the id of the object to be retrieved

Returns:

a MCRContent representing the MCRObject or null if there is no such object

Throws:

IOException

retrieveContent

public MCRContent retrieveContent(MCRObjectID mcrid,
 String revision)
                           throws IOException

Description copied from interface: MCRXMLMetadataManagerAdapter

Retrieves the content of a specific revision of a metadata object.

Specified by:

retrieveContent in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the id of the object to be retrieved

revision - the revision to be returned, specify -1 if you want to retrieve the latest revision (includes deleted objects also)

Returns:

a MCRContent representing the MCRObject of the given revision or null if there is no such object with the given revision

Throws:

IOException

listRevisions

public List<MCROCFLMetadataVersion> listRevisions(MCRObjectID id)

Description copied from interface: MCRXMLMetadataManagerAdapter

Lists all versions of this metadata object available in the subversion repository.

Specified by:

listRevisions in interface MCRXMLMetadataManagerAdapter

Parameters:

id - the id of the object to be retrieved

Returns:

List with all MCRMetadataVersion of the given object or null if the id is null or the metadata store doesn't support versioning

getStoredIDs

public IntStream getStoredIDs(String project,
 String type)
                       throws MCRPersistenceException

Throws:

MCRPersistenceException

getHighestStoredID

public int getHighestStoredID(String project,
 String type)

Description copied from interface: MCRXMLMetadataManagerAdapter

This method returns the highest stored ID number for a given MCRObjectID base, or 0 if no object is stored for this type and project.

Specified by:

getHighestStoredID in interface MCRXMLMetadataManagerAdapter

Parameters:

project - the project ID part of the MCRObjectID base

type - the type ID part of the MCRObjectID base

Returns:

the highest stored ID number as a String

exists

public boolean exists(MCRObjectID mcrid)
               throws MCRPersistenceException

Description copied from interface: MCRXMLMetadataManagerAdapter

Checks if an object with the given MCRObjectID exists in the store.

Specified by:

exists in interface MCRXMLMetadataManagerAdapter

Parameters:

mcrid - the MCRObjectID to check

Returns:

true if the ID exists, or false if it doesn't

Throws:

MCRPersistenceException - if an error occurred in the store

listIDsForBase

public List<String> listIDsForBase(String base)

Description copied from interface: MCRXMLMetadataManagerAdapter

Lists all MCRObjectIDs stored for the given base, which is {project}_{type}

Specified by:

listIDsForBase in interface MCRXMLMetadataManagerAdapter

Parameters:

base - the MCRObjectID base, e.g. DocPortal_document

Returns:

List of Strings with all MyCoRe identifiers found in the metadata stores for the given base

listIDsOfType

public List<String> listIDsOfType(String type)

Description copied from interface: MCRXMLMetadataManagerAdapter

Lists all MCRObjectIDs stored for the given object type, for all projects

Specified by:

listIDsOfType in interface MCRXMLMetadataManagerAdapter

Parameters:

type - the MCRObject type, e.g. document

Returns:

List of Strings with all MyCoRe identifiers found in the metadata store for the given type

listIDs

public List<String> listIDs()

Description copied from interface: MCRXMLMetadataManagerAdapter

Lists all MCRObjectIDs of all types and projects stored in any metadata store

Specified by:

listIDs in interface MCRXMLMetadataManagerAdapter

Returns:

List of Strings with all MyCoRe identifiers found in the metadata store

getObjectTypes

public Collection<String> getObjectTypes()

Description copied from interface: MCRXMLMetadataManagerAdapter

Returns all stored object types of MCRObjects/MCRDerivates.

Specified by:

getObjectTypes in interface MCRXMLMetadataManagerAdapter

Returns:

Collection of Strings with all object types

See Also:

• MCRObjectID.getTypeId()

getObjectBaseIds

public Collection<String> getObjectBaseIds()

Description copied from interface: MCRXMLMetadataManagerAdapter

Returns all used base ids of MCRObjects/MCRDerivates.

Specified by:

getObjectBaseIds in interface MCRXMLMetadataManagerAdapter

Returns:

Collection of Strings with all object base identifier

See Also:

• MCRObjectID.getBase()

retrieveObjectDates

public List<MCRObjectIDDate> retrieveObjectDates(List<String> ids)
                                          throws IOException

Description copied from interface: MCRXMLMetadataManagerAdapter

Returns an enhanced list of object ids and their last modified date

Specified by:

retrieveObjectDates in interface MCRXMLMetadataManagerAdapter

Parameters:

ids - MCRObject ids

Throws:

IOException

getLastModified

public long getLastModified(MCRObjectID id)
                     throws IOException

Description copied from interface: MCRXMLMetadataManagerAdapter

Returns the time when the xml data of a MCRObject was last modified.

Specified by:

getLastModified in interface MCRXMLMetadataManagerAdapter

Parameters:

id - the MCRObjectID of an object

Returns:

the last modification data of the object

Throws:

IOException - thrown while retrieving the object from the store

getLastModified

public long getLastModified(String ocflObjectId)
                     throws IOException

Throws:

IOException

getLastModifiedHandle

public MCRCache.ModifiedHandle getLastModifiedHandle(MCRObjectID id,
 long expire,
 TimeUnit unit)

Specified by:

getLastModifiedHandle in interface MCRXMLMetadataManagerAdapter

Returns: