public class DataStoreBlobStore extends Object implements DataStore, BlobStore, GarbageCollectableBlobStore, BlobTrackingStore, TypedDataStore, org.apache.jackrabbit.oak.api.blob.BlobAccessProvider
DataStore.getMinRecordLength()
Modifier and Type | Class and Description |
---|---|
static class |
DataStoreBlobStore.BlobId |
SharedDataStore.Type
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_CACHE_SIZE |
static String |
MEM_CACHE_NAME |
Constructor and Description |
---|
DataStoreBlobStore(DataStore delegate) |
DataStoreBlobStore(DataStore delegate,
boolean encodeLengthInId) |
DataStoreBlobStore(DataStore delegate,
boolean encodeLengthInId,
int cacheSizeInMB) |
Modifier and Type | Method and 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)
Creates a new data record.
|
DataRecord |
addRecord(InputStream input,
BlobOptions options)
Add a record with specified options.
|
void |
addTracker(BlobTracker tracker)
Registers a tracker in the data store.
|
void |
clearCache()
Clear the cache.
|
void |
clearInUse()
Clear the in-use list.
|
void |
close()
Close the data store
|
@Nullable Blob |
completeBlobUpload(@NotNull String uploadToken) |
long |
countDeleteChunks(List<String> chunkIds,
long maxLastModifiedTime)
Deletes the blobs with the given ids.
|
void |
deleteAllMetadataRecords(String prefix)
Deletes all records matching the given prefix.
|
int |
deleteAllOlderThan(long min)
Delete objects that have a modified date older than the specified date.
|
boolean |
deleteChunks(List<String> chunkIds,
long maxLastModifiedTime)
Deletes the blobs with the given ids.
|
boolean |
deleteMetadataRecord(String name)
Deletes the root record represented by the given parameters.
|
Iterator<String> |
getAllChunkIds(long maxLastModifiedTime)
Gets all the identifiers.
|
Iterator<DataIdentifier> |
getAllIdentifiers()
Get all identifiers.
|
List<DataRecord> |
getAllMetadataRecords(String prefix)
Gets the all root records.
|
Iterator<DataRecord> |
getAllRecords()
Retrieved an iterator over all DataRecords.
|
String |
getBlobId(@NotNull String reference)
Returns the blobId that referred by the given binary reference.
|
long |
getBlobLength(String encodedBlobId)
Get the length of the blob.
|
long |
getBlockSizeMin()
Get the minimum block size (if there is any).
|
CacheStats |
getCacheStats() |
DataStore |
getDataStore() |
@Nullable URI |
getDownloadURI(@NotNull Blob blob,
@NotNull org.apache.jackrabbit.oak.api.blob.BlobDownloadOptions downloadOptions) |
InputStream |
getInputStream(String encodedBlobId)
Returns a new stream for given blobId.
|
DataRecord |
getMetadataRecord(String name)
Retrieves the metadata record with the given name
|
int |
getMinRecordLength()
Get the minimum size of an object that should be stored in this data store.
|
DataRecord |
getRecord(DataIdentifier identifier)
Returns the identified data record.
|
DataRecord |
getRecordForId(DataIdentifier identifier)
Retrieves the record for the given identifier
|
DataRecord |
getRecordFromReference(String reference)
Returns the record that matches the given binary reference.
|
DataRecord |
getRecordIfStored(DataIdentifier identifier)
Check if a record for the given identifier exists, and return it if yes.
|
String |
getReference(@NotNull String encodedBlobId)
Returns a secure reference to blob referred by blobid, or
null if no such
reference is available. |
String |
getRepositoryId()
Returns the repository id (identifier for the repository in the DataStore)
|
@Nullable BlobTracker |
getTracker()
Gets the traker registered in the data store.
|
SharedDataStore.Type |
getType()
Gets the type.
|
void |
init(String homeDir)
Initialized the data store
|
@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)
Read a number of bytes from a blob.
|
Iterator<String> |
resolveChunks(String blobId)
Resolve chunks stored in the blob store from the given Id.
|
void |
setBlobStatsCollector(BlobStatsCollector stats) |
void |
setBlockSize(int x)
Set the block size used by this blob store, if the blob store splits
binaries into blocks.
|
void |
setMaxCachedBinarySize(int maxCachedBinarySize) |
void |
setRepositoryId(String repositoryId)
Sets the repository id to identify repository in the DataStore
|
void |
startMark()
Start the mark phase.
|
int |
sweep()
Remove all unused blocks.
|
String |
toString() |
void |
updateModifiedDateOnAccess(long before)
From now on, update the modified date of an object even when accessing it.
|
String |
writeBlob(InputStream stream)
Write a blob from an input stream.
|
String |
writeBlob(InputStream stream,
BlobOptions options)
Write a blob from an input stream with specified options.
|
String |
writeBlob(String tempFileName)
Write a blob from a temporary file.
|
public static final int DEFAULT_CACHE_SIZE
public static final String MEM_CACHE_NAME
public DataStoreBlobStore(DataStore delegate)
public DataStoreBlobStore(DataStore delegate, boolean encodeLengthInId)
public DataStoreBlobStore(DataStore delegate, boolean encodeLengthInId, int cacheSizeInMB)
public DataRecord getRecordIfStored(DataIdentifier identifier) throws DataStoreException
DataStore
getRecordIfStored
in interface DataStore
identifier
- data identifierDataStoreException
- if the data store could not be accessedpublic DataRecord getRecord(DataIdentifier identifier) throws DataStoreException
DataStore
getRecord
in interface DataStore
identifier
- data identifierDataStoreException
- if the data store could not be accessed,
or if the given identifier is invalidpublic DataRecord getRecordFromReference(String reference) throws DataStoreException
DataStore
null
if the reference is invalid, for example if it
points to a record that does not exist.getRecordFromReference
in interface DataStore
reference
- binary referencenull
DataStoreException
- if the data store could not be accessedpublic DataRecord addRecord(InputStream stream) throws DataStoreException
DataStore
The given stream is consumed and not closed by this method. It is the responsibility of the caller to close the stream. A typical call pattern would be:
InputStream stream = ...; try { record = store.addRecord(stream); } finally { stream.close(); }
addRecord
in interface DataStore
stream
- binary streamDataStoreException
- if the data store could not be accessedpublic void updateModifiedDateOnAccess(long before)
DataStore
updateModifiedDateOnAccess
in interface DataStore
before
- - update the modified date to the current time if it is older than this valuepublic int deleteAllOlderThan(long min) throws DataStoreException
DataStore
deleteAllOlderThan
in interface DataStore
min
- the minimum timeDataStoreException
public Iterator<DataIdentifier> getAllIdentifiers() throws DataStoreException
DataStore
getAllIdentifiers
in interface DataStore
DataStoreException
- if the list could not be readpublic void init(String homeDir) throws RepositoryException
DataStore
init
in interface DataStore
homeDir
- the home directory of the repositoryRepositoryException
public int getMinRecordLength()
DataStore
getMinRecordLength
in interface DataStore
public void close() throws DataStoreException
DataStore
close
in interface AutoCloseable
close
in interface DataStore
DataStoreException
- if a problem occurredpublic String writeBlob(InputStream stream) throws IOException
BlobStore
writeBlob
in interface BlobStore
stream
- the input streamIOException
public String writeBlob(InputStream stream, BlobOptions options) throws IOException
BlobStore
writeBlob
in interface BlobStore
stream
- the input stream to writeoptions
- the options to useIOException
public int readBlob(String encodedBlobId, long pos, byte[] buff, int off, int length) throws IOException
BlobStore
readBlob
in interface BlobStore
encodedBlobId
- the blob idpos
- the position within the blobbuff
- the target byte arrayoff
- the offset within the target arraylength
- the number of bytes to readIOException
public long getBlobLength(String encodedBlobId) throws IOException
BlobStore
getBlobLength
in interface BlobStore
encodedBlobId
- the blob idIOException
public String getBlobId(@NotNull @NotNull String reference)
BlobStore
null
if the reference is invalid, for example if it
points to a blob that does not exist.public String getReference(@NotNull @NotNull String encodedBlobId)
BlobStore
null
if no such
reference is available.getReference
in interface BlobStore
encodedBlobId
- blobId referring the blob for which reference is requirednull
public InputStream getInputStream(String encodedBlobId) throws IOException
BlobStore
read
return the same sequence of bytes as long as neither call throws
an exception.getInputStream
in interface BlobStore
encodedBlobId
- the blob idIOException
public void setBlockSize(int x)
GarbageCollectableBlobStore
setBlockSize
in interface GarbageCollectableBlobStore
x
- the block size in bytes.public String writeBlob(String tempFileName) throws IOException
GarbageCollectableBlobStore
writeBlob
in interface GarbageCollectableBlobStore
tempFileName
- the temporary file nameIOException
public int sweep() throws IOException
GarbageCollectableBlobStore
sweep
in interface GarbageCollectableBlobStore
IOException
public void startMark() throws IOException
GarbageCollectableBlobStore
startMark
in interface GarbageCollectableBlobStore
IOException
public void clearInUse()
DataStore
clearInUse
in interface DataStore
clearInUse
in interface GarbageCollectableBlobStore
public void clearCache()
GarbageCollectableBlobStore
clearCache
in interface GarbageCollectableBlobStore
public long getBlockSizeMin()
GarbageCollectableBlobStore
getBlockSizeMin
in interface GarbageCollectableBlobStore
public Iterator<String> getAllChunkIds(long maxLastModifiedTime) throws Exception
GarbageCollectableBlobStore
getAllChunkIds
in interface GarbageCollectableBlobStore
maxLastModifiedTime
- the max last modified time to consider for retrieval,
with the special value '0' meaning no filtering by timeException
- the exceptionpublic boolean deleteChunks(List<String> chunkIds, long maxLastModifiedTime) throws Exception
GarbageCollectableBlobStore
deleteChunks
in interface GarbageCollectableBlobStore
chunkIds
- the chunk idsmaxLastModifiedTime
- the max last modified time to consider for retrieval,
with the special value '0' meaning no filtering by timeException
- the exceptionpublic long countDeleteChunks(List<String> chunkIds, long maxLastModifiedTime) throws Exception
GarbageCollectableBlobStore
countDeleteChunks
in interface GarbageCollectableBlobStore
chunkIds
- the chunk idsmaxLastModifiedTime
- the max last modified time to consider for retrieval,
with the special value '0' meaning no filtering by timeException
- the exceptionpublic Iterator<String> resolveChunks(String blobId) throws IOException
GarbageCollectableBlobStore
resolveChunks
in interface GarbageCollectableBlobStore
blobId
- the blob idIOException
- Signals that an I/O exception has occurred.public void addMetadataRecord(InputStream stream, String name) throws DataStoreException
SharedDataStore
addMetadataRecord
in interface SharedDataStore
stream
- the streamname
- the name of the root recordDataStoreException
- the data store exceptionpublic void addMetadataRecord(File f, String name) throws DataStoreException
SharedDataStore
addMetadataRecord
in interface SharedDataStore
f
- the filename
- the name of the root recordDataStoreException
- the data store exceptionpublic DataRecord getMetadataRecord(String name)
SharedDataStore
getMetadataRecord
in interface SharedDataStore
name
- the name of the recordpublic boolean metadataRecordExists(String name)
SharedDataStore
metadataRecordExists
in interface SharedDataStore
public List<DataRecord> getAllMetadataRecords(String prefix)
SharedDataStore
getAllMetadataRecords
in interface SharedDataStore
public boolean deleteMetadataRecord(String name)
SharedDataStore
deleteMetadataRecord
in interface SharedDataStore
name
- the name of the root recordpublic void deleteAllMetadataRecords(String prefix)
SharedDataStore
deleteAllMetadataRecords
in interface SharedDataStore
prefix
- metadata type identifierpublic void setRepositoryId(String repositoryId) throws DataStoreException
SharedDataStore
setRepositoryId
in interface SharedDataStore
DataStoreException
public String getRepositoryId()
SharedDataStore
getRepositoryId
in interface SharedDataStore
public Iterator<DataRecord> getAllRecords() throws DataStoreException
SharedDataStore
getAllRecords
in interface SharedDataStore
DataStoreException
public DataRecord getRecordForId(DataIdentifier identifier) throws DataStoreException
SharedDataStore
getRecordForId
in interface SharedDataStore
identifier
- the if of the recordDataStoreException
public SharedDataStore.Type getType()
SharedDataStore
getType
in interface SharedDataStore
public DataRecord addRecord(InputStream input, BlobOptions options) throws DataStoreException
TypedDataStore
addRecord
in interface TypedDataStore
DataStoreException
public DataStore getDataStore()
public CacheStats getCacheStats()
public void setMaxCachedBinarySize(int maxCachedBinarySize)
public void setBlobStatsCollector(BlobStatsCollector stats)
public void addTracker(BlobTracker tracker)
BlobTrackingStore
addTracker
in interface BlobTrackingStore
@Nullable public @Nullable BlobTracker getTracker()
BlobTrackingStore
getTracker
in interface BlobTrackingStore
@Nullable public @Nullable org.apache.jackrabbit.oak.api.blob.BlobUpload initiateBlobUpload(long maxUploadSizeInBytes, int maxNumberOfURIs) throws IllegalArgumentException
initiateBlobUpload
in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider
IllegalArgumentException
@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
IllegalArgumentException
@Nullable public @Nullable Blob completeBlobUpload(@NotNull @NotNull String uploadToken) throws IllegalArgumentException
completeBlobUpload
in interface org.apache.jackrabbit.oak.api.blob.BlobAccessProvider
IllegalArgumentException
Copyright © 2010 - 2020 Adobe. All Rights Reserved