org.fcrepo.kernel.utils

Class LowLevelCacheEntry

java.lang.Object

org.fcrepo.kernel.utils.LowLevelCacheEntry

Direct Known Subclasses:

CacheStoreEntry, ChainingCacheStoreEntry, LocalBinaryStoreEntry

public abstract class LowLevelCacheEntry
extends Object

Manage low-level I/O from a cache store (or, for an ISPN store, a cache loader) in order to report on e.g. fixity.

Author:

Chris Beer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DATA_SUFFIX
protected String	externalId
protected org.modeshape.jcr.value.BinaryKey	key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LowLevelCacheEntry(org.modeshape.jcr.value.BinaryKey key)

Method Summary

Methods

Modifier and Type	Method and Description
FixityResult	checkFixity(URI checksum, long size) Check the entry's InputStream against the checksum and size.
String	getExternalId() Return the external identifier.
abstract String	getExternalIdentifier() Generate a human-readable identifier for the location of this entry
abstract InputStream	getInputStream() Get a raw input stream from the underlying store
org.modeshape.jcr.value.BinaryKey	getKey() Get the BinaryKey for this cache entry
void	setExternalId(String externalId) Set a meaningful identifier from some higher level that we should dutifully pass through.
abstract void	storeValue(InputStream stream) Send a raw input stream to the underlying store for this entry; used for fixing e.g.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_SUFFIX

protected static final String DATA_SUFFIX

See Also:

Constant Field Values

externalId

protected String externalId

key

protected final org.modeshape.jcr.value.BinaryKey key

Constructor Detail

LowLevelCacheEntry

protected LowLevelCacheEntry(org.modeshape.jcr.value.BinaryKey key)

Method Detail

getInputStream

public abstract InputStream getInputStream()
                                    throws org.modeshape.jcr.value.binary.BinaryStoreException

Get a raw input stream from the underlying store

Returns:

the content for this entry

Throws:

org.modeshape.jcr.value.binary.BinaryStoreException

storeValue

public abstract void storeValue(InputStream stream)
                         throws org.modeshape.jcr.value.binary.BinaryStoreException,
                                IOException

Send a raw input stream to the underlying store for this entry; used for fixing e.g. fixity failures.

Parameters:

stream - binary content to REPLACE the content in the store

Throws:

org.modeshape.jcr.value.binary.BinaryStoreException

IOException

getExternalIdentifier

public abstract String getExternalIdentifier()

Generate a human-readable identifier for the location of this entry

Returns:

checkFixity

public FixityResult checkFixity(URI checksum,
                       long size)
                         throws org.modeshape.jcr.value.binary.BinaryStoreException

Check the entry's InputStream against the checksum and size.

Parameters:

checksum -

size -

digest -

Returns:

Throws:

org.modeshape.jcr.value.binary.BinaryStoreException

setExternalId

public void setExternalId(String externalId)

Set a meaningful identifier from some higher level that we should dutifully pass through.

Parameters:

externalId - some identifier for the cache store

getExternalId

public String getExternalId()

Return the external identifier.

getKey

public org.modeshape.jcr.value.BinaryKey getKey()

Get the BinaryKey for this cache entry

Returns: