com.phloc.webscopes.impl.GlobalWebScope 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.impl;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import jakarta.servlet.ServletContext;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.scopes.impl.GlobalScope;
import com.phloc.webscopes.MetaWebScopeFactory;
import com.phloc.webscopes.domain.IApplicationWebScope;
import com.phloc.webscopes.domain.IGlobalWebScope;

/**
 * Implementation of the {@link IGlobalWebScope} interface for web applications.

 * Note: for synchronization issues, this class does not store the attributes in
 * the passed {@link ServletContext} but in a separate map.
 * 
 * @author Philip Helger
 */
@ThreadSafe
public final class GlobalWebScope extends GlobalScope implements IGlobalWebScope
{
  public interface IContextPathProvider extends Serializable
  {
    @Nonnull
    String getContextPath ();
  }

  // Because of transient field
  private static final long serialVersionUID = 15665138713664L;

  private final transient ServletContext m_aSC;
  private final IContextPathProvider m_aContextPathProvider;

  @Nonnull
  @Nonempty
  private static String _createScopeID (@Nonnull final ServletContext aServletContext)
  {
    String ret = aServletContext.getServletContextName ();
    if (ret == null)
    {
      //  element is missing in web.xml
      ret = "phloc-scopes-global";
    }
    return ret;
  }

  /**
   * Create a new {@link GlobalWebScope}. No objects are copied from the passed
   * {@link ServletContext} so this must be one of the very first action
   * 
   * @param aServletContext
   *        The servlet context to use. May not be null.
   * @param aContextPathProvider
   *        The context path provider. This is so weird, because the method
   *        aServletContext.getContextPath () is only available in
   *        Servlet API ≥ 2.5. May not be null.
   */
  public GlobalWebScope (@Nonnull final ServletContext aServletContext,
                         @Nonnull final IContextPathProvider aContextPathProvider)
  {
    super (_createScopeID (aServletContext));

    m_aSC = aServletContext;
    m_aContextPathProvider = ValueEnforcer.notNull (aContextPathProvider, "ContextPathProvider");
  }

  @Override
  @Nonnull
  protected IApplicationWebScope createApplicationScope (@Nonnull @Nonempty final String sApplicationID)
  {
    return MetaWebScopeFactory.getWebScopeFactory ().createApplicationScope (sApplicationID);
  }

  @Override
  @Nullable
  public IApplicationWebScope getApplicationScope (@Nonnull @Nonempty final String sApplicationID,
                                                   final boolean bCreateIfNotExisting)
  {
    return (IApplicationWebScope) super.getApplicationScope (sApplicationID, bCreateIfNotExisting);
  }

  @Nonnull
  public ServletContext getServletContext ()
  {
    return m_aSC;
  }

  @Override
  @Nonnull
  public String getContextPath ()
  {
    // Must invoke the provider on demand, because with servlet-api < 2.5 there
    // is no method ServletContext.getContextPath and therefore it must be taken
    // from the request scope!!
    return m_aContextPathProvider.getContextPath ();
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return false;
    final GlobalWebScope rhs = (GlobalWebScope) o;
    return getContextPath ().equals (rhs.getContextPath ());
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ()).append (getContextPath ()).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ())
                            .append ("servletContext", m_aSC)
                            .append ("contextPathProvider", m_aContextPathProvider)
                            .toString ();
  }
}