Package 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:

DataStore, MultiDataStoreAware, SharedDataStore

@Deprecated(since="2024-09-23")
public class OakFileDataStore
extends FileDataStore
implements SharedDataStore

Deprecated.

The Jackrabbit Oak Blob Plugins library is designed for Oak-internal use only and thus deprecated. It will not be part of the AEM SDK after April 2025.

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	Description
static final Logger	LOG	Deprecated.

Constructor Summary

Constructors

Constructor	Description
OakFileDataStore()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addMetadataRecord(File input, String name)	Deprecated. Adds the root record.
void	addMetadataRecord(InputStream input, String name)	Deprecated. Adds the root record.
void	deleteAllMetadataRecords(String prefix)	Deprecated. Deletes all records matching the given prefix.
boolean	deleteMetadataRecord(String name)	Deprecated. Deletes the root record represented by the given parameters.
Iterator<DataIdentifier>	getAllIdentifiers()	Deprecated. Get all identifiers.
List<DataRecord>	getAllMetadataRecords(String prefix)	Deprecated. Gets the all root records.
Iterator<DataRecord>	getAllRecords()	Deprecated. Retrieved an iterator over all DataRecords.
DataRecord	getMetadataRecord(String name)	Deprecated. Retrieves the metadata record with the given name
DataRecord	getRecordForId(DataIdentifier id)	Deprecated. Retrieves the record for the given identifier
SharedDataStore.Type	getType()	Deprecated. Gets the type.
boolean	metadataRecordExists(String name)	Deprecated. Checks if the metadata record with the name exists
void	setReferenceKey(byte[] referenceKey)	Deprecated.
void	setReferenceKeyEncoded(String encodedKey)	Deprecated. Set Base64 encoded signing key
void	setReferenceKeyPlainText(String textKey)	Deprecated. 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

getRecord, getRecordFromReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.plugins.blob.SharedDataStore

getRepositoryId, setRepositoryId

Field Details

LOG

public static final Logger LOG

Deprecated.

Constructor Details

OakFileDataStore

public OakFileDataStore()

Deprecated.

Method Details

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()

Deprecated.

Description copied from interface: DataStore

Get all identifiers.

Specified by:

getAllIdentifiers in interface DataStore

Overrides:

getAllIdentifiers in class FileDataStore

Returns:

an iterator over all DataIdentifier objects

setReferenceKeyEncoded

public void setReferenceKeyEncoded(String encodedKey)

Deprecated.

Set Base64 encoded signing key

setReferenceKeyPlainText

public void setReferenceKeyPlainText(String textKey)

Deprecated.

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)

Deprecated.

addMetadataRecord

public void addMetadataRecord(InputStream input,
 String name)
                       throws DataStoreException

Deprecated.

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:

DataStoreException - the data store exception

addMetadataRecord

public void addMetadataRecord(File input,
 String name)
                       throws DataStoreException

Deprecated.

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:

DataStoreException - the data store exception

getMetadataRecord

public DataRecord getMetadataRecord(String name)

Deprecated.

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:

metadataRecordExists

public boolean metadataRecordExists(String name)

Deprecated.

Description copied from interface: SharedDataStore

Checks if the metadata record with the name exists

Specified by:

metadataRecordExists in interface SharedDataStore

Parameters:

name -

Returns:

getAllMetadataRecords

public List<DataRecord> getAllMetadataRecords(String prefix)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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<DataRecord> getAllRecords()

Deprecated.

Description copied from interface: SharedDataStore

Retrieved an iterator over all DataRecords.

Specified by:

getAllRecords in interface SharedDataStore

Returns:

iterator over DataRecords

getRecordForId

public DataRecord getRecordForId(DataIdentifier id)
                          throws DataStoreException

Deprecated.

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:

DataStoreException

getType

public SharedDataStore.Type getType()

Deprecated.

Description copied from interface: SharedDataStore

Gets the type.

Specified by:

getType in interface SharedDataStore

Returns:

the type