Package org.apache.jackrabbit.oak.jcr

Class Jcr

java.lang.Object

org.apache.jackrabbit.oak.jcr.Jcr

public class Jcr
extends java.lang.Object

Builder class which encapsulates the details of building a JCR Repository backed by an Oak ContentRepository instance

The backing ContentRepository instance will be constructed with reasonable defaults and additional components can be registered by calling the with methods. Note that it is not possible to remove components once registered.

The Jcr builder is a lazy initializer, to have a working repository make sure you call createContentRepository() or createRepository().

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_OBSERVATION_QUEUE_LENGTH

Constructor Summary

Constructors

Constructor	Description
Jcr()
Jcr(Oak oak)
Jcr(Oak oak, boolean initialize)
Jcr(NodeStore store)

Method Summary

Modifier and Type	Method	Description
@NotNull ContentRepository	createContentRepository()
@NotNull javax.jcr.Repository	createRepository()
@NotNull Jcr	with(@NotNull java.lang.String defaultWorkspaceName)
@NotNull Jcr	with(@NotNull java.util.concurrent.Executor executor)
@NotNull Jcr	with(@NotNull java.util.concurrent.ScheduledExecutorService executor)
@NotNull Jcr	with(@NotNull IndexEditorProvider indexEditorProvider)
@NotNull Jcr	with(@NotNull CommitRateLimiter commitRateLimiter)
@NotNull Jcr	with(@NotNull CommitHook hook)
@NotNull Jcr	with(@NotNull Editor editor)
@NotNull Jcr	with(@NotNull EditorProvider provider)
@NotNull Jcr	with(@NotNull Observer observer)
@NotNull Jcr	with(@NotNull PartialConflictHandler conflictHandler)	Deprecated. Use with(ThreeWayConflictHandler) instead
@NotNull Jcr	with(@NotNull ThreeWayConflictHandler conflictHandler)
@NotNull Jcr	with(@NotNull RepositoryInitializer initializer)
@NotNull Jcr	with(@NotNull QueryIndexProvider provider)
@NotNull Jcr	with(@NotNull QueryLimits qs)
@NotNull Jcr	with(@NotNull SecurityProvider securityProvider)
@NotNull Jcr	with(@NotNull Clusterable c)
@NotNull Jcr	with(@NotNull Whiteboard whiteboard)
@NotNull Jcr	withAsyncIndexing()	Deprecated. Use withAsyncIndexing(String, long) instead
@NotNull Jcr	withAsyncIndexing(@NotNull java.lang.String name, long delayInSeconds)
Jcr	withAtomicCounter()
@NotNull Jcr	withFastQueryResultSize(boolean fastQueryResultSize)
@NotNull Jcr	withObservationQueueLength(int observationQueueLength)
@NotNull Jcr	withoutSessionMBeans()	Disables registration of SessionMBean for every open Session in the repository.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OBSERVATION_QUEUE_LENGTH

public static final int DEFAULT_OBSERVATION_QUEUE_LENGTH

See Also:

Constant Field Values

Constructor Detail

Jcr

public Jcr(Oak oak,
           boolean initialize)

Jcr

public Jcr(Oak oak)

Jcr

public Jcr()

Jcr

public Jcr(NodeStore store)

Method Detail

with

@NotNull
public @NotNull Jcr with(@NotNull
                         @NotNull Clusterable c)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull RepositoryInitializer initializer)

withAtomicCounter

public Jcr withAtomicCounter()

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull QueryIndexProvider provider)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull IndexEditorProvider indexEditorProvider)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull CommitHook hook)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull EditorProvider provider)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull Editor editor)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull SecurityProvider securityProvider)

with

@Deprecated
@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull PartialConflictHandler conflictHandler)

Deprecated.

Use with(ThreeWayConflictHandler) instead

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull ThreeWayConflictHandler conflictHandler)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull java.util.concurrent.ScheduledExecutorService executor)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull java.util.concurrent.Executor executor)

with

@NotNull
public final @NotNull Jcr with(@NotNull
                               @NotNull Observer observer)

withAsyncIndexing

@NotNull
@Deprecated
public @NotNull Jcr withAsyncIndexing()

Deprecated.

Use withAsyncIndexing(String, long) instead

withAsyncIndexing

@NotNull
public @NotNull Jcr withAsyncIndexing(@NotNull
                                      @NotNull java.lang.String name,
                                      long delayInSeconds)

withObservationQueueLength

@NotNull
public @NotNull Jcr withObservationQueueLength(int observationQueueLength)

with

@NotNull
public @NotNull Jcr with(@NotNull
                         @NotNull CommitRateLimiter commitRateLimiter)

with

@NotNull
public @NotNull Jcr with(@NotNull
                         @NotNull QueryLimits qs)

withFastQueryResultSize

@NotNull
public @NotNull Jcr withFastQueryResultSize(boolean fastQueryResultSize)

with

@NotNull
public @NotNull Jcr with(@NotNull
                         @NotNull java.lang.String defaultWorkspaceName)

with

@NotNull
public @NotNull Jcr with(@NotNull
                         @NotNull Whiteboard whiteboard)

withoutSessionMBeans

@NotNull
public @NotNull Jcr withoutSessionMBeans()

Disables registration of SessionMBean for every open Session in the repository. This gets rid of some overhead for cases where MBeans are not leveraged.

Returns:

the Jcr object

Since:

1.46

createContentRepository

@NotNull
public @NotNull ContentRepository createContentRepository()

createRepository

@NotNull
public @NotNull javax.jcr.Repository createRepository()