org.apache.jackrabbit.oak.plugins.blob.datastore

Class OakFileDataStore

java.lang.Object

org.apache.jackrabbit.core.data.AbstractDataStore

org.apache.jackrabbit.core.data.FileDataStore

org.apache.jackrabbit.oak.plugins.blob.datastore.OakFileDataStore

All Implemented Interfaces:

org.apache.jackrabbit.core.data.DataStore, org.apache.jackrabbit.core.data.MultiDataStoreAware, SharedDataStore

public class OakFileDataStore
extends org.apache.jackrabbit.core.data.FileDataStore
implements SharedDataStore

Oak specific extension of JR2 FileDataStore which enables provisioning the signing key via OSGi config

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.blob.SharedDataStore

SharedDataStore.Type

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Fields inherited from class org.apache.jackrabbit.core.data.FileDataStore

inUse

Fields inherited from class org.apache.jackrabbit.core.data.AbstractDataStore

DIGEST

Constructor Summary

Constructors

Constructor and Description
OakFileDataStore()

Method Summary

Modifier and Type	Method and Description
void	addMetadataRecord(File input, String name) Adds the root record.
void	addMetadataRecord(InputStream input, String name) Adds the root record.
void	deleteAllMetadataRecords(String prefix) Deletes all records matching the given prefix.
boolean	deleteMetadataRecord(String name) Deletes the root record represented by the given parameters.
Iterator<org.apache.jackrabbit.core.data.DataIdentifier>	getAllIdentifiers()
List<org.apache.jackrabbit.core.data.DataRecord>	getAllMetadataRecords(String prefix) Gets the all root records.
Iterator<org.apache.jackrabbit.core.data.DataRecord>	getAllRecords() Retrieved an iterator over all DataRecords.
org.apache.jackrabbit.core.data.DataRecord	getMetadataRecord(String name) Retrieves the metadata record with the given name
protected byte[]	getOrCreateReferenceKey()
org.apache.jackrabbit.core.data.DataRecord	getRecordForId(org.apache.jackrabbit.core.data.DataIdentifier id) Retrieves the record for the given identifier
SharedDataStore.Type	getType() Gets the type.
void	setReferenceKey(byte[] referenceKey)
void	setReferenceKeyEncoded(String encodedKey) Set Base64 encoded signing key
void	setReferenceKeyPlainText(String textKey) Set the referenceKey from plain text.

Methods inherited from class org.apache.jackrabbit.core.data.FileDataStore

addRecord, clearInUse, close, deleteAllOlderThan, deleteRecord, getMinRecordLength, getPath, getRecordIfStored, init, setMinRecordLength, setPath, updateModifiedDateOnAccess

Methods inherited from class org.apache.jackrabbit.core.data.AbstractDataStore

encodeHexString, getRecord, getRecordFromReference, getReferenceFromIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

OakFileDataStore

public OakFileDataStore()

Method Detail

getAllIdentifiers

public Iterator<org.apache.jackrabbit.core.data.DataIdentifier> getAllIdentifiers()

Specified by:

getAllIdentifiers in interface org.apache.jackrabbit.core.data.DataStore

Overrides:

getAllIdentifiers in class org.apache.jackrabbit.core.data.FileDataStore

getOrCreateReferenceKey

protected byte[] getOrCreateReferenceKey()
                                  throws org.apache.jackrabbit.core.data.DataStoreException

Overrides:

getOrCreateReferenceKey in class org.apache.jackrabbit.core.data.FileDataStore

Throws:

org.apache.jackrabbit.core.data.DataStoreException

setReferenceKeyEncoded

public void setReferenceKeyEncoded(String encodedKey)

Set Base64 encoded signing key

setReferenceKeyPlainText

public void setReferenceKeyPlainText(String textKey)

Set the referenceKey from plain text. Key content would be UTF-8 encoding of the string.

This is useful when setting key via generic bean property manipulation from string properties. User can specify the key in plain text and that would be passed on this object via PropertiesUtil.populate(Object, java.util.Map, boolean)

Parameters:

textKey - base64 encoded key

See Also:

PropertiesUtil.populate(Object, java.util.Map, boolean)

setReferenceKey

public void setReferenceKey(byte[] referenceKey)

addMetadataRecord

public void addMetadataRecord(InputStream input,
                              String name)
                       throws org.apache.jackrabbit.core.data.DataStoreException

Description copied from interface: SharedDataStore

Adds the root record.

Specified by:

addMetadataRecord in interface SharedDataStore

Parameters:

input - the stream

name - the name of the root record

Throws:

org.apache.jackrabbit.core.data.DataStoreException - the data store exception

addMetadataRecord

public void addMetadataRecord(File input,
                              String name)
                       throws org.apache.jackrabbit.core.data.DataStoreException

Description copied from interface: SharedDataStore

Adds the root record.

Specified by:

addMetadataRecord in interface SharedDataStore

Parameters:

input - the file

name - the name of the root record

Throws:

org.apache.jackrabbit.core.data.DataStoreException - the data store exception

getMetadataRecord

public org.apache.jackrabbit.core.data.DataRecord getMetadataRecord(String name)

Description copied from interface: SharedDataStore

Retrieves the metadata record with the given name

Specified by:

getMetadataRecord in interface SharedDataStore

Parameters:

name - the name of the record

Returns:

getAllMetadataRecords

public List<org.apache.jackrabbit.core.data.DataRecord> getAllMetadataRecords(String prefix)

Description copied from interface: SharedDataStore

Gets the all root records.

Specified by:

getAllMetadataRecords in interface SharedDataStore

Returns:

the all root records

deleteMetadataRecord

public boolean deleteMetadataRecord(String name)

Description copied from interface: SharedDataStore

Deletes the root record represented by the given parameters.

Specified by:

deleteMetadataRecord in interface SharedDataStore

Parameters:

name - the name of the root record

Returns:

success/failure

deleteAllMetadataRecords

public void deleteAllMetadataRecords(String prefix)

Description copied from interface: SharedDataStore

Deletes all records matching the given prefix.

Specified by:

deleteAllMetadataRecords in interface SharedDataStore

Parameters:

prefix - metadata type identifier

getAllRecords

public Iterator<org.apache.jackrabbit.core.data.DataRecord> getAllRecords()

Description copied from interface: SharedDataStore

Retrieved an iterator over all DataRecords.

Specified by:

getAllRecords in interface SharedDataStore

Returns:

iterator over DataRecords

getRecordForId

public org.apache.jackrabbit.core.data.DataRecord getRecordForId(org.apache.jackrabbit.core.data.DataIdentifier id)
                                                          throws org.apache.jackrabbit.core.data.DataStoreException

Description copied from interface: SharedDataStore

Retrieves the record for the given identifier

Specified by:

getRecordForId in interface SharedDataStore

Parameters:

id - the if of the record

Returns:

data record

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getType

public SharedDataStore.Type getType()

Description copied from interface: SharedDataStore

Gets the type.

Specified by:

getType in interface SharedDataStore

Returns:

the type