io.wcm.testing.mock.aem.junit

Class AemContextBuilder

java.lang.Object

io.wcm.testing.mock.aem.junit.AemContextBuilder

@ProviderType
public final class AemContextBuilder
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
AemContextBuilder() Create builder with default resource resolver type.
AemContextBuilder(ResourceResolverType... resourceResolverTypes) Create builder with given resource resolver type.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AemContextBuilder

public AemContextBuilder()

Create builder with default resource resolver type.

AemContextBuilder

public AemContextBuilder(@NotNull
                         ResourceResolverType... resourceResolverTypes)

Create builder with given resource resolver type.

Parameters:

resourceResolverTypes - Resource resolver type(s).

Method Detail

resourceResolverType

@NotNull
public @NotNull AemContextBuilder resourceResolverType(@NotNull
                                                                ResourceResolverType... types)

Parameters:

types - Resource resolver type(s).

Returns:

this

plugin

@SafeVarargs
 @NotNull
public final <T extends OsgiContextImpl> @NotNull AemContextBuilder plugin(@NotNull
                                                                                                  ContextPlugin<T>... 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 OsgiContextImpl> @NotNull AemContextBuilder beforeSetUp(@NotNull
                                                                                                       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
 @NotNull
public final <T extends OsgiContextImpl> @NotNull AemContextBuilder afterSetUp(@NotNull
                                                                                                      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
 @NotNull
public final <T extends OsgiContextImpl> @NotNull AemContextBuilder beforeTearDown(@NotNull
                                                                                                          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
 @NotNull
public final <T extends OsgiContextImpl> @NotNull AemContextBuilder afterTearDown(@NotNull
                                                                                                         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

@NotNull
public @NotNull AemContextBuilder resourceResolverFactoryActivatorProps(@NotNull
                                                                                 @NotNull java.util.Map<java.lang.String,java.lang.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 AemContextBuilder 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 AemContext build()

Returns:

Build AemContext instance.