com.helger.servlet.mock

Class MockServletContext

java.lang.Object

com.helger.servlet.mock.MockServletContext

All Implemented Interfaces:

IServletContext300To310Migration, IServletContext310To400Migration, javax.servlet.ServletContext

@NotThreadSafe
public class MockServletContext
extends Object
implements IServletContext310To400Migration

Mock implementation of the ServletContext interface.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVLET_CONTEXT_NAME
static String	DEFAULT_SERVLET_CONTEXT_PATH
static int	SERVLET_SPEC_MAJOR_VERSION
static int	SERVLET_SPEC_MINOR_VERSION

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockServletContext(String sContextPath, String sResourceBasePath, com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceLoader, Map<String,String> aInitParams) Create a new MockServletContext.

Method Summary

Modifier and Type	Method and Description
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, Class<? extends javax.servlet.Filter> filterClass)
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, javax.servlet.Filter filter)
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, String className)
void	addInitParameter(String sName, String sValue)
void	addListener(Class<? extends EventListener> listenerClass)
void	addListener(String className)
<T extends EventListener> void	addListener(T t)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, Class<? extends javax.servlet.Servlet> servletClass)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, javax.servlet.Servlet servlet)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, String className)
static MockServletContext	create() Create a new MockServletContext, using no base path and no context path.
static MockServletContext	create(Map<String,String> aInitParams) Create a new MockServletContext, using no base path and no context path using the provided initialization parameters.
static MockServletContext	create(String sContextPath) Create a new MockServletContext using no base path but the provided context path.
static MockServletContext	create(String sContextPath, Map<String,String> aInitParams) Create a new MockServletContext using the provided context path and init parameters.
static MockServletContext	create(String sContextPath, String sResourceBasePath) Create a new MockServletContext using the provided context path and resource base oath.
static MockServletContext	create(String sContextPath, String sResourceBasePath, com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceLoader, Map<String,String> aInitParams) Create a new MockServletContext with all possible parameters.
<T extends javax.servlet.Filter> T	createFilter(Class<T> clazz)
<T extends EventListener> T	createListener(Class<T> clazz)
<T extends javax.servlet.Servlet> T	createServlet(Class<T> clazz)
MockServletConfig	createServletConfig(String sServletName) Create a new MockServletConfig object without servlet init parameters.
MockServletConfig	createServletConfig(String sServletName, Map<String,String> aServletInitParams) Create a new MockServletConfig object.
void	declareRoles(String... roleNames)
Object	getAttribute(String sName)
Enumeration<String>	getAttributeNames()
ClassLoader	getClassLoader()
javax.servlet.ServletContext	getContext(String sContextPath)
String	getContextPath()
com.helger.commons.collection.impl.ICommonsSet<javax.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
com.helger.commons.collection.impl.ICommonsSet<javax.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
javax.servlet.FilterRegistration	getFilterRegistration(String filterName)
com.helger.commons.collection.impl.ICommonsMap<String,? extends javax.servlet.FilterRegistration>	getFilterRegistrations()
String	getInitParameter(String sName)
Enumeration<String>	getInitParameterNames()
javax.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
String	getMimeType(String sFilename)
int	getMinorVersion()
javax.servlet.RequestDispatcher	getNamedDispatcher(String sPath) Deprecated.
String	getRealPath(String sPath)
javax.servlet.RequestDispatcher	getRequestDispatcher(String sPath)
URL	getResource(String sPath)
InputStream	getResourceAsStream(String sPath)
protected String	getResourceLocation(String sPath) Build a full resource location for the given path, prepending the resource base path of this MockServletContext.
com.helger.commons.collection.impl.ICommonsSet<String>	getResourcePaths(String sPath) Deprecated.
String	getServerInfo()
javax.servlet.Servlet	getServlet(String sName) Deprecated.
String	getServletContextName()
Enumeration<String>	getServletNames() Deprecated.
MockServletPool	getServletPool()
javax.servlet.ServletRegistration	getServletRegistration(String servletName)
com.helger.commons.collection.impl.ICommonsMap<String,? extends javax.servlet.ServletRegistration>	getServletRegistrations()
Enumeration<javax.servlet.Servlet>	getServlets() Deprecated.
javax.servlet.SessionCookieConfig	getSessionCookieConfig()
String	getVirtualServerName()
protected void	initListeners()
void	invalidate()
MockHttpServletResponse	invoke(javax.servlet.http.HttpServletRequest aHttpRequest)
static boolean	isReThrowListenerException()
void	log(Exception ex, String sMessage) Deprecated.
void	log(String sMessage)
void	log(String sMessage, Throwable ex)
void	registerContext(String sContextPath, javax.servlet.ServletContext aContext)
void	removeAttribute(String sName)
void	setAttribute(String sName, Object aValue)
void	setContextPath(String sContextPath)
boolean	setInitParameter(String sName, String sValue)
static void	setReThrowListenerException(boolean bReThrowListenerException)
void	setServletContextName(String sServletContextName)
void	setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.helger.servlet.spec.IServletContext310To400Migration

addJspFile, getRequestCharacterEncoding, getResponseCharacterEncoding, getSessionTimeout, setRequestCharacterEncoding, setResponseCharacterEncoding, setSessionTimeout

Field Detail

SERVLET_SPEC_MAJOR_VERSION

public static final int SERVLET_SPEC_MAJOR_VERSION

See Also:

Constant Field Values

SERVLET_SPEC_MINOR_VERSION

public static final int SERVLET_SPEC_MINOR_VERSION

See Also:

Constant Field Values

DEFAULT_SERVLET_CONTEXT_NAME

public static final String DEFAULT_SERVLET_CONTEXT_NAME

See Also:

Constant Field Values

DEFAULT_SERVLET_CONTEXT_PATH

public static final String DEFAULT_SERVLET_CONTEXT_PATH

See Also:

Constant Field Values

Constructor Detail

MockServletContext

protected MockServletContext(@Nullable
                             String sContextPath,
                             @Nullable
                             String sResourceBasePath,
                             @Nullable
                             com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceLoader,
                             @Nullable
                             Map<String,String> aInitParams)

Create a new MockServletContext.

Parameters:

sContextPath - The context path to use

sResourceBasePath - the WAR root directory (should not end with a slash)

aResourceLoader - the IReadableResourceProvider to use (or null for the default)

aInitParams - Optional map with initialization parameters

Method Detail

isReThrowListenerException

public static boolean isReThrowListenerException()

Returns:

true if runtime exceptions from context listeners should be propagated to the outside or if they should be logged and processing should continue. Default is false.

setReThrowListenerException

public static void setReThrowListenerException(boolean bReThrowListenerException)

Parameters:

bReThrowListenerException - true to re-throw listener exceptions (on context inited and destroyed)

initListeners

@OverrideOnDemand
protected void initListeners()

getResourceLocation

@Nonnull
protected String getResourceLocation(@Nonnull
                                               String sPath)

Build a full resource location for the given path, prepending the resource base path of this MockServletContext.

Parameters:

sPath - the path as specified

Returns:

the full resource path

setContextPath

public final void setContextPath(@Nullable
                                 String sContextPath)

getContextPath

@Nonnull
public String getContextPath()

Specified by:

getContextPath in interface javax.servlet.ServletContext

registerContext

public void registerContext(@Nonnull
                            String sContextPath,
                            @Nonnull
                            javax.servlet.ServletContext aContext)

getContext

@Nullable
public javax.servlet.ServletContext getContext(@Nullable
                                                          String sContextPath)

Specified by:

getContext in interface javax.servlet.ServletContext

getMajorVersion

@Nonnegative
public int getMajorVersion()

Specified by:

getMajorVersion in interface javax.servlet.ServletContext

getMinorVersion

@Nonnegative
public int getMinorVersion()

Specified by:

getMinorVersion in interface javax.servlet.ServletContext

getMimeType

@Nullable
public String getMimeType(@Nonnull
                                     String sFilename)

Specified by:

getMimeType in interface javax.servlet.ServletContext

getResourcePaths

@UnsupportedOperation
 @Deprecated
public com.helger.commons.collection.impl.ICommonsSet<String> getResourcePaths(String sPath)

Deprecated.

Specified by:

getResourcePaths in interface javax.servlet.ServletContext

getResource

@Nullable
public URL getResource(@Nonnull
                                  String sPath)
                           throws MalformedURLException

Specified by:

getResource in interface javax.servlet.ServletContext

Throws:

MalformedURLException

getResourceAsStream

@Nullable
public InputStream getResourceAsStream(@Nonnull
                                                  String sPath)

Specified by:

getResourceAsStream in interface javax.servlet.ServletContext

getRequestDispatcher

@Nonnull
public javax.servlet.RequestDispatcher getRequestDispatcher(@Nonnull
                                                                      String sPath)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletContext

getNamedDispatcher

@Nullable
 @Deprecated
public javax.servlet.RequestDispatcher getNamedDispatcher(@Nullable
                                                                                   String sPath)

Deprecated.

Specified by:

getNamedDispatcher in interface javax.servlet.ServletContext

getServlet

@Deprecated
public javax.servlet.Servlet getServlet(@Nullable
                                                     String sName)

Deprecated.

Specified by:

getServlet in interface javax.servlet.ServletContext

getServlets

@Deprecated
 @Nonnull
public Enumeration<javax.servlet.Servlet> getServlets()

Deprecated.

Specified by:

getServlets in interface javax.servlet.ServletContext

getServletNames

@Deprecated
 @Nonnull
public Enumeration<String> getServletNames()

Deprecated.

Specified by:

getServletNames in interface javax.servlet.ServletContext

log

public void log(@Nullable
                String sMessage)

Specified by:

log in interface javax.servlet.ServletContext

log

@Deprecated
public void log(@Nullable
                             Exception ex,
                             @Nullable
                             String sMessage)

Deprecated.

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(@Nullable
                String sMessage,
                @Nullable
                Throwable ex)

Specified by:

log in interface javax.servlet.ServletContext

getRealPath

@Nonnull
public String getRealPath(@Nonnull
                                    String sPath)

Specified by:

getRealPath in interface javax.servlet.ServletContext

getServerInfo

@Nonnull
 @Nonempty
public String getServerInfo()

Specified by:

getServerInfo in interface javax.servlet.ServletContext

getInitParameter

@Nullable
public String getInitParameter(@Nonnull
                                          String sName)

Specified by:

getInitParameter in interface javax.servlet.ServletContext

addInitParameter

public final void addInitParameter(@Nonnull
                                   String sName,
                                   @Nonnull
                                   String sValue)

getInitParameterNames

@Nonnull
public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletContext

getAttribute

@Nullable
public Object getAttribute(@Nonnull
                                      String sName)

Specified by:

getAttribute in interface javax.servlet.ServletContext

getAttributeNames

@Nonnull
public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletContext

setAttribute

public final void setAttribute(@Nonnull
                               String sName,
                               @Nullable
                               Object aValue)

Specified by:

setAttribute in interface javax.servlet.ServletContext

removeAttribute

public void removeAttribute(@Nonnull
                            String sName)

Specified by:

removeAttribute in interface javax.servlet.ServletContext

setServletContextName

public void setServletContextName(@Nullable
                                  String sServletContextName)

getServletContextName

@Nullable
public String getServletContextName()

Specified by:

getServletContextName in interface javax.servlet.ServletContext

createServletConfig

@Nonnull
public MockServletConfig createServletConfig(@Nonnull @Nonempty
                                                       String sServletName)

Create a new MockServletConfig object without servlet init parameters.

Parameters:

sServletName - Name of the servlet. May neither be null nor empty.

Returns:

A new MockServletConfig object for this servlet context.

createServletConfig

@Nonnull
public MockServletConfig createServletConfig(@Nonnull @Nonempty
                                                       String sServletName,
                                                       @Nullable
                                                       Map<String,String> aServletInitParams)

Create a new MockServletConfig object.

Parameters:

sServletName - Name of the servlet. May neither be null nor empty.

aServletInitParams - The map with all servlet init parameters. May be null or empty.

Returns:

A new MockServletConfig object for this servlet context.

getServletPool

@Nonnull
public MockServletPool getServletPool()

Returns:

The servlet pool for registering mock servlets.

invoke

@Nullable
public MockHttpServletResponse invoke(@Nonnull
                                                 javax.servlet.http.HttpServletRequest aHttpRequest)

invalidate

public void invalidate()

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

Specified by:

getEffectiveMajorVersion in interface javax.servlet.ServletContext

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

Specified by:

getEffectiveMinorVersion in interface javax.servlet.ServletContext

setInitParameter

public boolean setInitParameter(String sName,
                                String sValue)

Specified by:

setInitParameter in interface javax.servlet.ServletContext

addServlet

@UnsupportedOperation
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                                                   String className)

Specified by:

addServlet in interface javax.servlet.ServletContext

addServlet

@UnsupportedOperation
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                                                   javax.servlet.Servlet servlet)

Specified by:

addServlet in interface javax.servlet.ServletContext

addServlet

@UnsupportedOperation
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                                                   Class<? extends javax.servlet.Servlet> servletClass)

Specified by:

addServlet in interface javax.servlet.ServletContext

createServlet

@UnsupportedOperation
public <T extends javax.servlet.Servlet> T createServlet(Class<T> clazz)
                                                                         throws javax.servlet.ServletException

Specified by:

createServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServletRegistration

@UnsupportedOperation
public javax.servlet.ServletRegistration getServletRegistration(String servletName)

Specified by:

getServletRegistration in interface javax.servlet.ServletContext

getServletRegistrations

@UnsupportedOperation
public com.helger.commons.collection.impl.ICommonsMap<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()

Specified by:

getServletRegistrations in interface javax.servlet.ServletContext

addFilter

@UnsupportedOperation
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                                                 String className)

Specified by:

addFilter in interface javax.servlet.ServletContext

addFilter

@UnsupportedOperation
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                                                 javax.servlet.Filter filter)

Specified by:

addFilter in interface javax.servlet.ServletContext

addFilter

@UnsupportedOperation
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                                                 Class<? extends javax.servlet.Filter> filterClass)

Specified by:

addFilter in interface javax.servlet.ServletContext

createFilter

@UnsupportedOperation
public <T extends javax.servlet.Filter> T createFilter(Class<T> clazz)
                                                                       throws javax.servlet.ServletException

Specified by:

createFilter in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getFilterRegistration

@UnsupportedOperation
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)

Specified by:

getFilterRegistration in interface javax.servlet.ServletContext

getFilterRegistrations

@UnsupportedOperation
public com.helger.commons.collection.impl.ICommonsMap<String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()

Specified by:

getFilterRegistrations in interface javax.servlet.ServletContext

getSessionCookieConfig

@UnsupportedOperation
public javax.servlet.SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface javax.servlet.ServletContext

setSessionTrackingModes

@UnsupportedOperation
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Specified by:

setSessionTrackingModes in interface javax.servlet.ServletContext

getDefaultSessionTrackingModes

@UnsupportedOperation
public com.helger.commons.collection.impl.ICommonsSet<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface javax.servlet.ServletContext

getEffectiveSessionTrackingModes

@UnsupportedOperation
public com.helger.commons.collection.impl.ICommonsSet<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext

addListener

@UnsupportedOperation
public void addListener(String className)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

@UnsupportedOperation
public <T extends EventListener> void addListener(T t)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

@UnsupportedOperation
public void addListener(Class<? extends EventListener> listenerClass)

Specified by:

addListener in interface javax.servlet.ServletContext

createListener

@UnsupportedOperation
public <T extends EventListener> T createListener(Class<T> clazz)
                                                                  throws javax.servlet.ServletException

Specified by:

createListener in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getJspConfigDescriptor

@UnsupportedOperation
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface javax.servlet.ServletContext

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface javax.servlet.ServletContext

declareRoles

@UnsupportedOperation
public void declareRoles(String... roleNames)

Specified by:

declareRoles in interface javax.servlet.ServletContext

getVirtualServerName

public String getVirtualServerName()

Specified by:

getVirtualServerName in interface IServletContext300To310Migration

Specified by:

getVirtualServerName in interface javax.servlet.ServletContext

create

@Nonnull
public static MockServletContext create()

Create a new MockServletContext, using no base path and no context path. The initialization listeners are triggered automatically.

Returns:

The created MockServletContext

create

@Nonnull
public static MockServletContext create(@Nullable
                                                  Map<String,String> aInitParams)

Create a new MockServletContext, using no base path and no context path using the provided initialization parameters. The initialization listeners are triggered automatically.

Parameters:

aInitParams - The init parameter. May be null.

Returns:

The created MockServletContext

create

@Nonnull
public static MockServletContext create(@Nullable
                                                  String sContextPath)

Create a new MockServletContext using no base path but the provided context path. The initialization listeners are triggered automatically.

Parameters:

sContextPath - The context path to use. May be null.

Returns:

The created MockServletContext

create

@Nonnull
public static MockServletContext create(@Nullable
                                                  String sContextPath,
                                                  @Nullable
                                                  Map<String,String> aInitParams)

Create a new MockServletContext using the provided context path and init parameters. The initialization listeners are triggered automatically.

Parameters:

sContextPath - Context path to use. May be null.

aInitParams - The init parameter. May be null.

Returns:

The created MockServletContext

create

@Nonnull
public static MockServletContext create(@Nullable
                                                  String sContextPath,
                                                  @Nullable
                                                  String sResourceBasePath)

Create a new MockServletContext using the provided context path and resource base oath. The initialization listeners are triggered automatically.

Parameters:

sContextPath - The context path to use. May be null.

sResourceBasePath - the WAR root directory (should not end with a slash). May be null.

Returns:

The created MockServletContext

create

@Nonnull
public static MockServletContext create(@Nullable
                                                  String sContextPath,
                                                  @Nullable
                                                  String sResourceBasePath,
                                                  @Nullable
                                                  com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceLoader,
                                                  @Nullable
                                                  Map<String,String> aInitParams)

Create a new MockServletContext with all possible parameters.

Parameters:

sContextPath - The context path to use. May be null.

sResourceBasePath - the WAR root directory (should not end with a slash). May be null.

aResourceLoader - the IReadableResourceProvider to use. May be null.

aInitParams - Optional map with initialization parameters. May be null.

Returns:

The created MockServletContext