org.apache.sling.testing.mock.jcr

Class MockJcr

java.lang.Object

org.apache.sling.testing.mock.jcr.MockJcr

@ConsumerType
public final class MockJcr
extends java.lang.Object

Factory for mock JCR objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_USER_ID Default user id
static java.lang.String	DEFAULT_WORKSPACE Default workspace name

Method Summary

Modifier and Type	Method and Description
static void	addQueryResultHandler(@NotNull javax.jcr.query.QueryManager queryManager, @NotNull MockQueryResultHandler resultHandler) Adds a query result handler for the given query manager which may return query results for certain queries that are executed.
static void	addQueryResultHandler(@NotNull javax.jcr.Session session, @NotNull MockQueryResultHandler resultHandler) Adds a query result handler for the given query manager which may return query results for certain queries that are executed.
static @NotNull javax.jcr.Repository	newRepository() Create a new mocked in-memory JCR repository.
static @NotNull javax.jcr.Session	newSession() Create a new mocked in-memory JCR session.
static @NotNull javax.jcr.Session	newSession(@Nullable java.lang.String userId, @Nullable java.lang.String workspaceName) Create a new mocked in-memory JCR session.
static void	setQueryResult(@NotNull javax.jcr.query.QueryManager queryManager, @NotNull java.util.List<javax.jcr.Node> resultList) Sets the expected result list for all queries executed with the given query manager.
static void	setQueryResult(@NotNull javax.jcr.query.QueryManager queryManager, @NotNull java.lang.String statement, @NotNull java.lang.String language, @NotNull java.util.List<javax.jcr.Node> resultList) Sets the expected result list for all queries with the given statement executed with the given query manager.
static void	setQueryResult(@NotNull javax.jcr.Session session, @NotNull java.util.List<javax.jcr.Node> resultList) Sets the expected result list for all queries executed with the given query manager.
static void	setQueryResult(@NotNull javax.jcr.Session session, @NotNull java.lang.String statement, @NotNull java.lang.String language, @NotNull java.util.List<javax.jcr.Node> resultList) Sets the expected result list for all queries with the given statement executed with the given query manager.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WORKSPACE

public static final java.lang.String DEFAULT_WORKSPACE

Default workspace name

See Also:

Constant Field Values

DEFAULT_USER_ID

public static final java.lang.String DEFAULT_USER_ID

Default user id

See Also:

Constant Field Values

Method Detail

newRepository

@NotNull
public static @NotNull javax.jcr.Repository newRepository()

Create a new mocked in-memory JCR repository. Beware: each session has its own data store.

Returns:

JCR repository

newSession

@NotNull
public static @NotNull javax.jcr.Session newSession()

Create a new mocked in-memory JCR session. It contains only the root node. All data of the session is thrown away if it gets garbage collected.

Returns:

JCR session

newSession

@NotNull
public static @NotNull javax.jcr.Session newSession(@Nullable
                                                             @Nullable java.lang.String userId,
                                                             @Nullable
                                                             @Nullable java.lang.String workspaceName)

Create a new mocked in-memory JCR session. It contains only the root node. All data of the session is thrown away if it gets garbage collected.

Parameters:

userId - User id for the mock environment. If null a dummy value is used.

workspaceName - Workspace name for the mock environment. If null a dummy value is used.

Returns:

JCR session

setQueryResult

public static void setQueryResult(@NotNull
                                  @NotNull javax.jcr.Session session,
                                  @NotNull
                                  @NotNull java.util.List<javax.jcr.Node> resultList)

Sets the expected result list for all queries executed with the given query manager.

Parameters:

session - JCR session

resultList - Result list

setQueryResult

public static void setQueryResult(@NotNull
                                  @NotNull javax.jcr.query.QueryManager queryManager,
                                  @NotNull
                                  @NotNull java.util.List<javax.jcr.Node> resultList)

Sets the expected result list for all queries executed with the given query manager.

Parameters:

queryManager - Mocked query manager

resultList - Result list

setQueryResult

public static void setQueryResult(@NotNull
                                  @NotNull javax.jcr.Session session,
                                  @NotNull
                                  @NotNull java.lang.String statement,
                                  @NotNull
                                  @NotNull java.lang.String language,
                                  @NotNull
                                  @NotNull java.util.List<javax.jcr.Node> resultList)

Sets the expected result list for all queries with the given statement executed with the given query manager.

Parameters:

session - JCR session

statement - Query statement

language - Query language

resultList - Result list

setQueryResult

public static void setQueryResult(@NotNull
                                  @NotNull javax.jcr.query.QueryManager queryManager,
                                  @NotNull
                                  @NotNull java.lang.String statement,
                                  @NotNull
                                  @NotNull java.lang.String language,
                                  @NotNull
                                  @NotNull java.util.List<javax.jcr.Node> resultList)

Sets the expected result list for all queries with the given statement executed with the given query manager.

Parameters:

queryManager - Mocked query manager

statement - Query statement

language - Query language

resultList - Result list

addQueryResultHandler

public static void addQueryResultHandler(@NotNull
                                         @NotNull javax.jcr.Session session,
                                         @NotNull
                                         @NotNull MockQueryResultHandler resultHandler)

Adds a query result handler for the given query manager which may return query results for certain queries that are executed.

Parameters:

session - JCR session

resultHandler - Mock query result handler

addQueryResultHandler

public static void addQueryResultHandler(@NotNull
                                         @NotNull javax.jcr.query.QueryManager queryManager,
                                         @NotNull
                                         @NotNull MockQueryResultHandler resultHandler)

Adds a query result handler for the given query manager which may return query results for certain queries that are executed.

Parameters:

queryManager - Mocked query manager

resultHandler - Mock query result handler