org.apache.jackrabbit.oak.plugins.document.rdb

Class RDBBlobStore

java.lang.Object

org.apache.jackrabbit.oak.spi.blob.AbstractBlobStore

org.apache.jackrabbit.oak.plugins.blob.CachingBlobStore

org.apache.jackrabbit.oak.plugins.document.rdb.RDBBlobStore

All Implemented Interfaces:

Closeable, AutoCloseable, Cache.Backend<AbstractBlobStore.BlockId,AbstractBlobStore.Data>, BlobStore, GarbageCollectableBlobStore

public class RDBBlobStore
extends CachingBlobStore
implements Closeable

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.spi.blob.AbstractBlobStore

AbstractBlobStore.BlockId, AbstractBlobStore.Data

Field Summary

Fields

Modifier and Type	Field and Description
protected RDBConnectionHandler	ch
protected static int	IDSIZE
protected String	tnData
protected String	tnMeta

Fields inherited from class org.apache.jackrabbit.oak.plugins.blob.CachingBlobStore

blobCacheSize, cache, DEFAULT_CACHE_SIZE, MEM_CACHE_NAME

Fields inherited from class org.apache.jackrabbit.oak.spi.blob.AbstractBlobStore

BLOCK_SIZE_LIMIT, HASH_ALGORITHM, inUse, TYPE_DATA, TYPE_HASH

Constructor Summary

Constructors

Constructor and Description
RDBBlobStore(@NotNull DataSource ds) Creates a RDBBlobStore instance using the provided DataSource using default DocumentNodeStoreBuilder and RDBOptions.
RDBBlobStore(@NotNull DataSource ds, @Nullable DocumentNodeStoreBuilder<?> builder, @Nullable RDBOptions options) Creates a RDBBlobStore instance using the provided DataSource using the given DocumentNodeStoreBuilder and RDBOptions.
RDBBlobStore(@NotNull DataSource ds, @Nullable RDBOptions options) Creates a RDBBlobStore instance using the provided DataSource using default DocumentNodeStoreBuilder and the given RDBOptions.

Method Summary

Modifier and Type	Method and Description
void	close()
long	countDeleteChunks(List<String> chunkIds, long maxLastModifiedTime) Deletes the blobs with the given ids.
protected void	finalize()
Iterator<String>	getAllChunkIds(long maxLastModifiedTime) Gets all the identifiers.
protected boolean	isMarkEnabled()
protected void	mark(AbstractBlobStore.BlockId blockId)
protected byte[]	readBlockFromBackend(AbstractBlobStore.BlockId blockId) Load the block from the storage backend.
protected byte[]	readBlockFromBackend(byte[] digest)
void	startMark() Start the mark phase.
protected void	storeBlock(byte[] digest, int level, byte[] data) Store a block of data.
int	sweep() Remove all unused blocks.

Methods inherited from class org.apache.jackrabbit.oak.plugins.blob.CachingBlobStore

clearCache, getBlobCacheSize, getCacheStats

Methods inherited from class org.apache.jackrabbit.oak.spi.blob.AbstractBlobStore

clearInUse, deleteChunks, getBlobId, getBlobLength, getBlockSize, getBlockSizeMin, getInputStream, getOrCreateReferenceKey, getReference, getStatsCollector, load, mark, markInUse, readBlob, resolveChunks, setBlockSize, setBlockSizeMin, setReferenceKey, setReferenceKeyEncoded, setReferenceKeyPlainText, setStatsCollector, usesBlobId, writeBlob, writeBlob, writeBlob

Methods inherited from class java.lang.Object

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

Field Detail

IDSIZE

protected static final int IDSIZE

ch

protected RDBConnectionHandler ch

tnData

protected String tnData

tnMeta

protected String tnMeta

Constructor Detail

RDBBlobStore

public RDBBlobStore(@NotNull
                    @NotNull DataSource ds,
                    @Nullable
                    @Nullable DocumentNodeStoreBuilder<?> builder,
                    @Nullable
                    @Nullable RDBOptions options)

Creates a RDBBlobStore instance using the provided DataSource using the given DocumentNodeStoreBuilder and RDBOptions.

RDBBlobStore

public RDBBlobStore(@NotNull
                    @NotNull DataSource ds,
                    @Nullable
                    @Nullable RDBOptions options)

Creates a RDBBlobStore instance using the provided DataSource using default DocumentNodeStoreBuilder and the given RDBOptions.

RDBBlobStore

public RDBBlobStore(@NotNull
                    @NotNull DataSource ds)

Creates a RDBBlobStore instance using the provided DataSource using default DocumentNodeStoreBuilder and RDBOptions.

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractBlobStore

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

storeBlock

protected void storeBlock(byte[] digest,
                          int level,
                          byte[] data)
                   throws IOException

Description copied from class: AbstractBlobStore

Store a block of data.

Specified by:

storeBlock in class AbstractBlobStore

Parameters:

digest - the content hash (32 bytes)

level - the indirection level (0 is for user data, 1 is a list of digests that point to user data, 2 is a list of digests that point to digests, and so on). This parameter is for informational use only, and it is not required to store it unless that's easy to achieve

data - the data to be stored (the number of bytes is at most the block size)

Throws:

IOException

readBlockFromBackend

protected byte[] readBlockFromBackend(byte[] digest)
                               throws Exception

Throws:

Exception

readBlockFromBackend

protected byte[] readBlockFromBackend(AbstractBlobStore.BlockId blockId)
                               throws Exception

Description copied from class: AbstractBlobStore

Load the block from the storage backend. Returns null if the block was not found.

Specified by:

readBlockFromBackend in class AbstractBlobStore

Parameters:

blockId - the block id

Returns:

the block data, or null

Throws:

Exception

startMark

public void startMark()
               throws IOException

Description copied from interface: GarbageCollectableBlobStore

Start the mark phase.

Specified by:

startMark in interface GarbageCollectableBlobStore

Specified by:

startMark in class AbstractBlobStore

Throws:

IOException

isMarkEnabled

protected boolean isMarkEnabled()

Specified by:

isMarkEnabled in class AbstractBlobStore

mark

protected void mark(AbstractBlobStore.BlockId blockId)
             throws Exception

Specified by:

mark in class AbstractBlobStore

Throws:

Exception

sweep

public int sweep()
          throws IOException

Description copied from interface: GarbageCollectableBlobStore

Remove all unused blocks.

Specified by:

sweep in interface GarbageCollectableBlobStore

Specified by:

sweep in class AbstractBlobStore

Returns:

the number of removed blocks

Throws:

IOException

countDeleteChunks

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

Description copied from interface: GarbageCollectableBlobStore

Deletes the blobs with the given ids.

Specified by:

countDeleteChunks in interface GarbageCollectableBlobStore

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:

Exception - the exception

getAllChunkIds

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

Description copied from interface: GarbageCollectableBlobStore

Gets all the identifiers.

Specified by:

getAllChunkIds in interface GarbageCollectableBlobStore

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:

Exception - the exception