org.apache.jackrabbit.oak.segment.file

Class FileStoreBuilder

java.lang.Object

org.apache.jackrabbit.oak.segment.file.FileStoreBuilder

public class FileStoreBuilder
extends Object

Builder for creating FileStore instances.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_FILE_SIZE

Method Summary

Modifier and Type	Method and Description
FileStore	build() Create a new FileStore instance with the settings specified in this builder.
ReadOnlyFileStore	buildReadOnly() Create a new ReadOnlyFileStore instance with the settings specified in this builder.
static FileStoreBuilder	fileStoreBuilder(File directory) Create a new instance of a FileStoreBuilder for a file store.
int	getMaxFileSize()
String	toString()
FileStoreBuilder	withBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore) Specify the BlobStore.
FileStoreBuilder	withDefaultMemoryMapping() Set memory mapping to the default value based on OS properties
FileStoreBuilder	withGCMonitor(org.apache.jackrabbit.oak.spi.gc.GCMonitor gcMonitor) GCMonitor for monitoring this files store's gc process.
FileStoreBuilder	withGCOptions(SegmentGCOptions gcOptions) SegmentGCOptions the garbage collection options of the store
FileStoreBuilder	withMaxFileSize(int maxFileSize) Maximal size of the generated tar files in MB.
FileStoreBuilder	withMemoryMapping(boolean memoryMapping) Turn memory mapping on or off
FileStoreBuilder	withNodeDeduplicationCacheSize(int nodeDeduplicationCacheSize) Number of items to keep in the node deduplication cache
FileStoreBuilder	withSegmentCacheSize(int segmentCacheSize) Size of the segment cache in MB.
FileStoreBuilder	withSnfeListener(SegmentNotFoundExceptionListener snfeListener) SegmentNotFoundExceptionListener listener for SegmentNotFoundException
FileStoreBuilder	withStatisticsProvider(org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider) StatisticsProvider for collecting statistics related to FileStore
FileStoreBuilder	withStringCacheSize(int stringCacheSize) Size of the string cache in MB.
FileStoreBuilder	withStringDeduplicationCacheSize(int stringDeduplicationCacheSize) Number of items to keep in the string deduplication cache
FileStoreBuilder	withTemplateCacheSize(int templateCacheSize) Size of the template cache in MB.
FileStoreBuilder	withTemplateDeduplicationCacheSize(int templateDeduplicationCacheSize) Number of items to keep in the template deduplication cache

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_FILE_SIZE

public static final int DEFAULT_MAX_FILE_SIZE

See Also:

Constant Field Values

Method Detail

fileStoreBuilder

@Nonnull
public static FileStoreBuilder fileStoreBuilder(@Nonnull
                                                         File directory)

Create a new instance of a FileStoreBuilder for a file store.

Parameters:

directory - directory where the tar files are stored

Returns:

a new FileStoreBuilder instance.

withBlobStore

@Nonnull
public FileStoreBuilder withBlobStore(@Nonnull
                                               org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)

Specify the BlobStore.

Parameters:

blobStore -

Returns:

this instance

withMaxFileSize

@Nonnull
public FileStoreBuilder withMaxFileSize(int maxFileSize)

Maximal size of the generated tar files in MB.

Parameters:

maxFileSize -

Returns:

this instance

withSegmentCacheSize

@Nonnull
public FileStoreBuilder withSegmentCacheSize(int segmentCacheSize)

Size of the segment cache in MB.

Parameters:

segmentCacheSize - None negative cache size

Returns:

this instance

withStringCacheSize

@Nonnull
public FileStoreBuilder withStringCacheSize(int stringCacheSize)

Size of the string cache in MB.

Parameters:

stringCacheSize - None negative cache size

Returns:

this instance

withTemplateCacheSize

@Nonnull
public FileStoreBuilder withTemplateCacheSize(int templateCacheSize)

Size of the template cache in MB.

Parameters:

templateCacheSize - None negative cache size

Returns:

this instance

withStringDeduplicationCacheSize

@Nonnull
public FileStoreBuilder withStringDeduplicationCacheSize(int stringDeduplicationCacheSize)

Number of items to keep in the string deduplication cache

Parameters:

stringDeduplicationCacheSize - None negative cache size

Returns:

this instance

withTemplateDeduplicationCacheSize

@Nonnull
public FileStoreBuilder withTemplateDeduplicationCacheSize(int templateDeduplicationCacheSize)

Number of items to keep in the template deduplication cache

Parameters:

templateDeduplicationCacheSize - None negative cache size

Returns:

this instance

withNodeDeduplicationCacheSize

@Nonnull
public FileStoreBuilder withNodeDeduplicationCacheSize(int nodeDeduplicationCacheSize)

Number of items to keep in the node deduplication cache

Parameters:

nodeDeduplicationCacheSize - None negative cache size. Must be a power of 2.

Returns:

this instance

withMemoryMapping

@Nonnull
public FileStoreBuilder withMemoryMapping(boolean memoryMapping)

Turn memory mapping on or off

Parameters:

memoryMapping -

Returns:

this instance

withDefaultMemoryMapping

@Nonnull
public FileStoreBuilder withDefaultMemoryMapping()

Set memory mapping to the default value based on OS properties

Returns:

this instance

withGCMonitor

@Nonnull
public FileStoreBuilder withGCMonitor(@Nonnull
                                               org.apache.jackrabbit.oak.spi.gc.GCMonitor gcMonitor)

GCMonitor for monitoring this files store's gc process.

Parameters:

gcMonitor -

Returns:

this instance

withStatisticsProvider

@Nonnull
public FileStoreBuilder withStatisticsProvider(@Nonnull
                                                        org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider)

StatisticsProvider for collecting statistics related to FileStore

Parameters:

statisticsProvider -

Returns:

this instance

withGCOptions

@Nonnull
public FileStoreBuilder withGCOptions(SegmentGCOptions gcOptions)

SegmentGCOptions the garbage collection options of the store

Parameters:

gcOptions -

Returns:

this instance

withSnfeListener

@Nonnull
public FileStoreBuilder withSnfeListener(@Nonnull
                                                  SegmentNotFoundExceptionListener snfeListener)

SegmentNotFoundExceptionListener listener for SegmentNotFoundException

Parameters:

snfeListener, - the actual listener

Returns:

this instance

build

@Nonnull
public FileStore build()
                         throws InvalidFileStoreVersionException,
                                IOException

Create a new FileStore instance with the settings specified in this builder. If none of the with methods have been called before calling this method, a file store with the following default settings is returned:

• blob store: inline
• max file size: 256MB
• cache size: 256MB
• memory mapping: on for 64 bit JVMs off otherwise
• whiteboard: none. No GCMonitor tracking
• statsProvider: StatisticsProvider.NOOP
• GC options: SegmentGCOptions.defaultGCOptions()

Returns:

a new file store instance

Throws:

IOException

InvalidFileStoreVersionException

buildReadOnly

@Nonnull
public ReadOnlyFileStore buildReadOnly()
                                         throws InvalidFileStoreVersionException,
                                                IOException

Create a new ReadOnlyFileStore instance with the settings specified in this builder. If none of the with methods have been called before calling this method, a file store with the following default settings is returned:

• blob store: inline
• max file size: 256MB
• cache size: 256MB
• memory mapping: on for 64 bit JVMs off otherwise
• whiteboard: none. No GCMonitor tracking
• statsProvider: StatisticsProvider.NOOP
• GC options: SegmentGCOptions.defaultGCOptions()

Returns:

a new file store instance

Throws:

IOException

InvalidFileStoreVersionException

getMaxFileSize

public int getMaxFileSize()

toString

public String toString()

Overrides:

toString in class Object