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

Class OakFileDataStore

java.lang.Object
org.apache.jackrabbit.oak.spi.blob.data.AbstractDataStore
org.apache.jackrabbit.oak.spi.blob.data.FileDataStore
org.apache.jackrabbit.oak.plugins.blob.datastore.OakFileDataStore
All Implemented Interfaces:
SharedDataStore, org.apache.jackrabbit.oak.spi.blob.data.DataStore, org.apache.jackrabbit.oak.spi.blob.data.MultiDataStoreAware
@Deprecated(since="2024-09-23") public class OakFileDataStore extends org.apache.jackrabbit.oak.spi.blob.data.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

  • Field Details

    • LOG

      public static final Logger LOG
      Deprecated.

  • Constructor Details

    • OakFileDataStore

      public OakFileDataStore()
      Deprecated.

  • Method Details

    • getAllIdentifiers

      public Iterator<org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier> getAllIdentifiers()
      Deprecated.
      Specified by:
      getAllIdentifiers in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Overrides:
      getAllIdentifiers in class org.apache.jackrabbit.oak.spi.blob.data.FileDataStore

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

    • setReferenceKey

      public void setReferenceKey(byte[] referenceKey)
      Deprecated.

    • addMetadataRecord

      public void addMetadataRecord(InputStream input, String name) throws org.apache.jackrabbit.oak.spi.blob.data.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:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException - the data store exception

    • addMetadataRecord

      public void addMetadataRecord(File input, String name) throws org.apache.jackrabbit.oak.spi.blob.data.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:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException - the data store exception

    • getMetadataRecord

      public org.apache.jackrabbit.oak.spi.blob.data.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<org.apache.jackrabbit.oak.spi.blob.data.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<org.apache.jackrabbit.oak.spi.blob.data.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 org.apache.jackrabbit.oak.spi.blob.data.DataRecord getRecordForId(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier id) throws org.apache.jackrabbit.oak.spi.blob.data.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:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getType

      public SharedDataStore.Type getType()
      Deprecated.
      Description copied from interface: SharedDataStore
      Gets the type.
      Specified by:
      getType in interface SharedDataStore
      Returns:
      the type