org.apache.myfaces.test.mock

Class MockServletContext

java.lang.Object

org.apache.myfaces.test.mock.MockServletContext

All Implemented Interfaces:

javax.servlet.ServletContext

public class MockServletContext
extends Object
implements javax.servlet.ServletContext

Mock implementation of ServletContext.

WARNING - Before you can get meaningful results from calls to the getResource(), getResourceAsStream(), getResourcePaths(), or getRealPath() methods, you must configure the documentRoot property, passing in a File object pointing at a directory that simulates a web application structure.

$Id$

Since:

1.0.0

Field Summary

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor and Description
MockServletContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeListener(javax.servlet.ServletContextAttributeListener listener) Add a new listener instance that should be notified about attribute changes.
javax.servlet.FilterRegistration.Dynamic	addFilter(String string, Class<? extends javax.servlet.Filter> type)
javax.servlet.FilterRegistration.Dynamic	addFilter(String string, javax.servlet.Filter filter)
javax.servlet.FilterRegistration.Dynamic	addFilter(String string, String string1)
void	addInitParameter(String name, String value) Add a context initialization parameter to the set of parameters recognized by this instance.
void	addListener(Class<? extends EventListener> type)
void	addListener(String string)
<T extends EventListener> void	addListener(T t)
void	addMimeType(String extension, String contentType) Add a new MIME type mapping to the set of mappings recognized by this instance.
javax.servlet.ServletRegistration.Dynamic	addServlet(String name, Class<? extends javax.servlet.Servlet> type)
javax.servlet.ServletRegistration.Dynamic	addServlet(String name, javax.servlet.Servlet srvlt)
javax.servlet.ServletRegistration.Dynamic	addServlet(String name, String string1)
void	addServletRegistration(String name, String servletClassName, String... mappings)
<T extends javax.servlet.Filter> T	createFilter(Class<T> type)
<T extends EventListener> T	createListener(Class<T> type)
<T extends javax.servlet.Servlet> T	createServlet(Class<T> type)
void	declareRoles(String... strings)
Object	getAttribute(String name)
Enumeration	getAttributeNames()
ClassLoader	getClassLoader()
javax.servlet.ServletContext	getContext(String uripath)
String	getContextPath()
Set<javax.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
Set<javax.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
javax.servlet.FilterRegistration	getFilterRegistration(String string)
Map<String,? extends javax.servlet.FilterRegistration>	getFilterRegistrations()
String	getInitParameter(String name)
Enumeration	getInitParameterNames()
javax.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
String	getMimeType(String path)
int	getMinorVersion()
javax.servlet.RequestDispatcher	getNamedDispatcher(String name)
String	getRealPath(String path)
javax.servlet.RequestDispatcher	getRequestDispatcher(String path)
URL	getResource(String path)
InputStream	getResourceAsStream(String path)
Set	getResourcePaths(String path)
String	getServerInfo()
javax.servlet.Servlet	getServlet(String name)
String	getServletContextName()
Enumeration	getServletNames()
javax.servlet.ServletRegistration	getServletRegistration(String name)
Map<String,? extends javax.servlet.ServletRegistration>	getServletRegistrations()
Enumeration	getServlets()
javax.servlet.SessionCookieConfig	getSessionCookieConfig()
MockWebContainer	getWebContainer()
void	log(Exception exception, String message)
void	log(String message)
void	log(String message, Throwable exception)
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setClassLoader(ClassLoader classLoader)
void	setDocumentRoot(File documentRoot) Set the document root for getRealPath() resolution.
void	setDocumentRoot(URI base)
boolean	setInitParameter(String name, String value)
void	setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> set)
void	setWebContainer(MockWebContainer container)

Methods inherited from class java.lang.Object

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

Constructor Detail

MockServletContext

public MockServletContext()

Method Detail

addInitParameter

public void addInitParameter(String name,
                    String value)

Add a context initialization parameter to the set of parameters recognized by this instance.

Parameters:

name - Parameter name

value - Parameter value

addMimeType

public void addMimeType(String extension,
               String contentType)

Add a new MIME type mapping to the set of mappings recognized by this instance.

Parameters:

extension - Extension to check for (without the period)

contentType - Corresponding content type

setDocumentRoot

public void setDocumentRoot(File documentRoot)

Set the document root for getRealPath() resolution. This parameter MUST represent a directory.

Parameters:

documentRoot - The new base directory

setDocumentRoot

public void setDocumentRoot(URI base)

addAttributeListener

public void addAttributeListener(javax.servlet.ServletContextAttributeListener listener)

Add a new listener instance that should be notified about attribute changes.

Parameters:

listener - Listener to be added

getWebContainer

public MockWebContainer getWebContainer()

setWebContainer

public void setWebContainer(MockWebContainer container)

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface javax.servlet.ServletContext

getAttributeNames

public Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface javax.servlet.ServletContext

getInitParameterNames

public Enumeration getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletContext

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface javax.servlet.ServletContext

getMimeType

public String getMimeType(String path)

Specified by:

getMimeType in interface javax.servlet.ServletContext

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface javax.servlet.ServletContext

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface javax.servlet.ServletContext

getResource

public URL getResource(String path)
                throws MalformedURLException

Specified by:

getResource in interface javax.servlet.ServletContext

Throws:

MalformedURLException

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in interface javax.servlet.ServletContext

getResourcePaths

public Set getResourcePaths(String path)

Specified by:

getResourcePaths in interface javax.servlet.ServletContext

log

public void log(String message)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(Exception exception,
       String message)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(String message,
       Throwable exception)

Specified by:

log in interface javax.servlet.ServletContext

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.servlet.ServletContext

setAttribute

public void setAttribute(String name,
                Object value)

Specified by:

setAttribute in interface javax.servlet.ServletContext

getContext

public javax.servlet.ServletContext getContext(String uripath)

Specified by:

getContext in interface javax.servlet.ServletContext

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface javax.servlet.ServletContext

getServlet

public javax.servlet.Servlet getServlet(String name)
                                 throws javax.servlet.ServletException

Specified by:

getServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServletContextName

public String getServletContextName()

Specified by:

getServletContextName in interface javax.servlet.ServletContext

getServerInfo

public String getServerInfo()

Specified by:

getServerInfo in interface javax.servlet.ServletContext

getServlets

public Enumeration getServlets()

Specified by:

getServlets in interface javax.servlet.ServletContext

getServletNames

public Enumeration getServletNames()

Specified by:

getServletNames in interface javax.servlet.ServletContext

getNamedDispatcher

public javax.servlet.RequestDispatcher getNamedDispatcher(String name)

Specified by:

getNamedDispatcher in interface javax.servlet.ServletContext

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletContext

setInitParameter

public boolean setInitParameter(String name,
                       String value)

Specified by:

setInitParameter in interface javax.servlet.ServletContext

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(String name,
                                                   String string1)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException

Specified by:

addServlet in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(String name,
                                                   javax.servlet.Servlet srvlt)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException

Specified by:

addServlet in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(String name,
                                                   Class<? extends javax.servlet.Servlet> type)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException

Specified by:

addServlet in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

createServlet

public <T extends javax.servlet.Servlet> T createServlet(Class<T> type)
                                              throws javax.servlet.ServletException

Specified by:

createServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServletRegistration

public javax.servlet.ServletRegistration getServletRegistration(String name)

Specified by:

getServletRegistration in interface javax.servlet.ServletContext

getServletRegistrations

public Map<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()

Specified by:

getServletRegistrations in interface javax.servlet.ServletContext

addServletRegistration

public void addServletRegistration(String name,
                          String servletClassName,
                          String... mappings)

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(String string,
                                                 String string1)
                                                   throws IllegalArgumentException,
                                                          IllegalStateException

Specified by:

addFilter in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(String string,
                                                 javax.servlet.Filter filter)
                                                   throws IllegalArgumentException,
                                                          IllegalStateException

Specified by:

addFilter in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(String string,
                                                 Class<? extends javax.servlet.Filter> type)
                                                   throws IllegalArgumentException,
                                                          IllegalStateException

Specified by:

addFilter in interface javax.servlet.ServletContext

Throws:

IllegalArgumentException

IllegalStateException

createFilter

public <T extends javax.servlet.Filter> T createFilter(Class<T> type)
                                            throws javax.servlet.ServletException

Specified by:

createFilter in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getFilterRegistration

public javax.servlet.FilterRegistration getFilterRegistration(String string)

Specified by:

getFilterRegistration in interface javax.servlet.ServletContext

getFilterRegistrations

public Map<String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()

Specified by:

getFilterRegistrations in interface javax.servlet.ServletContext

addListener

public void addListener(Class<? extends EventListener> type)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

public void addListener(String string)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

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

Specified by:

addListener in interface javax.servlet.ServletContext

createListener

public <T extends EventListener> T createListener(Class<T> type)
                                       throws javax.servlet.ServletException

Specified by:

createListener in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

declareRoles

public void declareRoles(String... strings)

Specified by:

declareRoles in interface javax.servlet.ServletContext

getSessionCookieConfig

public javax.servlet.SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface javax.servlet.ServletContext

setSessionTrackingModes

public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> set)

Specified by:

setSessionTrackingModes in interface javax.servlet.ServletContext

getDefaultSessionTrackingModes

public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface javax.servlet.ServletContext

getEffectiveMajorVersion

public int getEffectiveMajorVersion()
                             throws UnsupportedOperationException

Specified by:

getEffectiveMajorVersion in interface javax.servlet.ServletContext

Throws:

UnsupportedOperationException

getEffectiveMinorVersion

public int getEffectiveMinorVersion()
                             throws UnsupportedOperationException

Specified by:

getEffectiveMinorVersion in interface javax.servlet.ServletContext

Throws:

UnsupportedOperationException

getEffectiveSessionTrackingModes

public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface javax.servlet.ServletContext

setClassLoader

public void setClassLoader(ClassLoader classLoader)

getJspConfigDescriptor

public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface javax.servlet.ServletContext