Package org.apache.jackrabbit.oak.spi.blob

Interface GarbageCollectableBlobStore

All Superinterfaces:

java.lang.AutoCloseable, BlobStore

All Known Implementing Classes:

AbstractBlobStore, CachingBlobStore, CloudBlobStore, DataStoreBlobStore, FileBlobStore, MemoryBlobStore, MongoBlobStore, RDBBlobStore

@ProviderType
public interface GarbageCollectableBlobStore
extends BlobStore

A blob store that supports garbage collection.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clear the cache.
void	clearInUse()	Clear all objects marked as "transiently in use".
long	countDeleteChunks(java.util.List<java.lang.String> chunkIds, long maxLastModifiedTime)	Deletes the blobs with the given ids.
boolean	deleteChunks(java.util.List<java.lang.String> chunkIds, long maxLastModifiedTime)	Deprecated.
java.util.Iterator<java.lang.String>	getAllChunkIds(long maxLastModifiedTime)	Gets all the identifiers.
long	getBlockSizeMin()	Get the minimum block size (if there is any).
java.util.Iterator<java.lang.String>	resolveChunks(java.lang.String blobId)	Resolve chunks stored in the blob store from the given Id.
void	setBlockSize(int x)	Set the block size used by this blob store, if the blob store splits binaries into blocks.
void	startMark()	Start the mark phase.
int	sweep()	Remove all unused blocks.
java.lang.String	writeBlob(java.lang.String tempFileName)	Write a blob from a temporary file.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.apache.jackrabbit.oak.spi.blob.BlobStore

getBlobId, getBlobLength, getInputStream, getReference, readBlob, writeBlob, writeBlob

Method Detail

setBlockSize

void setBlockSize(int x)

Set the block size used by this blob store, if the blob store splits binaries into blocks. If not, this setting is ignored.

Parameters:

x - the block size in bytes.

writeBlob

java.lang.String writeBlob(java.lang.String tempFileName)
                    throws java.io.IOException

Write a blob from a temporary file. The temporary file is removed afterwards. A file based blob stores might simply rename the file, so that no additional writes are necessary.

Parameters:

tempFileName - the temporary file name

Returns:

the blob id

Throws:

java.io.IOException

sweep

int sweep()
   throws java.io.IOException

Remove all unused blocks.

Returns:

the number of removed blocks

Throws:

java.io.IOException

startMark

void startMark()
        throws java.io.IOException

Start the mark phase.

Throws:

java.io.IOException

clearInUse

void clearInUse()

Clear all objects marked as "transiently in use".

clearCache

void clearCache()

Clear the cache.

getBlockSizeMin

long getBlockSizeMin()

Get the minimum block size (if there is any).

Returns:

the block size

getAllChunkIds

java.util.Iterator<java.lang.String> getAllChunkIds(long maxLastModifiedTime)
                                             throws java.lang.Exception

Gets all the identifiers.

Parameters:

maxLastModifiedTime - the max last modified time to consider for retrieval, with the special value '0' meaning no filtering by time

Returns:

the identifiers

Throws:

java.lang.Exception - the exception

deleteChunks

@Deprecated
boolean deleteChunks(java.util.List<java.lang.String> chunkIds,
                     long maxLastModifiedTime)
              throws java.lang.Exception

Deprecated.

Deletes the blobs with the given ids.

Parameters:

chunkIds - the chunk ids

maxLastModifiedTime - the max last modified time to consider for retrieval, with the special value '0' meaning no filtering by time

Returns:

true, if successful

Throws:

java.lang.Exception - the exception

countDeleteChunks

long countDeleteChunks(java.util.List<java.lang.String> chunkIds,
                       long maxLastModifiedTime)
                throws java.lang.Exception

Deletes the blobs with the given ids.

Parameters:

chunkIds - the chunk ids

maxLastModifiedTime - the max last modified time to consider for retrieval, with the special value '0' meaning no filtering by time

Returns:

long the count of successful deletions

Throws:

java.lang.Exception - the exception

resolveChunks

java.util.Iterator<java.lang.String> resolveChunks(java.lang.String blobId)
                                            throws java.io.IOException

Resolve chunks stored in the blob store from the given Id. This will not return any chunks stored in-line in the id.

Parameters:

blobId - the blob id

Returns:

the iterator

Throws:

java.io.IOException - Signals that an I/O exception has occurred.