All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.phloc.web.mock.MockServletContext Maven / Gradle / Ivy

    /**
 * Copyright (C) 2006-2015 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.web.mock;

import java.io.File;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Enumeration;
import java.util.EventListener;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterRegistration;
import jakarta.servlet.RequestDispatcher;
import jakarta.servlet.Servlet;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletContextEvent;
import jakarta.servlet.ServletContextListener;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRegistration;
import jakarta.servlet.ServletRegistration.Dynamic;
import jakarta.servlet.SessionCookieConfig;
import jakarta.servlet.SessionTrackingMode;
import jakarta.servlet.descriptor.JspConfigDescriptor;
import jakarta.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.phloc.commons.SystemProperties;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.UnsupportedOperation;
import com.phloc.commons.collections.ContainerHelper;
import com.phloc.commons.io.IReadableResource;
import com.phloc.commons.io.IReadableResourceProvider;
import com.phloc.commons.io.resourceprovider.DefaultResourceProvider;
import com.phloc.commons.mime.MimeTypeDeterminator;
import com.phloc.commons.string.StringHelper;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

//ESCA-JAVA0116:
/**
 * Mock implementation of the {@link ServletContext} interface.
 *
 * @author Boris Gregorcic
 */
@NotThreadSafe
public class MockServletContext implements ServletContext
{
  public static final int SERVLET_SPEC_MAJOR_VERSION = 3;
  public static final int SERVLET_SPEC_MINOR_VERSION = 0;
  public static final String DEFAULT_SERVLET_CONTEXT_NAME = "MockServletContext"; //$NON-NLS-1$
  public static final String DEFAULT_SERVLET_CONTEXT_PATH = ""; //$NON-NLS-1$
  private static final Logger s_aLogger = LoggerFactory.getLogger (MockServletContext.class);

  private final IReadableResourceProvider m_aResourceProvider;
  private final String m_sResourceBasePath;
  private String m_sContextPath = DEFAULT_SERVLET_CONTEXT_PATH;
  private final Map  m_aContexts = new HashMap  ();
  private final Properties m_aInitParameters = new Properties ();
  private final Map  m_aAttributes = new HashMap  ();
  private String m_sServletContextName = DEFAULT_SERVLET_CONTEXT_NAME;
  private final MockServletPool m_aServletPool;
  private boolean m_bInvalidated = false;

  /**
   * Create a new MockServletContext, using no base path and a
   * DefaultIResourceProvider (i.e. the classpath root as WAR root).
   */
  public MockServletContext ()
  {
    this (null, "", null, null); //$NON-NLS-1$
  }

  /**
   * Create a new MockServletContext, using no base path and a
   * DefaultIResourceProvider (i.e. the classpath root as WAR root).
   *
   * @param aInitParams
   *        The init parameter
   */
  public MockServletContext (@Nullable final Map  aInitParams)
  {
    this (null, "", null, aInitParams); //$NON-NLS-1$
  }

  /**
   * Create a new MockServletContext.
   *
   * @param sContextPath
   *        The context path to use. May be null.
   */
  public MockServletContext (@Nullable final String sContextPath)
  {
    this (sContextPath, "", null, null); //$NON-NLS-1$
  }

  /**
   * Create a new MockServletContext.
   *
   * @param sContextPath
   *        Context path to use. May be null.
   * @param aInitParams
   *        The init parameter The context path to use
   */
  public MockServletContext (@Nullable final String sContextPath, @Nullable final Map  aInitParams)
  {
    this (sContextPath, "", null, aInitParams); //$NON-NLS-1$
  }

  /**
   * Create a new MockServletContext.
   *
   * @param sContextPath
   *        The context path to use
   * @param sResourceBasePath
   *        the WAR root directory (should not end with a slash)
   */
  public MockServletContext (@Nullable final String sContextPath, @Nullable final String sResourceBasePath)
  {
    this (sContextPath, sResourceBasePath, null, null);
  }

  /**
   * Create a new MockServletContext.
   *
   * @param sContextPath
   *        The context path to use
   * @param sResourceBasePath
   *        the WAR root directory (should not end with a slash)
   * @param aResourceLoader
   *        the IReadableResourceProvider to use (or null for the default)
   * @param aInitParams
   *        A map containing initialization parameters
   */
  public MockServletContext (@Nullable final String sContextPath,
                             @Nullable final String sResourceBasePath,
                             @Nullable final IReadableResourceProvider aResourceLoader,
                             @Nullable final Map  aInitParams)
  {
    setContextPath (sContextPath);
    this.m_aResourceProvider = aResourceLoader != null ? aResourceLoader : new DefaultResourceProvider ();
    this.m_sResourceBasePath = sResourceBasePath != null ? sResourceBasePath : ""; //$NON-NLS-1$

    // Use JVM temp dir as ServletContext temp dir.
    final String sTempDir = SystemProperties.getTmpDir ();
    if (sTempDir != null)
      setAttribute ("tempdir", new File (sTempDir)); //$NON-NLS-1$

    if (aInitParams != null)
      for (final Map.Entry  aEntry : aInitParams.entrySet ())
        addInitParameter (aEntry.getKey (), aEntry.getValue ());

    // Invoke all event listeners
    final ServletContextEvent aSCE = new ServletContextEvent (this);
    for (final ServletContextListener aListener : MockHttpListener.getAllServletContextListeners ())
      aListener.contextInitialized (aSCE);

    this.m_aServletPool = new MockServletPool (this);
  }

  /**
   * Build a full resource location for the given path, prepending the resource
   * base path of this MockServletContext.
   *
   * @param sPath
   *        the path as specified
   * @return the full resource path
   */
  @Nonnull
  protected String getResourceLocation (@Nonnull final String sPath)
  {
    return StringHelper.startsWith (sPath, '/') ? this.m_sResourceBasePath + sPath
                                                : this.m_sResourceBasePath + "/" + sPath; //$NON-NLS-1$
  }

  public final void setContextPath (@Nullable final String sContextPath)
  {
    if (sContextPath == null)
      this.m_sContextPath = ""; //$NON-NLS-1$
    else
      if (StringHelper.startsWith (sContextPath, '/'))
        this.m_sContextPath = sContextPath;
      else
        this.m_sContextPath = "/" + sContextPath; //$NON-NLS-1$
  }

  /* This is a Servlet API 2.5 method. */
  @Override
  @Nonnull
  public String getContextPath ()
  {
    return this.m_sContextPath;
  }

  public void registerContext (@Nonnull final String sContextPath, @Nonnull final ServletContext aContext)
  {
    ValueEnforcer.notNull (sContextPath, "ContextPath"); //$NON-NLS-1$
    ValueEnforcer.notNull (aContext, "Context"); //$NON-NLS-1$
    this.m_aContexts.put (sContextPath, aContext);
  }

  @Override
  @Nullable
  public ServletContext getContext (@Nullable final String sContextPath)
  {
    if (this.m_sContextPath.equals (sContextPath))
      return this;
    return this.m_aContexts.get (sContextPath);
  }

  @Override
  @Nonnegative
  public int getMajorVersion ()
  {
    return SERVLET_SPEC_MAJOR_VERSION;
  }

  @Override
  @Nonnegative
  public int getMinorVersion ()
  {
    return SERVLET_SPEC_MINOR_VERSION;
  }

  @Override
  @Nullable
  public String getMimeType (@Nonnull final String sFilename)
  {
    return MimeTypeDeterminator.getMimeTypeFromFilename (sFilename);
  }

  @Override
  @UnsupportedOperation
  @Deprecated
  public Set  getResourcePaths (final String sPath)
  {
    throw new UnsupportedOperationException ();
  }

  @Override
  @Nullable
  public URL getResource (@Nonnull final String sPath) throws MalformedURLException
  {
    final IReadableResource aResource = this.m_aResourceProvider.getReadableResource (getResourceLocation (sPath));
    if (!aResource.exists ())
      return null;
    return aResource.getAsURL ();
  }

  @Override
  @Nullable
  public InputStream getResourceAsStream (@Nonnull final String sPath)
  {
    final IReadableResource aResource = this.m_aResourceProvider.getReadableResource (getResourceLocation (sPath));
    if (!aResource.exists ())
      return null;
    return aResource.getInputStream ();
  }

  @Override
  @Nonnull
  public RequestDispatcher getRequestDispatcher (@Nonnull final String sPath)
  {
    if (!StringHelper.startsWith (sPath, '/'))
      throw new IllegalArgumentException ("RequestDispatcher path at ServletContext level must start with '/'"); //$NON-NLS-1$
    return new MockRequestDispatcher (sPath);
  }

  @Override
  @Nullable
  @Deprecated
  public RequestDispatcher getNamedDispatcher (@Nullable final String sPath)
  {
    return null;
  }

  @Override
  public void log (@Nullable final String message)
  {
    s_aLogger.info (message);
  }

  @Override
  public void log (@Nullable final String sMessage, @Nullable final Throwable ex)
  {
    s_aLogger.info (sMessage, ex);
  }

  @Override
  @Nonnull
  @SuppressFBWarnings ("RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE")
  public String getRealPath (@Nonnull final String sPath)
  {
    final IReadableResource aResource = this.m_aResourceProvider.getReadableResource (getResourceLocation (sPath));
    if (aResource == null)
      throw new IllegalStateException ("Failed to get real path of '" + sPath + "'"); //$NON-NLS-1$ //$NON-NLS-2$
    final File aFile = aResource.getAsFile ();
    if (aFile == null)
      throw new IllegalStateException ("Failed to convert resource " + aResource + " to a file"); //$NON-NLS-1$ //$NON-NLS-2$
    return aFile.getAbsolutePath ();
  }

  @Override
  @Nonnull
  @Nonempty
  public String getServerInfo ()
  {
    return "MockServletContext"; //$NON-NLS-1$
  }

  @Override
  @Nullable
  public String getInitParameter (@Nonnull final String sName)
  {
    ValueEnforcer.notNull (sName, "Name"); //$NON-NLS-1$
    return this.m_aInitParameters.getProperty (sName);
  }

  public final void addInitParameter (@Nonnull final String sName, @Nonnull final String sValue)
  {
    ValueEnforcer.notNull (sName, "Name"); //$NON-NLS-1$
    ValueEnforcer.notNull (sValue, "Value"); //$NON-NLS-1$
    this.m_aInitParameters.setProperty (sName, sValue);
  }

  @Override
  @Nonnull
  public Enumeration  getInitParameterNames ()
  {
    final List  aParams = ContainerHelper.newList ();
    final Enumeration  aKeyEnum = this.m_aInitParameters.keys ();
    while (aKeyEnum.hasMoreElements ())
    {
      final Object aKey = aKeyEnum.nextElement ();
      aParams.add (aKey == null ? null : String.valueOf (aKey));
    }
    return ContainerHelper.getEnumeration (aParams);
  }

  @Override
  @Nullable
  public Object getAttribute (@Nonnull final String sName)
  {
    ValueEnforcer.notNull (sName, "Name"); //$NON-NLS-1$
    return this.m_aAttributes.get (sName);
  }

  @Override
  @Nonnull
  public Enumeration  getAttributeNames ()
  {
    return ContainerHelper.getEnumeration (this.m_aAttributes.keySet ());
  }

  @Override
  public final void setAttribute (@Nonnull final String sName, @Nullable final Object aValue)
  {
    ValueEnforcer.notNull (sName, "Name"); //$NON-NLS-1$
    if (aValue != null)
      this.m_aAttributes.put (sName, aValue);
    else
      this.m_aAttributes.remove (sName);
  }

  @Override
  public void removeAttribute (@Nonnull final String sName)
  {
    ValueEnforcer.notNull (sName, "Name"); //$NON-NLS-1$
    this.m_aAttributes.remove (sName);
  }

  public void setServletContextName (@Nullable final String sServletContextName)
  {
    this.m_sServletContextName = sServletContextName;
  }

  @Override
  @Nullable
  public String getServletContextName ()
  {
    return this.m_sServletContextName;
  }

  /**
   * Create a new {@link MockServletConfig} object without servlet init
   * parameters.
   *
   * @param sServletName
   *        Name of the servlet. May neither be null nor empty.
   * @return A new {@link MockServletConfig} object for this servlet context.
   */
  @Nonnull
  public MockServletConfig createServletConfig (@Nonnull @Nonempty final String sServletName)
  {
    return createServletConfig (sServletName, null);
  }

  /**
   * Create a new {@link MockServletConfig} object.
   *
   * @param sServletName
   *        Name of the servlet. May neither be null nor empty.
   * @param aServletInitParams
   *        The map with all servlet init parameters. May be null
   *        or empty.
   * @return A new {@link MockServletConfig} object for this servlet context.
   */
  @Nonnull
  public MockServletConfig createServletConfig (@Nonnull @Nonempty final String sServletName,
                                                @Nullable final Map  aServletInitParams)
  {
    return new MockServletConfig (this, sServletName, aServletInitParams);
  }

  /**
   * @return The servlet pool for registering mock servlets.
   */
  @Nonnull
  public MockServletPool getServletPool ()
  {
    return this.m_aServletPool;
  }

  @Nullable
  public MockHttpServletResponse invoke (@Nonnull final HttpServletRequest aHttpRequest)
  {
    ValueEnforcer.notNull (aHttpRequest, "HttpRequest"); //$NON-NLS-1$

    // Find matching servlet
    final String sServletPath = aHttpRequest.getServletPath ();
    final Servlet aServlet = this.m_aServletPool.getServletOfPath (sServletPath);
    if (aServlet == null)
    {
      s_aLogger.error ("Found no servlet matching '" + sServletPath + "'"); //$NON-NLS-1$ //$NON-NLS-2$
      return null;
    }

    // Main invocation
    final MockHttpServletResponse ret = new MockHttpServletResponse ();
    try
    {
      aServlet.service (aHttpRequest, ret);
    }
    catch (final Throwable t)
    {
      throw new IllegalStateException ("Failed to invoke servlet " + aServlet + " for request " + aHttpRequest, t); //$NON-NLS-1$ //$NON-NLS-2$
    }
    return ret;
  }

  public void invalidate ()
  {
    if (this.m_bInvalidated)
      throw new IllegalStateException ("Servlet context already invalidated!"); //$NON-NLS-1$
    this.m_bInvalidated = true;

    // Destroy all servlets
    this.m_aServletPool.invalidate ();

    // Call all HTTP listener
    final ServletContextEvent aSCE = new ServletContextEvent (this);
    for (final ServletContextListener aListener : MockHttpListener.getAllServletContextListeners ())
      aListener.contextDestroyed (aSCE);

    this.m_aAttributes.clear ();
  }

  @Override
  public int getEffectiveMajorVersion ()
  {
    return getMajorVersion ();
  }

  @Override
  public int getEffectiveMinorVersion ()
  {
    return getMinorVersion ();
  }

  @Override
  public boolean setInitParameter (final String name, final String value)
  {
    // TODO Auto-generated method stub
    return false;
  }

  @Override
  public Dynamic addServlet (final String servletName, final String className)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Dynamic addServlet (final String servletName, final Servlet servlet)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Dynamic addServlet (final String servletName, final Class  servletClass)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public  T createServlet (final Class  clazz) throws ServletException
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public ServletRegistration getServletRegistration (final String servletName)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Map  getServletRegistrations ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public jakarta.servlet.FilterRegistration.Dynamic addFilter (final String filterName, final String className)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public jakarta.servlet.FilterRegistration.Dynamic addFilter (final String filterName, final Filter filter)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public jakarta.servlet.FilterRegistration.Dynamic addFilter (final String filterName,
                                                             final Class  filterClass)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public  T createFilter (final Class  clazz) throws ServletException
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public FilterRegistration getFilterRegistration (final String filterName)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Map  getFilterRegistrations ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public SessionCookieConfig getSessionCookieConfig ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public void setSessionTrackingModes (final Set  sessionTrackingModes)
  {
    // TODO Auto-generated method stub

  }

  @Override
  public Set  getDefaultSessionTrackingModes ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Set  getEffectiveSessionTrackingModes ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public void addListener (final String className)
  {
    // TODO Auto-generated method stub

  }

  @Override
  public  void addListener (final T t)
  {
    // TODO Auto-generated method stub

  }

  @Override
  public void addListener (final Class  listenerClass)
  {
    // TODO Auto-generated method stub

  }

  @Override
  public  T createListener (final Class  clazz) throws ServletException
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public JspConfigDescriptor getJspConfigDescriptor ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public ClassLoader getClassLoader ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public void declareRoles (final String... roleNames)
  {
    // TODO Auto-generated method stub

  }

  @Override
  public String getVirtualServerName ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public Dynamic addJspFile (String arg0, String arg1)
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public String getRequestCharacterEncoding ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public String getResponseCharacterEncoding ()
  {
    // TODO Auto-generated method stub
    return null;
  }

  @Override
  public int getSessionTimeout ()
  {
    // TODO Auto-generated method stub
    return 0;
  }

  @Override
  public void setRequestCharacterEncoding (String arg0)
  {
    // TODO Auto-generated method stub
    
  }

  @Override
  public void setResponseCharacterEncoding (String arg0)
  {
    // TODO Auto-generated method stub
    
  }

  @Override
  public void setSessionTimeout (int arg0)
  {
    // TODO Auto-generated method stub
    
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy