io.wcm.testing.mock.aem.junit.AemContextBuilder Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2016 wcm.io
 * %%
 * Licensed 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.
 * #L%
 */
package io.wcm.testing.mock.aem.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 AemContext} instances with different sets of parameters.
 */
@ProviderType
public final class AemContextBuilder {

  private final ContextPlugins plugins = new ContextPlugins();
  private ResourceResolverType[] resourceResolverTypes;
  private Map resourceResolverFactoryActivatorProps;
  private boolean registerSlingModelsFromClassPath = true;

  /**
   * Create builder with default resource resolver type.
   */
  public AemContextBuilder() {
    // use default resource resolver type
  }

  /**
   * Create builder with given resource resolver type.
   * @param resourceResolverTypes Resource resolver type(s).
   */
  public AemContextBuilder(@NotNull ResourceResolverType @NotNull... resourceResolverTypes) {
    this.resourceResolverType(resourceResolverTypes);
  }

  /**
   * @param types Resource resolver type(s).
   * @return this
   */
  public @NotNull AemContextBuilder resourceResolverType(@NotNull ResourceResolverType @NotNull... types) {
    this.resourceResolverTypes = types;
    return this;
  }

  /**
   * @param plugin Context plugin which listens to context lifecycle events.
   * @return this
   */
  @SafeVarargs
  public final @NotNull AemContextBuilder plugin(@NotNull ContextPlugin @NotNull... plugin) {
    plugins.addPlugin(plugin);
    return this;
  }

  /**
   * @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 AemContextBuilder beforeSetUp(@NotNull ContextCallback @NotNull... beforeSetUpCallback) {
    plugins.addBeforeSetUpCallback(beforeSetUpCallback);
    return this;
  }

  /**
   * @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 AemContextBuilder afterSetUp(@NotNull ContextCallback @NotNull... afterSetUpCallback) {
    plugins.addAfterSetUpCallback(afterSetUpCallback);
    return this;
  }

  /**
   * @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 AemContextBuilder beforeTearDown(@NotNull ContextCallback @NotNull... beforeTearDownCallback) {
    plugins.addBeforeTearDownCallback(beforeTearDownCallback);
    return this;
  }

  /**
   * @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 AemContextBuilder afterTearDown(@NotNull ContextCallback @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 AemContextBuilder resourceResolverFactoryActivatorProps(@NotNull Map props) {
    this.resourceResolverFactoryActivatorProps = props;
    return this;
  }

  /**
   * Automatic registering of all Sling Models found in the classpath on startup (active by default).
   * @param value If set to false Sling Models are not registered automatically from the classpath on startup.
   * @return this
   */
  public @NotNull AemContextBuilder registerSlingModelsFromClassPath(boolean value) {
    this.registerSlingModelsFromClassPath = value;
    return this;
  }

  /**
   * @return Build {@link AemContext} instance.
   */
  public @NotNull AemContext build() {
    return new AemContext(this.plugins,
        this.resourceResolverFactoryActivatorProps,
        this.registerSlingModelsFromClassPath,
        this.resourceResolverTypes);
  }

}