com.phloc.webscopes.singleton.SessionApplicationWebSingleton Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.webscopes.singleton;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.scopes.AbstractSingleton;
import com.phloc.webscopes.domain.ISessionApplicationWebScope;
import com.phloc.webscopes.mgr.WebScopeManager;

/**
 * This is the base class for singleton objects that reside in the
 * session-application scope.
 * 
 * @see com.phloc.webscopes.mgr.EWebScope#SESSION_APPLICATION
 * @author Philip Helger
 */
public abstract class SessionApplicationWebSingleton extends AbstractSingleton implements Serializable
{
  protected SessionApplicationWebSingleton ()
  {
    super ("getSessionApplicationSingleton"); //$NON-NLS-1$
  }

  private void writeObject (@Nonnull final ObjectOutputStream aOOS) throws IOException
  {
    writeAbstractSingletonFields (aOOS);
  }

  private void readObject (@Nonnull final ObjectInputStream aOIS) throws IOException
  {
    readAbstractSingletonFields (aOIS);
  }

  /**
   * @param bCreateIfNotExisting
   *        if true the scope will be created if it is not existing
   * @return The scope to be used for this type of singleton.
   */
  @Nonnull
  private static ISessionApplicationWebScope _getStaticScope (final boolean bCreateIfNotExisting)
  {
    return WebScopeManager.getSessionApplicationScope (bCreateIfNotExisting);
  }

  /**
   * Get the singleton object for the passed class in the session application
   * web scope corresponding to the passed application ID. If the singleton is
   * not yet instantiated, a new instance is created.

   * 

   * NOTE: This is useful when no request scope is available
   * 
   * @param 
   *        Implementation type of the singleton
   * @param aClass
   *        The class to be used. May not be null. The class must
   *        be public as needs to have a public no-argument constructor.
   * @param sApplicationID
   *        The application ID to use for determining the application session
   *        scope
   * @return The singleton object and never null.
   */
  @Nonnull
  protected static final  T getSessionApplicationSingleton (@Nonnull final Class  aClass,
                                                                                                      @Nonnull final String sApplicationID)
  {
    return getSingleton (WebScopeManager.getSessionApplicationScope (sApplicationID, true), aClass);
  }

  /**
   * Get the singleton object in the current session application web scope,
   * using the passed class. If the singleton is not yet instantiated, a new
   * instance is created.
   * 
   * @param 
   *        Implementation type of the singleton
   * @param aClass
   *        The class to be used. May not be null. The class must
   *        be public as needs to have a public no-argument constructor.
   * @return The singleton object and never null.
   */
  @Nonnull
  protected static final  T getSessionApplicationSingleton (@Nonnull final Class  aClass)
  {
    return getSingleton (_getStaticScope (true), aClass);
  }

  /**
   * Get the singleton object if it is already instantiated inside the current
   * session application web scope or null if it is not
   * instantiated.
   * 
   * @param 
   *        Implementation type of the singleton
   * @param aClass
   *        The class to be checked. May not be null.
   * @return The singleton for the specified class is already instantiated,
   *         null otherwise.
   */
  @Nullable
  public static final  T getSessionApplicationSingletonIfInstantiated (@Nonnull final Class  aClass)
  {
    return getSingletonIfInstantiated (_getStaticScope (false), aClass);
  }

  /**
   * Check if a singleton is already instantiated inside the current session
   * application web scope
   * 
   * @param aClass
   *        The class to be checked. May not be null.
   * @return true if the singleton for the specified class is
   *         already instantiated, false otherwise.
   */
  public static final boolean isSessionApplicationSingletonInstantiated (@Nonnull final Class  aClass)
  {
    return isSingletonInstantiated (_getStaticScope (false), aClass);
  }

  /**
   * Get all singleton objects registered in the current session application web
   * scope.
   * 
   * @return A non-null list with all instances of this class in
   *         the current session application web scope.
   */
  @Nonnull
  public static final List  getAllSessionApplicationSingletons ()
  {
    return getAllSingletons (_getStaticScope (false), SessionApplicationWebSingleton.class);
  }
}