org.apache.sling.testing.mock.sling.junit5

Class SlingContextBuilder

java.lang.Object

org.apache.sling.testing.mock.sling.junit5.SlingContextBuilder

@ProviderType
public final class SlingContextBuilder
extends Object

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

Constructor Summary

Constructors

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

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

public SlingContextBuilder resourceResolverType(@NotNull
                                                @NotNull ResourceResolverType type)

Parameters:

type - Resource resolver type.

Returns:

this

plugin

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

Type Parameters:

T - context type

Parameters:

plugin - Context plugin which listens to context lifecycle events.

Returns:

this

beforeSetUp

@SafeVarargs
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> SlingContextBuilder beforeSetUp(@NotNull
                                                                                                                                  org.apache.sling.testing.mock.osgi.context.ContextCallback<T>... 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
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> SlingContextBuilder afterSetUp(@NotNull
                                                                                                                                 org.apache.sling.testing.mock.osgi.context.ContextCallback<T>... 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
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> SlingContextBuilder beforeTearDown(@NotNull
                                                                                                                                     org.apache.sling.testing.mock.osgi.context.ContextCallback<T>... 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
public final <T extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl> SlingContextBuilder afterTearDown(@NotNull
                                                                                                                                    org.apache.sling.testing.mock.osgi.context.ContextCallback<T>... 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

public 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

public SlingContextBuilder registerSlingModelsFromClassPath(boolean value)

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

Parameters:

value - 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.