Package org.apache.sling.testing.mock.sling.junit

Class SlingContextBuilder

java.lang.Object

org.apache.sling.testing.mock.sling.junit.SlingContextBuilder

@ProviderType
public final class SlingContextBuilder
extends Object

Builder class for creating SlingContext instances with different sets of parameters.

Constructor Summary

Constructors

Constructor	Description
SlingContextBuilder()	Create builder with default resource resolver type.
SlingContextBuilder(@NotNull ResourceResolverType resourceResolverType)	Create builder with given resource resolver type.

Method Summary

Modifier and Type	Method	Description
<T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder	afterSetUp(@NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... afterSetUpCallback)
<T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder	afterTearDown(@NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... afterTearDownCallback)
<T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder	beforeSetUp(@NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... beforeSetUpCallback)
<T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder	beforeTearDown(@NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... beforeTearDownCallback)
@NotNull SlingContext	build()
<T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder	plugin(@NotNull org.apache.sling.testing.mock.osgi.context.ContextPlugin<T> @NotNull ... plugin)
@NotNull SlingContextBuilder	registerSlingModelsFromClassPath(boolean registerSlingModelsFromClassPath)	Automatic registering of all Sling Models found in the classpath on startup (active by default).
@NotNull SlingContextBuilder	resourceResolverFactoryActivatorProps(@NotNull Map<String,Object> props)	Allows to override OSGi configuration parameters for the Resource Resolver Factory Activator service.
@NotNull SlingContextBuilder	resourceResolverType(@NotNull ResourceResolverType resourceResolverType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SlingContextBuilder

public SlingContextBuilder()

Create builder with default resource resolver type.

SlingContextBuilder

public SlingContextBuilder(@NotNull
                           @NotNull ResourceResolverType resourceResolverType)

Create builder with given resource resolver type.

Parameters:

resourceResolverType - Resource resolver type.

Method Detail

resourceResolverType

@NotNull
public @NotNull SlingContextBuilder resourceResolverType(@NotNull
                                                         @NotNull ResourceResolverType resourceResolverType)

Parameters:

resourceResolverType - Resource resolver type.

Returns:

this

plugin

@SafeVarargs
@NotNull
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder plugin(@NotNull
                                                                                                                        @NotNull org.apache.sling.testing.mock.osgi.context.ContextPlugin<T> @NotNull ... plugin)

Type Parameters:

T - context type

Parameters:

plugin - Context plugin which listens to context lifecycle events.

Returns:

this

beforeSetUp

@SafeVarargs
@NotNull
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder beforeSetUp(@NotNull
                                                                                                                             @NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... beforeSetUpCallback)

Type Parameters:

T - context type

Parameters:

beforeSetUpCallback - Allows the application to register an own callback function that is called before the built-in setup rules are executed.

Returns:

this

afterSetUp

@SafeVarargs
@NotNull
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder afterSetUp(@NotNull
                                                                                                                            @NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... afterSetUpCallback)

Type Parameters:

T - context type

Parameters:

afterSetUpCallback - Allows the application to register an own callback function that is called after the built-in setup rules are executed.

Returns:

this

beforeTearDown

@SafeVarargs
@NotNull
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder beforeTearDown(@NotNull
                                                                                                                                @NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... beforeTearDownCallback)

Type Parameters:

T - context type

Parameters:

beforeTearDownCallback - Allows the application to register an own callback function that is called before the built-in teardown rules are executed.

Returns:

this

afterTearDown

@SafeVarargs
@NotNull
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> @NotNull SlingContextBuilder afterTearDown(@NotNull
                                                                                                                               @NotNull org.apache.sling.testing.mock.osgi.context.ContextCallback<T> @NotNull ... afterTearDownCallback)

Type Parameters:

T - context type

Parameters:

afterTearDownCallback - Allows the application to register an own callback function that is after before the built-in teardown rules are executed.

Returns:

this

resourceResolverFactoryActivatorProps

@NotNull
public @NotNull SlingContextBuilder resourceResolverFactoryActivatorProps(@NotNull
                                                                          @NotNull Map<String,Object> props)

Allows to override OSGi configuration parameters for the Resource Resolver Factory Activator service.

Parameters:

props - Configuration properties

Returns:

this

registerSlingModelsFromClassPath

@NotNull
public @NotNull SlingContextBuilder registerSlingModelsFromClassPath(boolean registerSlingModelsFromClassPath)

Automatic registering of all Sling Models found in the classpath on startup (active by default).

Parameters:

registerSlingModelsFromClassPath - If set to false Sling Models are not registered automatically from the classpath on startup.

Returns:

this

build

@NotNull
public @NotNull SlingContext build()

Returns:

Build SlingContext instance.