org.apache.jackrabbit.oak.plugins.segment

Class SegmentNodeStoreService

java.lang.Object

org.apache.jackrabbit.oak.spi.state.ProxyNodeStore

org.apache.jackrabbit.oak.plugins.segment.SegmentNodeStoreService

All Implemented Interfaces:

SegmentStoreProvider, org.apache.jackrabbit.oak.spi.commit.Observable, org.apache.jackrabbit.oak.spi.state.NodeStore

public class SegmentNodeStoreService
extends org.apache.jackrabbit.oak.spi.state.ProxyNodeStore
implements org.apache.jackrabbit.oak.spi.commit.Observable, SegmentStoreProvider

An OSGi wrapper for the segment node store.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE
static String	COMPACTION_CLEANUP
static String	COMPACTION_CLEANUP_TIMESTAMP
static String	COMPACTION_CLONE_BINARIES
static String	COMPACTION_FORCE_AFTER_FAIL
static String	COMPACTION_GAIN_THRESHOLD
static String	COMPACTION_LOCK_WAIT_TIME
static int	COMPACTION_LOCK_WAIT_TIME_DEFAULT
static String	COMPACTION_MEMORY_THRESHOLD
static String	COMPACTION_RETRY_COUNT
static String	CUSTOM_BLOB_STORE
static String	DIRECTORY
static String	MODE
static String	NAME
static String	PAUSE_COMPACTION
static String	PERSIST_COMPACTION_MAP
static String	PROP_BLOB_GC_MAX_AGE
static String	SIZE
static String	STANDBY

Constructor Summary

Constructors

Constructor and Description
SegmentNodeStoreService()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(org.osgi.service.component.ComponentContext context)
Closeable	addObserver(org.apache.jackrabbit.oak.spi.commit.Observer observer)
protected void	bindBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)
void	deactivate()
protected SegmentNodeStore	getNodeStore()
SegmentStore	getSegmentStore() needed for situations where you have to unwrap the SegmentNodeStoreService, to get the SegmentStore, like the failover
String	toString()
protected void	unbindBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)

Methods inherited from class org.apache.jackrabbit.oak.spi.state.ProxyNodeStore

checkpoint, checkpoint, checkpointInfo, createBlob, getBlob, getRoot, merge, rebase, release, reset, retrieve

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DIRECTORY

@Property(label="Directory",
          description="Directory location used to store the segment tar files. If not specified then looks for framework property \'repository.home\' otherwise use a subdirectory with name \'tarmk\'")
public static final String DIRECTORY

See Also:

Constant Field Values

MODE

@Property(label="Mode",
          description="TarMK mode (64 for memory mapping, 32 for normal file access)")
public static final String MODE

See Also:

Constant Field Values

SIZE

@Property(intValue=256,
          label="Maximum Tar File Size (MB)",
          description="TarMK maximum file size (MB)")
public static final String SIZE

See Also:

Constant Field Values

CACHE

@Property(intValue=256,
          label="Cache size (MB)",
          description="Cache size for storing most recently used Segments")
public static final String CACHE

See Also:

Constant Field Values

COMPACTION_CLONE_BINARIES

@Property(boolValue=false,
          label="Clone Binaries",
          description="Clone the binary segments while performing compaction")
public static final String COMPACTION_CLONE_BINARIES

See Also:

Constant Field Values

COMPACTION_CLEANUP

@Property(options={@PropertyOption(name="CLEAN_ALL",value="CLEAN_ALL"),@PropertyOption(name="CLEAN_NONE",value="CLEAN_NONE"),@PropertyOption(name="CLEAN_OLD",value="CLEAN_OLD")},
          value="CLEAN_OLD",
          label="Cleanup Strategy",
          description="Cleanup strategy used for live in memory segment references while performing cleanup. 1. CLEAN_NONE: All in memory references are considered valid, 2. CLEAN_OLD: Only in memory references older than a certain age are considered valid (compaction.cleanup.timestamp), 3. CLEAN_ALL: None of the in memory references are considered valid")
public static final String COMPACTION_CLEANUP

See Also:

Constant Field Values

COMPACTION_CLEANUP_TIMESTAMP

@Property(longValue=36000000L,
          label="Reference expiry time (ms)",
          description="Time interval in ms beyond which in memory segment references would be ignored while performing cleanup")
public static final String COMPACTION_CLEANUP_TIMESTAMP

See Also:

Constant Field Values

COMPACTION_MEMORY_THRESHOLD

@Property(byteValue=5,
          label="Memory Multiplier",
          description="TarMK compaction available memory multiplier needed to run compaction")
public static final String COMPACTION_MEMORY_THRESHOLD

See Also:

Constant Field Values

COMPACTION_GAIN_THRESHOLD

@Property(byteValue=10,
          label="Compaction gain threshold",
          description="TarMK compaction gain threshold. The gain estimation prevents compaction from running if the provided threshold is not met. Value represents a percentage so an input beween 0 and 100 is expected.")
public static final String COMPACTION_GAIN_THRESHOLD

See Also:

Constant Field Values

PAUSE_COMPACTION

@Property(boolValue=true,
          label="Pause Compaction",
          description="When enabled compaction would not be performed")
public static final String PAUSE_COMPACTION

See Also:

Constant Field Values

COMPACTION_RETRY_COUNT

@Property(intValue=5,
          label="Compaction Retries",
          description="Number of tries to compact concurrent commits on top of already compacted commits")
public static final String COMPACTION_RETRY_COUNT

See Also:

Constant Field Values

COMPACTION_FORCE_AFTER_FAIL

@Property(boolValue=false,
          label="Force Compaction",
          description="Whether or not to force compact concurrent commits on top of already  compacted commits after the maximum number of retries has been reached. Force committing tries to exclusively write lock the node store.")
public static final String COMPACTION_FORCE_AFTER_FAIL

See Also:

Constant Field Values

COMPACTION_LOCK_WAIT_TIME_DEFAULT

public static final int COMPACTION_LOCK_WAIT_TIME_DEFAULT

See Also:

Constant Field Values

COMPACTION_LOCK_WAIT_TIME

@Property(intValue=60,
          label="Compaction Lock Wait Time",
          description="Number of seconds to wait for the lock for committing compacted changes respectively to wait for the exclusive write lock for force committing.")
public static final String COMPACTION_LOCK_WAIT_TIME

See Also:

Constant Field Values

PERSIST_COMPACTION_MAP

@Property(boolValue=true,
          label="Persist Compaction Map",
          description="When enabled the compaction map would be persisted instead of being held in memory")
public static final String PERSIST_COMPACTION_MAP

See Also:

Constant Field Values

STANDBY

@Property(boolValue=false,
          label="Standby Mode",
          description="Flag indicating that this component will not register as a NodeStore but just as a NodeStoreProvider")
public static final String STANDBY

See Also:

Constant Field Values

CUSTOM_BLOB_STORE

@Property(boolValue=false,
          label="Custom BlobStore",
          description="Boolean value indicating that a custom BlobStore is to be used. By default large binary content would be stored within segment tar files")
public static final String CUSTOM_BLOB_STORE

See Also:

Constant Field Values

PROP_BLOB_GC_MAX_AGE

@Property(longValue=86400L,
          label="Blob GC Max Age (in secs)",
          description="Blob Garbage Collector (GC) logic will only consider those blobs for GC which are not accessed recently (currentTime - lastModifiedTime > blobGcMaxAgeInSecs). For example as per default only those blobs which have been created 24 hrs ago will be considered for GC")
public static final String PROP_BLOB_GC_MAX_AGE

See Also:

Constant Field Values

Constructor Detail

SegmentNodeStoreService

public SegmentNodeStoreService()

Method Detail

getNodeStore

protected SegmentNodeStore getNodeStore()

Specified by:

getNodeStore in class org.apache.jackrabbit.oak.spi.state.ProxyNodeStore

activate

@Activate
public void activate(org.osgi.service.component.ComponentContext context)
              throws IOException

Throws:

IOException

bindBlobStore

protected void bindBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)
                      throws IOException

Throws:

IOException

unbindBlobStore

protected void unbindBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)

deactivate

@Deactivate
public void deactivate()

getSegmentStore

public SegmentStore getSegmentStore()

needed for situations where you have to unwrap the SegmentNodeStoreService, to get the SegmentStore, like the failover

Specified by:

getSegmentStore in interface SegmentStoreProvider

addObserver

public Closeable addObserver(org.apache.jackrabbit.oak.spi.commit.Observer observer)

Specified by:

addObserver in interface org.apache.jackrabbit.oak.spi.commit.Observable

toString

public String toString()

Overrides:

toString in class Object