com.helger.commons.scope.mgr.IScopeFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.
 */
package com.helger.commons.scope.mgr;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.Nonempty;
import com.helger.commons.scope.IApplicationScope;
import com.helger.commons.scope.IGlobalScope;
import com.helger.commons.scope.IRequestScope;
import com.helger.commons.scope.ISessionApplicationScope;
import com.helger.commons.scope.ISessionScope;

/**
 * Interface for a non-web scope factory.
 *
 * @author Philip Helger
 */
public interface IScopeFactory
{
  /**
   * Create a new global scope.
   *
   * @param sScopeID
   *        The scope ID to use. May neither be null nor empty.
   * @return Never null.
   */
  @Nonnull
  IGlobalScope createGlobalScope (@Nonnull @Nonempty String sScopeID);

  /**
   * Create a new application scope
   *
   * @param sScopeID
   *        The scope ID to use
   * @return Never null.
   */
  @Nonnull
  IApplicationScope createApplicationScope (@Nonnull @Nonempty String sScopeID);

  /**
   * Create a new session scope
   *
   * @param sScopeID
   *        The scope ID to use
   * @return Never null.
   */
  @Nonnull
  ISessionScope createSessionScope (@Nonnull @Nonempty String sScopeID);

  /**
   * Create a new session application scope
   *
   * @param sScopeID
   *        The scope ID to use
   * @return Never null.
   */
  @Nonnull
  ISessionApplicationScope createSessionApplicationScope (@Nonnull @Nonempty String sScopeID);

  /**
   * Create a new request scope
   *
   * @param sScopeID
   *        The scope ID to use. May neither be null nor empty.
   * @param sSessionID
   *        The session scope ID to use. May be null.
   * @return Never null.
   */
  @Nonnull
  IRequestScope createRequestScope (@Nonnull @Nonempty String sScopeID, @Nonnull @Nonempty String sSessionID);
}