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

Klasse SlingContextImpl

java.lang.Object
org.apache.sling.testing.mock.osgi.context.OsgiContextImpl
org.apache.sling.testing.mock.sling.context.SlingContextImpl
@ConsumerType 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 or extension.

  • Felddetails

    • resourceResolverFactory

      protected org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory
      Resource resolver factory

    • resourceResolverType

      protected ResourceResolverType resourceResolverType
      Resource resolver type

    • resourceResolver

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

    • request

      @Deprecated(since="4.1.0") protected MockSlingHttpServletRequest request
      Veraltet.
      Use jakartaRequest instead.
      Sling request

    • response

      @Deprecated(since="4.1.0") protected MockSlingHttpServletResponse response
      Veraltet.
      Use jakartaResponse instead.
      Sling response

    • jakartaRequest

      protected MockSlingJakartaHttpServletRequest jakartaRequest
      Sling jakarta request

    • jakartaResponse

      protected MockSlingJakartaHttpServletResponse jakartaResponse
      Sling response

    • slingScriptHelper

      protected org.apache.sling.api.scripting.SlingScriptHelper slingScriptHelper
      Sling script helper

    • contentLoader

      protected ContentLoader contentLoader
      Content loader

    • contentLoaderAutoCommit

      protected ContentLoader contentLoaderAutoCommit
      Content loader with auto commit after loading content

    • contentBuilder

      protected ContentBuilder contentBuilder
      Content builder

    • resourceBuilder

      protected org.apache.sling.resourcebuilder.api.ResourceBuilder resourceBuilder
      Resource builder

    • uniqueRoot

      protected UniqueRoot uniqueRoot
      Unique root helper

  • Konstruktordetails

    • SlingContextImpl

      public SlingContextImpl()

  • Methodendetails

    • setResourceResolverType

      protected void setResourceResolverType(@Nullable @Nullable ResourceResolverType resourceResolverType)
      Parameter:
      resourceResolverType - Resource resolver type

    • setResourceResolverFactoryActivatorProps

      protected void setResourceResolverFactoryActivatorProps(@Nullable @Nullable Map<String,Object> props)
      Parameter:
      props - Resolver resolver factory activator properties

    • setRegisterSlingModelsFromClassPath

      protected void setRegisterSlingModelsFromClassPath(boolean registerSlingModelsFromClassPath)
      Parameter:
      registerSlingModelsFromClassPath - Register sling models from classpath

    • setUp

      protected void setUp()
      Setup actions before test method execution
      Setzt außer Kraft:
      setUp in Klasse org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

    • newResourceResolverFactory

      @NotNull protected @NotNull org.apache.sling.api.resource.ResourceResolverFactory newResourceResolverFactory()
      Initialize mocked resource resolver factory.
      Gibt zurück:
      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
      Setzt außer Kraft:
      tearDown in Klasse org.apache.sling.testing.mock.osgi.context.OsgiContextImpl

    • resourceResolverType

      @NotNull public final @NotNull ResourceResolverType resourceResolverType()
      Gibt zurück:
      Resource resolver type

    • resourceResolver

      @NotNull public final @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver()
      Returns the singleton resource resolver bound to this context. It is automatically closed after the test.
      Gibt zurück:
      Resource resolver

    • request

      @Deprecated(since="4.1.0") @NotNull public final MockSlingHttpServletRequest request()
      Veraltet.
      Use jakartaRequest() instead.
      Gibt zurück:
      Sling request

    • jakartaRequest

      @NotNull public final @NotNull MockSlingJakartaHttpServletRequest jakartaRequest()
      Gibt zurück:
      Sling request

    • resolveSlingBindingProperty

      @Deprecated(since="4.0.0") @Nullable protected @Nullable Object resolveSlingBindingProperty(@NotNull @NotNull String property, @NotNull org.apache.sling.api.SlingHttpServletRequest request)
      Veraltet.
      use resolveSlingBindingProperty(String, SlingJakartaHttpServletRequest) instead
      Dynamically resolve property request for current request SlingBindings.
      Parameter:
      property - Property key
      request - Context request
      Gibt zurück:
      Resolved object or null if no result found

    • resolveSlingBindingProperty

      @Nullable protected @Nullable Object resolveSlingBindingProperty(@NotNull @NotNull String property, @NotNull @NotNull org.apache.sling.api.SlingJakartaHttpServletRequest request)
      Dynamically resolve property request for current request SlingBindings.
      Parameter:
      property - Property key
      request - Context request
      Gibt zurück:
      Resolved object or null if no result found

    • resolveSlingBindingProperty

      @Deprecated @Nullable protected @Nullable Object resolveSlingBindingProperty(@NotNull @NotNull String property)
      Veraltet.
      Please use resolveSlingBindingProperty(String, SlingJakartaHttpServletRequest)
      Dynamically resolve property request for current request SlingBindings.
      Parameter:
      property - Property key
      Gibt zurück:
      Resolved object or null if no result found

    • requestPathInfo

      @NotNull public final @NotNull MockRequestPathInfo requestPathInfo()
      Gibt zurück:
      Request path info

    • response

      @Deprecated(since="4.0.0") @NotNull public final MockSlingHttpServletResponse response()
      Veraltet.
      Use jakartaResponse() instead.
      Gibt zurück:
      Sling response

    • jakartaResponse

      @NotNull public final @NotNull MockSlingJakartaHttpServletResponse jakartaResponse()
      Gibt zurück:
      Sling response

    • slingScriptHelper

      @NotNull public final @NotNull org.apache.sling.api.scripting.SlingScriptHelper slingScriptHelper()
      Gibt zurück:
      Sling script helper

    • load

      @NotNull public @NotNull ContentLoader load()
      Gibt zurück:
      Content loader

    • load

      @NotNull public @NotNull ContentLoader load(boolean autoCommit)
      Parameter:
      autoCommit - Automatically commit changes after loading content (default: true)
      Gibt zurück:
      Content loader

    • create

      @NotNull public @NotNull ContentBuilder create()
      Creates a ContentBuilder object for easily creating test content. This API was part of Sling Mocks since version 1.x. You can use alternatively the build() method and use the ResourceBuilder API.
      Gibt zurück:
      Content builder for building test content

    • build

      @NotNull public @NotNull org.apache.sling.resourcebuilder.api.ResourceBuilder build()
      Creates a ResourceBuilder object for easily creating test content. This is a separate API which can be used inside sling mocks or in a running instance. You can use alternatively the create() method to use the ContentBuilder API.
      Gibt zurück:
      Resource builder for building test content.

    • currentResource

      @Nullable public final @Nullable org.apache.sling.api.resource.Resource currentResource()
      Gibt zurück:
      Current resource

    • currentResource

      @Nullable public final @Nullable org.apache.sling.api.resource.Resource currentResource(@Nullable @Nullable String resourcePath)
      Set current resource in request.
      Parameter:
      resourcePath - Resource path
      Gibt zurück:
      Current resource

    • currentResource

      @Nullable public @Nullable org.apache.sling.api.resource.Resource currentResource(@Nullable @Nullable org.apache.sling.api.resource.Resource resource)
      Set current resource in request.
      Parameter:
      resource - Resource
      Gibt zurück:
      Current resource

    • addModelsForPackage

      public final void addModelsForPackage(@NotNull @NotNull String packageName)
      Search classpath for given java package names (and sub packages) to scan for and register all classes with @Model annotation.
      Parameter:
      packageName - Java package name

    • addModelsForPackage

      public final void addModelsForPackage(@NotNull @NotNull String @NotNull ... packageNames)
      Search classpath for given java package names (and sub packages) to scan for and register all classes with @Model annotation.
      Parameter:
      packageNames - Java package names

    • addModelsForClasses

      public final void addModelsForClasses(@NotNull @NotNull String @NotNull ... classNames)
      Search classpath for given class names to scan for and register all classes with @Model annotation.
      Parameter:
      classNames - Java class names

    • addModelsForClasses

      public final void addModelsForClasses(@NotNull @NotNull Class<?> @NotNull ... classes)
      Search classpath for given class names to scan for and register all classes with @Model annotation.
      Parameter:
      classes - Java classes

    • runMode

      public final void runMode(@NotNull @NotNull String @NotNull ... runModes)
      Set current run mode(s).
      Parameter:
      runModes - Run mode(s).

    • uniqueRoot

      @NotNull public @NotNull UniqueRoot uniqueRoot()
      Create unique root paths for unit tests (and clean them up after the test run automatically).
      Gibt zurück:
      Unique root path helper

    • registerAdapter

      public final <T1, T2> void registerAdapter(@NotNull @NotNull Class<T1> adaptableClass, @NotNull @NotNull Class<T2> adapterClass, @NotNull T2 adapter)
      Create a Sling AdapterFactory on the fly which can adapt from adaptableClass to adapterClass and just returns the given value as result.
      Typparameter:
      T1 - Adaptable type
      T2 - Adapter type
      Parameter:
      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(@NotNull @NotNull Class<T1> adaptableClass, @NotNull @NotNull Class<T2> adapterClass, @NotNull @NotNull 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.
      Typparameter:
      T1 - Adaptable type
      T2 - Adapter type
      Parameter:
      adaptableClass - Class to adapt from
      adapterClass - Class to adapt to
      adaptHandler - Function to handle the adaption