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

Class DataStoreBlobStore

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable, DataStore, org.apache.jackrabbit.oak.api.blob.BlobAccessProvider, BlobTrackingStore, TypedDataStore, SharedDataStore, org.apache.jackrabbit.oak.spi.blob.BlobStore, org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

public class DataStoreBlobStore
extends Object
implements DataStore, org.apache.jackrabbit.oak.spi.blob.BlobStore, org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore, BlobTrackingStore, TypedDataStore, org.apache.jackrabbit.oak.api.blob.BlobAccessProvider

BlobStore wrapper for DataStore. Wraps Jackrabbit 2 DataStore and expose them as BlobStores It also handles inlining binaries if there size is smaller than DataStore.getMinRecordLength()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataStoreBlobStore.BlobId

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

SharedDataStore.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.jackrabbit.guava.common.cache.LoadingCache<String,byte[]>	cache
static final int	DEFAULT_CACHE_SIZE
protected final DataStore	delegate
static final String	MEM_CACHE_NAME
protected org.apache.jackrabbit.oak.spi.blob.stats.BlobStatsCollector	stats

Constructor Summary

Constructors

Constructor	Description
DataStoreBlobStore(DataStore delegate)
DataStoreBlobStore(DataStore delegate, boolean encodeLengthInId)
DataStoreBlobStore(DataStore delegate, boolean encodeLengthInId, int cacheSizeInMB)

Method Summary

Modifier and Type	Method	Description
void	addMetadataRecord(File f, String name)	Adds the root record.
void	addMetadataRecord(InputStream stream, String name)	Adds the root record.
DataRecord	addRecord(InputStream stream)
DataRecord	addRecord(InputStream input, org.apache.jackrabbit.oak.spi.blob.BlobOptions options)	Add a record with specified options.
void	addTracker(BlobTracker tracker)	Registers a tracker in the data store.
void	clearCache()
void	clearInUse()
void	close()
@Nullable org.apache.jackrabbit.oak.api.Blob	completeBlobUpload(@NotNull String uploadToken)
long	countDeleteChunks(List<String> chunkIds, long maxLastModifiedTime)
void	deleteAllMetadataRecords(String prefix)	Deletes all records matching the given prefix.
int	deleteAllOlderThan(long min)
boolean	deleteChunks(List<String> chunkIds, long maxLastModifiedTime)
boolean	deleteMetadataRecord(String name)	Deletes the root record represented by the given parameters.
protected String	extractBlobId(String encodedBlobId)
Iterator<String>	getAllChunkIds(long maxLastModifiedTime)
Iterator<DataIdentifier>	getAllIdentifiers()
List<DataRecord>	getAllMetadataRecords(String prefix)	Gets the all root records.
Iterator<DataRecord>	getAllRecords()	Retrieved an iterator over all DataRecords.
String	getBlobId(@NotNull String reference)
long	getBlobLength(String encodedBlobId)
long	getBlockSizeMin()
org.apache.jackrabbit.oak.cache.CacheStats	getCacheStats()
protected DataRecord	getDataRecord(String blobId)
DataStore	getDataStore()
@Nullable URI	getDownloadURI(@NotNull org.apache.jackrabbit.oak.api.Blob blob, @NotNull org.apache.jackrabbit.oak.api.blob.BlobDownloadOptions downloadOptions)
InputStream	getInputStream(String encodedBlobId)
DataRecord	getMetadataRecord(String name)	Retrieves the metadata record with the given name
int	getMinRecordLength()
DataRecord	getRecord(DataIdentifier identifier)
DataRecord	getRecordForId(DataIdentifier identifier)	Retrieves the record for the given identifier
DataRecord	getRecordFromReference(String reference)
DataRecord	getRecordIfStored(DataIdentifier identifier)
String	getReference(@NotNull String encodedBlobId)
String	getRepositoryId()	Returns the repository id (identifier for the repository in the DataStore)
protected InputStream	getStream(String blobId)
@Nullable BlobTracker	getTracker()	Gets the traker registered in the data store.
SharedDataStore.Type	getType()	Gets the type.
void	init(String homeDir)
@Nullable org.apache.jackrabbit.oak.api.blob.BlobUpload	initiateBlobUpload(long maxUploadSizeInBytes, int maxNumberOfURIs)
@Nullable org.apache.jackrabbit.oak.api.blob.BlobUpload	initiateBlobUpload(long maxUploadSizeInBytes, int maxNumberOfURIs, @NotNull org.apache.jackrabbit.oak.api.blob.BlobUploadOptions options)
boolean	metadataRecordExists(String name)	Checks if the metadata record with the name exists
int	readBlob(String encodedBlobId, long pos, byte[] buff, int off, int length)
Iterator<String>	resolveChunks(String blobId)
void	setBlobStatsCollector(org.apache.jackrabbit.oak.spi.blob.stats.BlobStatsCollector stats)
void	setBlockSize(int x)
void	setMaxCachedBinarySize(int maxCachedBinarySize)
void	setRepositoryId(String repositoryId)	Sets the repository id to identify repository in the DataStore
void	startMark()
int	sweep()
String	toString()
void	updateModifiedDateOnAccess(long before)
String	writeBlob(InputStream stream)
String	writeBlob(InputStream stream, org.apache.jackrabbit.oak.spi.blob.BlobOptions options)
String	writeBlob(String tempFileName)

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected final DataStore delegate

stats

protected org.apache.jackrabbit.oak.spi.blob.stats.BlobStatsCollector stats

cache

protected final org.apache.jackrabbit.guava.common.cache.LoadingCache<String,byte[]> cache

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

See Also:

• Constant Field Values

MEM_CACHE_NAME

public static final String MEM_CACHE_NAME

See Also:

• Constant Field Values

Constructor Details

DataStoreBlobStore

public DataStoreBlobStore(DataStore delegate)

DataStoreBlobStore

public DataStoreBlobStore(DataStore delegate,
 boolean encodeLengthInId)

DataStoreBlobStore

public DataStoreBlobStore(DataStore delegate,
 boolean encodeLengthInId,
 int cacheSizeInMB)

Method Details

getRecordIfStored

public DataRecord getRecordIfStored(DataIdentifier identifier)
                             throws DataStoreException

Specified by:

getRecordIfStored in interface DataStore

Throws:

DataStoreException

getRecord

public DataRecord getRecord(DataIdentifier identifier)
                     throws DataStoreException

Specified by:

getRecord in interface DataStore

Throws:

DataStoreException

getRecordFromReference

public DataRecord getRecordFromReference(String reference)
                                  throws DataStoreException

Specified by:

getRecordFromReference in interface DataStore

Throws:

DataStoreException

addRecord

public DataRecord addRecord(InputStream stream)
                     throws DataStoreException

Specified by:

addRecord in interface DataStore

Throws:

DataStoreException

updateModifiedDateOnAccess

public void updateModifiedDateOnAccess(long before)

Specified by:

updateModifiedDateOnAccess in interface DataStore

deleteAllOlderThan

public int deleteAllOlderThan(long min)
                       throws DataStoreException

Specified by:

deleteAllOlderThan in interface DataStore

Throws:

DataStoreException

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()
                                           throws DataStoreException

Specified by:

getAllIdentifiers in interface DataStore

Throws:

DataStoreException

init

public void init(String homeDir)
          throws RepositoryException

Specified by:

init in interface DataStore

Throws:

RepositoryException

getMinRecordLength

public int getMinRecordLength()

Specified by:

getMinRecordLength in interface DataStore

close

public void close()
           throws DataStoreException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataStore

Throws:

DataStoreException

writeBlob

public String writeBlob(InputStream stream)
                 throws IOException

Specified by:

writeBlob in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

Throws:

IOException

writeBlob

public String writeBlob(InputStream stream,
 org.apache.jackrabbit.oak.spi.blob.BlobOptions options)
                 throws IOException

Specified by:

writeBlob in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

Throws:

IOException

readBlob

public int readBlob(String encodedBlobId,
 long pos,
 byte[] buff,
 int off,
 int length)
             throws IOException

Specified by:

readBlob in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

Throws:

IOException

getBlobLength

public long getBlobLength(String encodedBlobId)
                   throws IOException

Specified by:

getBlobLength in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

Throws:

IOException

getBlobId

public String getBlobId(@NotNull
 @NotNull String reference)

Specified by:

getBlobId in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

getReference

public String getReference(@NotNull
 @NotNull String encodedBlobId)

Specified by:

getReference in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

getInputStream

public InputStream getInputStream(String encodedBlobId)
                           throws IOException

Specified by:

getInputStream in interface org.apache.jackrabbit.oak.spi.blob.BlobStore

Throws:

IOException

setBlockSize

public void setBlockSize(int x)

Specified by:

setBlockSize in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

writeBlob

public String writeBlob(String tempFileName)
                 throws IOException

Specified by:

writeBlob in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

IOException

sweep

public int sweep()
          throws IOException

Specified by:

sweep in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

IOException

startMark

public void startMark()
               throws IOException

Specified by:

startMark in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

IOException

clearInUse

public void clearInUse()

Specified by:

clearInUse in interface DataStore

Specified by:

clearInUse in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

clearCache

public void clearCache()

Specified by:

clearCache in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

getBlockSizeMin

public long getBlockSizeMin()

Specified by:

getBlockSizeMin in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

getAllChunkIds

public Iterator<String> getAllChunkIds(long maxLastModifiedTime)
                                throws Exception

Specified by:

getAllChunkIds in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

Exception

deleteChunks

public boolean deleteChunks(List<String> chunkIds,
 long maxLastModifiedTime)
                     throws Exception

Specified by:

deleteChunks in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

Exception

countDeleteChunks

public long countDeleteChunks(List<String> chunkIds,
 long maxLastModifiedTime)
                       throws Exception

Specified by:

countDeleteChunks in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

Exception

resolveChunks

public Iterator<String> resolveChunks(String blobId)
                               throws IOException

Specified by:

resolveChunks in interface org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore

Throws:

IOException

addMetadataRecord

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

Description copied from interface: SharedDataStore

Adds the root record.

Specified by:

addMetadataRecord in interface SharedDataStore

Parameters:

stream - the stream

name - the name of the root record

Throws:

DataStoreException - the data store exception

addMetadataRecord

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

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:

DataStoreException - the data store exception

getMetadataRecord

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

metadataRecordExists

public boolean metadataRecordExists(String name)

Description copied from interface: SharedDataStore

Checks if the metadata record with the name exists

Specified by:

metadataRecordExists in interface SharedDataStore

Returns:

getAllMetadataRecords

public List<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

setRepositoryId

public void setRepositoryId(String repositoryId)
                     throws DataStoreException

Description copied from interface: SharedDataStore

Sets the repository id to identify repository in the DataStore

Specified by:

setRepositoryId in interface SharedDataStore

Throws:

DataStoreException

getRepositoryId

public String getRepositoryId()

Description copied from interface: SharedDataStore

Returns the repository id (identifier for the repository in the DataStore)

Specified by:

getRepositoryId in interface SharedDataStore

Returns:

repository id

getAllRecords

public Iterator<DataRecord> getAllRecords()
                                   throws DataStoreException

Description copied from interface: SharedDataStore

Retrieved an iterator over all DataRecords.

Specified by:

getAllRecords in interface SharedDataStore

Returns:

iterator over DataRecords

Throws:

DataStoreException

getRecordForId

public DataRecord getRecordForId(DataIdentifier identifier)
                          throws DataStoreException

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:

DataStoreException

getType

public SharedDataStore.Type getType()

Description copied from interface: SharedDataStore

Gets the type.

Specified by:

getType in interface SharedDataStore

Returns:

the type

addRecord

public DataRecord addRecord(InputStream input,
 org.apache.jackrabbit.oak.spi.blob.BlobOptions options)
                     throws DataStoreException

Description copied from interface: TypedDataStore

Add a record with specified options.

Specified by:

addRecord in interface TypedDataStore

Returns:

Throws:

DataStoreException

toString

public String toString()

Overrides:

toString in class Object

getDataStore

public DataStore getDataStore()

getCacheStats

public org.apache.jackrabbit.oak.cache.CacheStats getCacheStats()

setMaxCachedBinarySize

public void setMaxCachedBinarySize(int maxCachedBinarySize)

setBlobStatsCollector

public void setBlobStatsCollector(org.apache.jackrabbit.oak.spi.blob.stats.BlobStatsCollector stats)

addTracker

public void addTracker(BlobTracker tracker)

Description copied from interface: BlobTrackingStore

Registers a tracker in the data store.

Specified by:

addTracker in interface BlobTrackingStore

getTracker

@Nullable
public @Nullable BlobTracker getTracker()

Description copied from interface: BlobTrackingStore

Gets the traker registered in the data store.

Specified by:

getTracker in interface BlobTrackingStore

Returns:

tracker

getStream

protected InputStream getStream(String blobId)
                         throws IOException

Throws:

IOException

getDataRecord

protected DataRecord getDataRecord(String blobId)
                            throws DataStoreException

Throws:

DataStoreException

extractBlobId

protected String extractBlobId(String encodedBlobId)

initiateBlobUpload

@Nullable
public @Nullable org.apache.jackrabbit.oak.api.blob.BlobUpload initiateBlobUpload(long maxUploadSizeInBytes,
 int maxNumberOfURIs)
                                                                           throws IllegalArgumentException

Specified by:

initiateBlobUpload in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider

Throws:

IllegalArgumentException

initiateBlobUpload

@Nullable
public @Nullable org.apache.jackrabbit.oak.api.blob.BlobUpload initiateBlobUpload(long maxUploadSizeInBytes,
 int maxNumberOfURIs,
 @NotNull
 @NotNull org.apache.jackrabbit.oak.api.blob.BlobUploadOptions options)
                                                                           throws IllegalArgumentException

Specified by:

initiateBlobUpload in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider

Throws:

IllegalArgumentException

completeBlobUpload

@Nullable
public @Nullable org.apache.jackrabbit.oak.api.Blob completeBlobUpload(@NotNull
 @NotNull String uploadToken)
                                                                throws IllegalArgumentException

Specified by:

completeBlobUpload in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider

Throws:

IllegalArgumentException

getDownloadURI

@Nullable
public @Nullable URI getDownloadURI(@NotNull
 @NotNull org.apache.jackrabbit.oak.api.Blob blob,
 @NotNull
 @NotNull org.apache.jackrabbit.oak.api.blob.BlobDownloadOptions downloadOptions)

Specified by:

getDownloadURI in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider