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

Class AbstractSharedCachingDataStore

java.lang.Object
org.apache.jackrabbit.oak.spi.blob.data.AbstractDataStore
org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore
All Implemented Interfaces:
TypedDataStore, SharedDataStore, org.apache.jackrabbit.oak.spi.blob.data.DataStore, org.apache.jackrabbit.oak.spi.blob.data.MultiDataStoreAware
Direct Known Subclasses:
CachingFileDataStore
@Deprecated(since="2024-09-23") public abstract class AbstractSharedCachingDataStore extends org.apache.jackrabbit.oak.spi.blob.data.AbstractDataStore implements org.apache.jackrabbit.oak.spi.blob.data.MultiDataStoreAware, SharedDataStore, TypedDataStore
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.
Cache files locally and stage files locally for async uploads. Configuration: 
  <DataStore class="org.apache.jackrabbit.oak.plugins.blob.AbstractCachingDataStore">
      <param name="path"/>
      <param name="cacheSize" value="68719476736"/>
      <param name="stagingSplitPercentage" value="10"/>
      <param name="uploadThreads" value="10"/>
      <param name="stagingPurgeInterval" value="300"/>
      <param name="stagingRetryInterval " value="600"/>
  </DataStore>

  • Constructor Details

    • AbstractSharedCachingDataStore

      public AbstractSharedCachingDataStore()
      Deprecated.

  • Method Details

    • init

      public void init(String homeDir) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      init in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getRecord

      public org.apache.jackrabbit.oak.spi.blob.data.DataRecord getRecord(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier identifier) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      getRecord in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Overrides:
      getRecord in class org.apache.jackrabbit.oak.spi.blob.data.AbstractDataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getRecordIfStored

      @Nullable public @Nullable org.apache.jackrabbit.oak.spi.blob.data.DataRecord getRecordIfStored(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier dataIdentifier) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      getRecordIfStored in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • addRecord

      public org.apache.jackrabbit.oak.spi.blob.data.DataRecord addRecord(InputStream inputStream) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      addRecord in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • addRecord

      public org.apache.jackrabbit.oak.spi.blob.data.DataRecord addRecord(InputStream inputStream, BlobOptions blobOptions) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Description copied from interface: TypedDataStore
      Add a record with specified options.
      Specified by:
      addRecord in interface TypedDataStore
      Parameters:
      inputStream -
      blobOptions -
      Returns:
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getAllIdentifiers

      public Iterator<org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier> getAllIdentifiers() throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      In rare cases may include some duplicates in cases where async staged uploads complete during iteration.
      Specified by:
      getAllIdentifiers in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Returns:
      Iterator over all ids available
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • deleteRecord

      public void deleteRecord(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier dataIdentifier) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      deleteRecord in interface org.apache.jackrabbit.oak.spi.blob.data.MultiDataStoreAware
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • close

      public void close() throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      close in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • exists

      public boolean exists(org.apache.jackrabbit.oak.spi.blob.data.DataIdentifier identifier)
      Deprecated.
      Look in the backend for a record matching the given identifier. Returns true if such a record exists.
      Parameters:
      identifier - - An identifier for the record.
      Returns:
      true if a record for the provided identifier can be found.

    • getStats

      public List<DataStoreCacheStatsMBean> getStats()
      Deprecated.

    • setPath

      public void setPath(String path)
      Deprecated.
      ------------------------- setters ----------------------------------------------*

    • setCacheSize

      public void setCacheSize(long cacheSize)
      Deprecated.

    • setStagingSplitPercentage

      public void setStagingSplitPercentage(int stagingSplitPercentage)
      Deprecated.

    • setUploadThreads

      public void setUploadThreads(int uploadThreads)
      Deprecated.

    • setStagingPurgeInterval

      public void setStagingPurgeInterval(int stagingPurgeInterval)
      Deprecated.

    • setStagingRetryInterval

      public void setStagingRetryInterval(int stagingRetryInterval)
      Deprecated.

    • setStatisticsProvider

      public void setStatisticsProvider(StatisticsProvider statisticsProvider)
      Deprecated.

    • addMetadataRecord

      public void addMetadataRecord(InputStream stream, String name) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      ------------------------ SharedDataStore methods -----------------------------------------*
      Specified by:
      addMetadataRecord in interface SharedDataStore
      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

      public void addMetadataRecord(File f, 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:
      f - 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() throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Description copied from interface: SharedDataStore
      Retrieved an iterator over all DataRecords.
      Specified by:
      getAllRecords in interface SharedDataStore
      Returns:
      iterator over DataRecords
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException

    • getRecordForId

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

    • clearInUse

      public void clearInUse()
      Deprecated.
      ------------------------ unimplemented methods -------------------------------------------*
      Specified by:
      clearInUse in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore

    • updateModifiedDateOnAccess

      public void updateModifiedDateOnAccess(long l)
      Deprecated.
      Specified by:
      updateModifiedDateOnAccess in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore

    • deleteAllOlderThan

      public int deleteAllOlderThan(long l) throws org.apache.jackrabbit.oak.spi.blob.data.DataStoreException
      Deprecated.
      Specified by:
      deleteAllOlderThan in interface org.apache.jackrabbit.oak.spi.blob.data.DataStore
      Throws:
      org.apache.jackrabbit.oak.spi.blob.data.DataStoreException