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

Class SlingContextImpl

java.lang.Object

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

Direct Known Subclasses:

SlingContext

public class SlingContextImpl
extends Object

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 org.osgi.service.component.ComponentContext	componentContext
protected ContentBuilder	contentBuilder
protected ContentLoader	contentLoader
protected MockModelAdapterFactory	modelAdapterFactory
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

Constructor Summary

Constructors

Constructor and Description
SlingContextImpl()

Method Summary

Methods

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.
org.osgi.framework.BundleContext	bundleContext()
org.osgi.service.component.ComponentContext	componentContext()
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.
<ServiceType> ServiceType	getService(Class<ServiceType> serviceType) Lookup a single service
<ServiceType> ServiceType[]	getServices(Class<ServiceType> serviceType, String filter) Lookup one or several services
ContentLoader	load()
protected org.apache.sling.api.resource.ResourceResolverFactory	newResourceResolverFactory() Initialize mocked resource resolver factory.
protected void	registerDefaultServices() Default services that should be available for every unit test
<T> T	registerInjectActivateService(T service) Injects dependencies, activates and registers a service in the mocked OSGi environment.
<T> T	registerInjectActivateService(T service, Map<String,Object> properties) Injects dependencies, activates and registers a service in the mocked OSGi environment.
<T> T	registerService(Class<T> serviceClass, T service) Registers a service in the mocked OSGi environment.
<T> T	registerService(Class<T> serviceClass, T service, Map<String,Object> properties) Registers a service in the mocked OSGi environment.
<T> T	registerService(T service) Registers a service in the mocked OSGi environment.
MockSlingHttpServletRequest	request()
MockRequestPathInfo	requestPathInfo()
org.apache.sling.api.resource.ResourceResolver	resourceResolver()
ResourceResolverType	resourceResolverType()
MockSlingHttpServletResponse	response()
void	runMode(String... runModes) Set current run mode(s).
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

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

modelAdapterFactory

protected MockModelAdapterFactory modelAdapterFactory

resourceResolverType

protected ResourceResolverType resourceResolverType

componentContext

protected org.osgi.service.component.ComponentContext componentContext

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

Constructor Detail

SlingContextImpl

public SlingContextImpl()

Method Detail

setResourceResolverType

protected void setResourceResolverType(ResourceResolverType resourceResolverType)

Parameters:

resourceResolverType - Resource resolver type

setUp

protected void setUp()

Setup actions before test method execution

newResourceResolverFactory

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

Initialize mocked 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

resourceResolverType

public final ResourceResolverType resourceResolverType()

Returns:

Resource resolver type

componentContext

public final org.osgi.service.component.ComponentContext componentContext()

Returns:

OSGi component context

bundleContext

public final org.osgi.framework.BundleContext bundleContext()

Returns:

OSGi Bundle context

resourceResolver

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

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

registerService

public final <T> T registerService(T service)

Registers a service in the mocked OSGi environment.

Parameters:

service - Service instance

Returns:

Registered service instance

registerService

public final <T> T registerService(Class<T> serviceClass,
                    T service)

Registers a service in the mocked OSGi environment.

Parameters:

serviceClass - Service class

service - Service instance

Returns:

Registered service instance

registerService

public final <T> T registerService(Class<T> serviceClass,
                    T service,
                    Map<String,Object> properties)

Registers a service in the mocked OSGi environment.

Parameters:

serviceClass - Service class

service - Service instance

properties - Service properties (optional)

Returns:

Registered service instance

registerInjectActivateService

public final <T> T registerInjectActivateService(T service)

Injects dependencies, activates and registers a service in the mocked OSGi environment.

Parameters:

service - Service instance

Returns:

Registered service instance

registerInjectActivateService

public final <T> T registerInjectActivateService(T service,
                                  Map<String,Object> properties)

Injects dependencies, activates and registers a service in the mocked OSGi environment.

Parameters:

service - Service instance

properties - Service properties (optional)

Returns:

Registered service instance

getService

public final <ServiceType> ServiceType getService(Class<ServiceType> serviceType)

Lookup a single service

Parameters:

serviceType - The type (interface) of the service.

Returns:

The service instance, or null if the service is not available.

getServices

public final <ServiceType> ServiceType[] getServices(Class<ServiceType> serviceType,
                                      String filter)

Lookup one or several services

Parameters:

serviceType - The type (interface) of the service.

filter - An optional filter (LDAP-like, see OSGi spec)

Returns:

The services object or null.

Throws:

InvalidServiceFilterSyntaxException - If the filter string is not a valid OSGi service filter string.

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