| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.sling.testing.mock.sling.junit; |
| |
| import java.util.Map; |
| |
| import org.apache.sling.testing.mock.osgi.context.ContextCallback; |
| import org.apache.sling.testing.mock.osgi.context.ContextPlugin; |
| import org.apache.sling.testing.mock.osgi.context.ContextPlugins; |
| import org.apache.sling.testing.mock.osgi.context.OsgiContextImpl; |
| import org.apache.sling.testing.mock.sling.ResourceResolverType; |
| import org.jetbrains.annotations.NotNull; |
| import org.osgi.annotation.versioning.ProviderType; |
| |
| /** |
| * Builder class for creating {@link SlingContext} instances with different sets of parameters. |
| */ |
| @ProviderType |
| public final class SlingContextBuilder { |
| |
| private final @NotNull ContextPlugins plugins = new ContextPlugins(); |
| private ResourceResolverType resourceResolverType; |
| private Map<String, Object> resourceResolverFactoryActivatorProps; |
| private boolean registerSlingModelsFromClassPath = true; |
| |
| /** |
| * Create builder with default resource resolver type. |
| */ |
| public SlingContextBuilder() {} |
| |
| /** |
| * Create builder with given resource resolver type. |
| * @param resourceResolverType Resource resolver type. |
| */ |
| public SlingContextBuilder(@NotNull ResourceResolverType resourceResolverType) { |
| this.resourceResolverType(resourceResolverType); |
| } |
| |
| /** |
| * @param resourceResolverType Resource resolver type. |
| * @return this |
| */ |
| public @NotNull SlingContextBuilder resourceResolverType(@NotNull ResourceResolverType resourceResolverType) { |
| this.resourceResolverType = resourceResolverType; |
| return this; |
| } |
| |
| /** |
| * @param <T> context type |
| * @param plugin Context plugin which listens to context lifecycle events. |
| * @return this |
| */ |
| @SafeVarargs |
| public final @NotNull <T extends OsgiContextImpl> SlingContextBuilder plugin(@NotNull ContextPlugin<T> @NotNull ... plugin) { |
| plugins.addPlugin(plugin); |
| return this; |
| } |
| |
| /** |
| * @param <T> context type |
| * @param beforeSetUpCallback Allows the application to register an own callback function that is called before the built-in setup rules are executed. |
| * @return this |
| */ |
| @SafeVarargs |
| public final @NotNull <T extends OsgiContextImpl> SlingContextBuilder beforeSetUp(@NotNull ContextCallback<T> @NotNull ... beforeSetUpCallback) { |
| plugins.addBeforeSetUpCallback(beforeSetUpCallback); |
| return this; |
| } |
| |
| /** |
| * @param <T> context type |
| * @param afterSetUpCallback Allows the application to register an own callback function that is called after the built-in setup rules are executed. |
| * @return this |
| */ |
| @SafeVarargs |
| public final @NotNull <T extends OsgiContextImpl> SlingContextBuilder afterSetUp(@NotNull ContextCallback<T> @NotNull ... afterSetUpCallback) { |
| plugins.addAfterSetUpCallback(afterSetUpCallback); |
| return this; |
| } |
| |
| /** |
| * @param <T> context type |
| * @param beforeTearDownCallback Allows the application to register an own callback function that is called before the built-in teardown rules are executed. |
| * @return this |
| */ |
| @SafeVarargs |
| public final @NotNull <T extends OsgiContextImpl> SlingContextBuilder beforeTearDown(@NotNull ContextCallback<T> @NotNull ... beforeTearDownCallback) { |
| plugins.addBeforeTearDownCallback(beforeTearDownCallback); |
| return this; |
| } |
| |
| /** |
| * @param <T> context type |
| * @param afterTearDownCallback Allows the application to register an own callback function that is after before the built-in teardown rules are executed. |
| * @return this |
| */ |
| @SafeVarargs |
| public final @NotNull <T extends OsgiContextImpl> SlingContextBuilder afterTearDown(@NotNull ContextCallback<T> @NotNull ... afterTearDownCallback) { |
| plugins.addAfterTearDownCallback(afterTearDownCallback); |
| return this; |
| } |
| |
| /** |
| * Allows to override OSGi configuration parameters for the Resource Resolver Factory Activator service. |
| * @param props Configuration properties |
| * @return this |
| */ |
| public @NotNull SlingContextBuilder resourceResolverFactoryActivatorProps(@NotNull Map<String, Object> props) { |
| this.resourceResolverFactoryActivatorProps = props; |
| return this; |
| } |
| |
| /** |
| * Automatic registering of all Sling Models found in the classpath on startup (active by default). |
| * @param registerSlingModelsFromClassPath If set to false Sling Models are not registered automatically from the classpath on startup. |
| * @return this |
| */ |
| public @NotNull SlingContextBuilder registerSlingModelsFromClassPath(boolean registerSlingModelsFromClassPath) { |
| this.registerSlingModelsFromClassPath = registerSlingModelsFromClassPath; |
| return this; |
| } |
| |
| /** |
| * @return Build {@link SlingContext} instance. |
| */ |
| public @NotNull SlingContext build() { |
| return new SlingContext(this.plugins, |
| this.resourceResolverFactoryActivatorProps, |
| this.resourceResolverType, |
| this.registerSlingModelsFromClassPath); |
| } |
| |
| } |