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

Class FileBlobStore

java.lang.Object

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

org.apache.jackrabbit.oak.spi.blob.FileBlobStore

All Implemented Interfaces:

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

public class FileBlobStore
extends AbstractBlobStore

A file blob store.

Nested Class Summary

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

AbstractBlobStore.BlockId, AbstractBlobStore.Data

Constructor Summary

Constructors

Constructor	Description
FileBlobStore(String dir)

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clear the cache.
long	countDeleteChunks(List<String> chunkIds, long maxLastModifiedTime)	Deletes the blobs with the given ids.
Iterator<String>	getAllChunkIds(long maxLastModifiedTime)	Gets all the identifiers.
void	startMark()	Start the mark phase.
int	sweep()	Remove all unused blocks.
String	writeBlob(String tempFilePath)	Write a blob from a temporary file.

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

clearInUse, close, deleteChunks, getBlobId, getBlobLength, getBlockSize, getBlockSizeMin, getInputStream, getReference, load, readBlob, resolveChunks, setBlockSize, setBlockSizeMin, setReferenceKey, setReferenceKeyEncoded, setReferenceKeyPlainText, setStatsCollector, writeBlob, writeBlob

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBlobStore

public FileBlobStore(String dir)

Method Detail

writeBlob

public String writeBlob(String tempFilePath)
                 throws IOException

Description copied from interface: GarbageCollectableBlobStore

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.

Specified by:

writeBlob in interface GarbageCollectableBlobStore

Overrides:

writeBlob in class AbstractBlobStore

Parameters:

tempFilePath - the temporary file name

Returns:

the blob id

Throws:

IOException

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

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.

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.

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

clearCache

public void clearCache()

Description copied from interface: GarbageCollectableBlobStore

Clear the cache.