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

Interface SharedDataStore

All Known Subinterfaces:
BlobTrackingStore
All Known Implementing Classes:
AbstractSharedCachingDataStore, CachingFileDataStore, DataStoreBlobStore, OakFileDataStore
@Deprecated(since="2024-09-23") public interface 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.
Interface to be implemented by a shared data store.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    SharedDataStore.Type
    Deprecated.
    Explicitly identifies the type of the data store

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMetadataRecord(File f, String name)
    Deprecated.
    Adds the root record.
    void
    addMetadataRecord(InputStream stream, 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.
    List<org.apache.jackrabbit.oak.spi.blob.data.DataRecord>
    getAllMetadataRecords(String prefix)
    Deprecated.
    Gets the all root records.
    Iterator<org.apache.jackrabbit.oak.spi.blob.data.DataRecord>
    getAllRecords()
    Deprecated.
    Retrieved an iterator over all DataRecords.
    org.apache.jackrabbit.oak.spi.blob.data.DataRecord
    getMetadataRecord(String name)
    Deprecated.
    Retrieves the metadata record with the given name
    org.apache.jackrabbit.oak.spi.blob.data.DataRecord
    getRecordForId(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier id)
    Deprecated.
    Retrieves the record for the given identifier
    default @Nullable String
    getRepositoryId()
    Deprecated.
    Returns the repository id (identifier for the repository in the DataStore)
    SharedDataStore.Type
    getType()
    Deprecated.
    Gets the type.
    boolean
    metadataRecordExists(String name)
    Deprecated.
    Checks if the metadata record with the name exists
    default void
    setRepositoryId(String repositoryId)
    Deprecated.
    Sets the repository id to identify repository in the DataStore

  • Method Details

    • addMetadataRecord

      void addMetadataRecord(InputStream stream, String name) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Adds the root record.
      Parameters:
      stream - the stream
      name - the name of the root record
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException - the data store exception

    • addMetadataRecord

      void addMetadataRecord(File f, String name) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Adds the root record.
      Parameters:
      f - the file
      name - the name of the root record
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException - the data store exception

    • getMetadataRecord

      org.apache.jackrabbit.oak.spi.blob.data.DataRecord getMetadataRecord(String name)
      Deprecated.
      Retrieves the metadata record with the given name
      Parameters:
      name - the name of the record
      Returns:

    • metadataRecordExists

      boolean metadataRecordExists(String name)
      Deprecated.
      Checks if the metadata record with the name exists
      Parameters:
      name -
      Returns:

    • getAllMetadataRecords

      List<org.apache.jackrabbit.oak.spi.blob.data.DataRecord> getAllMetadataRecords(String prefix)
      Deprecated.
      Gets the all root records.
      Returns:
      the all root records

    • deleteMetadataRecord

      boolean deleteMetadataRecord(String name)
      Deprecated.
      Deletes the root record represented by the given parameters.
      Parameters:
      name - the name of the root record
      Returns:
      success/failure

    • deleteAllMetadataRecords

      void deleteAllMetadataRecords(String prefix)
      Deprecated.
      Deletes all records matching the given prefix.
      Parameters:
      prefix - metadata type identifier

    • getAllRecords

      Iterator<org.apache.jackrabbit.oak.spi.blob.data.DataRecord> getAllRecords() throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Retrieved an iterator over all DataRecords.
      Returns:
      iterator over DataRecords
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getRecordForId

      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.
      Retrieves the record for the given identifier
      Parameters:
      id - the if of the record
      Returns:
      data record
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getType

      SharedDataStore.Type getType()
      Deprecated.
      Gets the type.
      Returns:
      the type

    • getRepositoryId

      @Nullable default @Nullable String getRepositoryId()
      Deprecated.
      Returns the repository id (identifier for the repository in the DataStore)
      Returns:
      repository id

    • setRepositoryId

      default void setRepositoryId(String repositoryId) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Sets the repository id to identify repository in the DataStore
      Parameters:
      repositoryId -
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException