org.apache.jackrabbit.oak.plugins.blob.cloud

Class CloudBlobStore

java.lang.Object

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

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

org.apache.jackrabbit.oak.plugins.blob.cloud.CloudBlobStore

All Implemented Interfaces:

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

public class CloudBlobStore
extends CachingBlobStore

Implementation of the BlobStore to store blobs in a cloud blob store.

Extends AbstractBlobStore and breaks the the binary to chunks for easier management.

Nested Class Summary

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

AbstractBlobStore.BlockId, AbstractBlobStore.Data

Field Summary

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
CloudBlobStore()

Method Summary

Modifier and Type	Method and Description
long	countDeleteChunks(java.util.List<java.lang.String> chunkIds, long maxLastModifiedTime) Deletes the blobs with the given ids.
void	deleteBucket() Delete the cloud container and all its contents.
java.lang.String	getAccessKey()
java.util.Iterator<java.lang.String>	getAllChunkIds(long maxLastModifiedTime) Gets all the identifiers.
protected java.lang.String	getCloudContainer()
java.lang.String	getCloudProvider()
java.lang.String	getSecretKey()
void	init() Instantiates a connection to the cloud blob store.
protected boolean	isMarkEnabled()
protected void	mark(AbstractBlobStore.BlockId id)
protected byte[]	readBlockFromBackend(AbstractBlobStore.BlockId blockId) Reads the data from the actual cloud service.
void	setAccessKey(java.lang.String accessKey)
void	setCloudContainer(java.lang.String cloudContainer)
void	setCloudProvider(java.lang.String cloudProvider)
void	setSecretKey(java.lang.String secretKey)
void	startMark() Start the mark phase.
protected void	storeBlock(byte[] digest, int level, byte[] data) Uploads the block to the cloud service.
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, close, 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudBlobStore

public CloudBlobStore()

Method Detail

getCloudContainer

protected java.lang.String getCloudContainer()

setCloudContainer

public void setCloudContainer(java.lang.String cloudContainer)

getAccessKey

public java.lang.String getAccessKey()

setAccessKey

public void setAccessKey(java.lang.String accessKey)

getSecretKey

public java.lang.String getSecretKey()

setSecretKey

public void setSecretKey(java.lang.String secretKey)

getCloudProvider

public java.lang.String getCloudProvider()

setCloudProvider

public void setCloudProvider(java.lang.String cloudProvider)

init

public void init()
          throws java.lang.Exception

Instantiates a connection to the cloud blob store.

Throws:

java.lang.Exception - if an error occurs

storeBlock

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

Uploads the block to the cloud service.

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:

java.io.IOException

readBlockFromBackend

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

Reads the data from the actual cloud service.

Specified by:

readBlockFromBackend in class AbstractBlobStore

Parameters:

blockId - the block id

Returns:

the block data, or null

Throws:

java.lang.Exception

deleteBucket

public void deleteBucket()

Delete the cloud container and all its contents.

startMark

public void startMark()
               throws java.io.IOException

Description copied from interface: GarbageCollectableBlobStore

Start the mark phase.

Specified by:

startMark in interface GarbageCollectableBlobStore

Specified by:

startMark in class AbstractBlobStore

Throws:

java.io.IOException

mark

protected void mark(AbstractBlobStore.BlockId id)
             throws java.lang.Exception

Specified by:

mark in class AbstractBlobStore

Throws:

java.lang.Exception

sweep

public int sweep()
          throws java.io.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:

java.io.IOException

isMarkEnabled

protected boolean isMarkEnabled()

Specified by:

isMarkEnabled in class AbstractBlobStore

getAllChunkIds

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

Description copied from interface: GarbageCollectableBlobStore

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

countDeleteChunks

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

Description copied from interface: GarbageCollectableBlobStore

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