Package org.fcrepo.persistence.ocfl.impl

Class FedoraToOcflObjectIndexMetrics

java.lang.Object

org.fcrepo.persistence.ocfl.impl.FedoraToOcflObjectIndexMetrics

All Implemented Interfaces:

FedoraToOcflObjectIndex

@Component("ocflIndex")
public class FedoraToOcflObjectIndexMetrics
extends Object
implements FedoraToOcflObjectIndex

Wrapper for FedoraToOcflObjectIndex that adds metrics

Author:

pwinckles

Constructor Summary

Constructors

Constructor	Description
FedoraToOcflObjectIndexMetrics()

Method Summary

Modifier and Type	Method	Description
FedoraOcflMapping	addMapping(org.fcrepo.kernel.api.Transaction session, org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier, org.fcrepo.kernel.api.identifiers.FedoraId fedoraRootObjectIdentifier, String ocflObjectId)	Adds a mapping to the index
void	clearAllTransactions()	Clear all transactions in the ocfl index.
void	commit(org.fcrepo.kernel.api.Transaction session)	Commit mapping changes for the session.
FedoraOcflMapping	getMapping(org.fcrepo.kernel.api.Transaction session, org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier)	Retrieve identification information for the OCFL object which either contains, or is identified by, the provided fedora resource id.
void	removeMapping(org.fcrepo.kernel.api.Transaction session, org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier)	Removes a mapping
void	reset()	Remove all persistent state associated with the index.
void	rollback(org.fcrepo.kernel.api.Transaction session)	Rollback mapping changes for the session.

Methods inherited from class java.lang.Object

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

Constructor Detail

FedoraToOcflObjectIndexMetrics

public FedoraToOcflObjectIndexMetrics()

Method Detail

getMapping

public FedoraOcflMapping getMapping(org.fcrepo.kernel.api.Transaction session,
                                    org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier)
                             throws FedoraOcflMappingNotFoundException

Description copied from interface: FedoraToOcflObjectIndex

Retrieve identification information for the OCFL object which either contains, or is identified by, the provided fedora resource id. In other words the method will find the closest resource that is persisted as an OCFL object and returns its identifiers. If you pass fedora identifier that is not part of an archival group such as "my/fedora/binary/fcr:metadata" the fedora resource returned in the mapping will be "my/fedora/binary". Contrast this with an Archival Group example: if you pass in "my/archival-group/binary/fcr:metadata" the resource returned in the mapping would be "my/archival-group".

Specified by:

getMapping in interface FedoraToOcflObjectIndex

Parameters:

session - the current session, or null for read-only.

fedoraResourceIdentifier - the fedora resource identifier

Returns:

the mapping

Throws:

FedoraOcflMappingNotFoundException - when no mapping exists for the specified identifier.

addMapping

public FedoraOcflMapping addMapping(org.fcrepo.kernel.api.Transaction session,
                                    org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier,
                                    org.fcrepo.kernel.api.identifiers.FedoraId fedoraRootObjectIdentifier,
                                    String ocflObjectId)

Description copied from interface: FedoraToOcflObjectIndex

Adds a mapping to the index

Specified by:

addMapping in interface FedoraToOcflObjectIndex

Parameters:

session - the current session.

fedoraResourceIdentifier - The fedora resource

fedoraRootObjectIdentifier - The identifier of the root fedora object resource

ocflObjectId - The ocfl object id

Returns:

The newly created mapping

removeMapping

public void removeMapping(org.fcrepo.kernel.api.Transaction session,
                          org.fcrepo.kernel.api.identifiers.FedoraId fedoraResourceIdentifier)

Description copied from interface: FedoraToOcflObjectIndex

Removes a mapping

Specified by:

removeMapping in interface FedoraToOcflObjectIndex

Parameters:

session - the current session.

fedoraResourceIdentifier - The fedora resource to remove the mapping for

reset

public void reset()

Description copied from interface: FedoraToOcflObjectIndex

Remove all persistent state associated with the index.

Specified by:

reset in interface FedoraToOcflObjectIndex

commit

public void commit(org.fcrepo.kernel.api.Transaction session)

Description copied from interface: FedoraToOcflObjectIndex

Commit mapping changes for the session.

Specified by:

commit in interface FedoraToOcflObjectIndex

Parameters:

session - the session to commit.

rollback

public void rollback(org.fcrepo.kernel.api.Transaction session)

Description copied from interface: FedoraToOcflObjectIndex

Rollback mapping changes for the session.

Specified by:

rollback in interface FedoraToOcflObjectIndex

Parameters:

session - the session to rollback.

clearAllTransactions

public void clearAllTransactions()

Description copied from interface: FedoraToOcflObjectIndex

Clear all transactions in the ocfl index.

Specified by:

clearAllTransactions in interface FedoraToOcflObjectIndex