org.apache.sling.testing.mock.sling.context

Class SlingContextImpl

java.lang.Object

org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

org.apache.sling.testing.mock.sling.context.SlingContextImpl

Direct Known Subclasses:

SlingContext

public class SlingContextImpl
extends org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

Defines Sling context objects with lazy initialization. Should not be used directly but via the SlingContext JUnit rule.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentBuilder	contentBuilder
protected ContentLoader	contentLoader
protected MockSlingHttpServletRequest	request
protected org.apache.sling.api.resource.ResourceResolver	resourceResolver
protected org.apache.sling.api.resource.ResourceResolverFactory	resourceResolverFactory
protected ResourceResolverType	resourceResolverType
protected MockSlingHttpServletResponse	response
protected org.apache.sling.api.scripting.SlingScriptHelper	slingScriptHelper
protected UniqueRoot	uniqueRoot

Fields inherited from class org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

componentContext

Constructor Summary

Constructors

Constructor and Description
SlingContextImpl()

Method Summary

Modifier and Type	Method and Description
void	addModelsForPackage(String packageName) Scan classpaths for given package name (and sub packages) to scan for and register all classes with @Model annotation.
ContentBuilder	create()
org.apache.sling.api.resource.Resource	currentResource()
org.apache.sling.api.resource.Resource	currentResource(org.apache.sling.api.resource.Resource resource) Set current resource in request.
org.apache.sling.api.resource.Resource	currentResource(String resourcePath) Set current resource in request.
ContentLoader	load()
protected org.apache.sling.api.resource.ResourceResolverFactory	newResourceResolverFactory() Initialize mocked resource resolver factory.
<T1,T2> void	registerAdapter(Class<T1> adaptableClass, Class<T2> adapterClass, com.google.common.base.Function<T1,T2> adaptHandler) Create a Sling AdapterFactory on the fly which can adapt from adaptableClass to adapterClass and delegates the adapter mapping to the given adaptHandler function.
<T1,T2> void	registerAdapter(Class<T1> adaptableClass, Class<T2> adapterClass, T2 adapter) Create a Sling AdapterFactory on the fly which can adapt from adaptableClass to adapterClass and just returns the given value as result.
protected void	registerDefaultServices() Default services that should be available for every unit test
MockSlingHttpServletRequest	request()
MockRequestPathInfo	requestPathInfo()
org.apache.sling.api.resource.ResourceResolver	resourceResolver() Returns the singleton resource resolver bound to this context.
ResourceResolverType	resourceResolverType()
MockSlingHttpServletResponse	response()
void	runMode(String... runModes) Set current run mode(s).
protected void	setResourceResolverFactoryActivatorProps(Map<String,Object> props)
protected void	setResourceResolverType(ResourceResolverType resourceResolverType)
protected void	setUp() Setup actions before test method execution
org.apache.sling.api.scripting.SlingScriptHelper	slingScriptHelper()
protected void	tearDown() Teardown actions after test method execution
UniqueRoot	uniqueRoot() Create unique root paths for unit tests (and clean them up after the test run automatically).

Methods inherited from class org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

bundleContext, componentContext, getService, getServices, registerInjectActivateService, registerInjectActivateService, registerService, registerService, registerService

Methods inherited from class java.lang.Object

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

Field Detail

resourceResolverFactory

protected org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory

resourceResolverType

protected ResourceResolverType resourceResolverType

resourceResolver

protected org.apache.sling.api.resource.ResourceResolver resourceResolver

request

protected MockSlingHttpServletRequest request

response

protected MockSlingHttpServletResponse response

slingScriptHelper

protected org.apache.sling.api.scripting.SlingScriptHelper slingScriptHelper

contentLoader

protected ContentLoader contentLoader

contentBuilder

protected ContentBuilder contentBuilder

uniqueRoot

protected UniqueRoot uniqueRoot

Constructor Detail

SlingContextImpl

public SlingContextImpl()

Method Detail

setResourceResolverType

protected void setResourceResolverType(ResourceResolverType resourceResolverType)

Parameters:

resourceResolverType - Resource resolver type

setResourceResolverFactoryActivatorProps

protected void setResourceResolverFactoryActivatorProps(Map<String,Object> props)

setUp

protected void setUp()

Setup actions before test method execution

Overrides:

setUp in class org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

newResourceResolverFactory

protected org.apache.sling.api.resource.ResourceResolverFactory newResourceResolverFactory()

Initialize mocked resource resolver factory.

Returns:

Resource resolver factory

registerDefaultServices

protected void registerDefaultServices()

Default services that should be available for every unit test

tearDown

protected void tearDown()

Teardown actions after test method execution

Overrides:

tearDown in class org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

resourceResolverType

public final ResourceResolverType resourceResolverType()

Returns:

Resource resolver type

resourceResolver

public final org.apache.sling.api.resource.ResourceResolver resourceResolver()

Returns the singleton resource resolver bound to this context. It is automatically closed after the test.

Returns:

Resource resolver

request

public final MockSlingHttpServletRequest request()

Returns:

Sling request

requestPathInfo

public final MockRequestPathInfo requestPathInfo()

Returns:

Request path info

response

public final MockSlingHttpServletResponse response()

Returns:

Sling response

slingScriptHelper

public final org.apache.sling.api.scripting.SlingScriptHelper slingScriptHelper()

Returns:

Sling script helper

load

public ContentLoader load()

Returns:

Content loader

create

public ContentBuilder create()

Returns:

Content builder for building test content

currentResource

public final org.apache.sling.api.resource.Resource currentResource()

Returns:

Current resource

currentResource

public final org.apache.sling.api.resource.Resource currentResource(String resourcePath)

Set current resource in request.

Parameters:

resourcePath - Resource path

Returns:

Current resource

currentResource

public final org.apache.sling.api.resource.Resource currentResource(org.apache.sling.api.resource.Resource resource)

Set current resource in request.

Parameters:

resource - Resource

Returns:

Current resource

addModelsForPackage

public final void addModelsForPackage(String packageName)

Scan classpaths for given package name (and sub packages) to scan for and register all classes with @Model annotation.

Parameters:

packageName - Java package name

runMode

public final void runMode(String... runModes)

Set current run mode(s).

Parameters:

runModes - Run mode(s).

uniqueRoot

public UniqueRoot uniqueRoot()

Create unique root paths for unit tests (and clean them up after the test run automatically).

Returns:

Unique root path helper

registerAdapter

public final <T1,T2> void registerAdapter(Class<T1> adaptableClass,
                                          Class<T2> adapterClass,
                                          T2 adapter)

Create a Sling AdapterFactory on the fly which can adapt from adaptableClass to adapterClass and just returns the given value as result.

Type Parameters:

T1 - Adaptable type

T2 - Adapter type

Parameters:

adaptableClass - Class to adapt from

adapterClass - Class to adapt to

adapter - Object which is always returned for this adaption.

registerAdapter

public final <T1,T2> void registerAdapter(Class<T1> adaptableClass,
                                          Class<T2> adapterClass,
                                          com.google.common.base.Function<T1,T2> adaptHandler)

Create a Sling AdapterFactory on the fly which can adapt from adaptableClass to adapterClass and delegates the adapter mapping to the given adaptHandler function.

Type Parameters:

T1 - Adaptable type

T2 - Adapter type

Parameters:

adaptableClass - Class to adapt from

adapterClass - Class to adapt to

adaptHandler - Function to handle the adaption