MockServletContext (eXo PLF:: WS :: HTTP :: testframework 6.1.0 API)

java.lang.Object
- org.exoplatform.services.test.mock.MockServletContext

All Implemented Interfaces:

javax.servlet.ServletContext
```
public class MockServletContext
extends Object
implements javax.servlet.ServletContext
```
The Class MockServletContext.

Version:

$Id: $

Author:

Max Shaposhnik

Field Summary
- Fields inherited from interface javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors
Constructor and Description
`MockServletContext()` Instantiates a new mock servlet context.
`MockServletContext(String name)` Instantiates a new mock servlet context.
`MockServletContext(String name, String path)` Instantiates a new mock servlet context.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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`	`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)`
`<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)`
`void`	`declareRoles(String... roleNames)`
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()`
`javax.servlet.ServletContext`	`getContext(String s)`
`String`	`getContextPath()`
`Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()`
`int`	`getEffectiveMajorVersion()`
`int`	`getEffectiveMinorVersion()`
`Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()`
`javax.servlet.FilterRegistration`	`getFilterRegistration(String filterName)`
`Map<String,? extends javax.servlet.FilterRegistration>`	`getFilterRegistrations()`
`String`	`getInitParameter(String name)`
`Enumeration`	`getInitParameterNames()`
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()`
`String`	`getLogBuffer()` Gets the log buffer.
`int`	`getMajorVersion()`
`String`	`getMimeType(String s)`
`int`	`getMinorVersion()`
`javax.servlet.RequestDispatcher`	`getNamedDispatcher(String s)`
`String`	`getRealPath(String s)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String s)`
`URL`	`getResource(String s)`
`InputStream`	`getResourceAsStream(String s)`
`Set`	`getResourcePaths(String s)`
`String`	`getServerInfo()`
`javax.servlet.Servlet`	`getServlet(String s)` Deprecated.
`String`	`getServletContextName()`
`Enumeration`	`getServletNames()` Deprecated.
`javax.servlet.ServletRegistration`	`getServletRegistration(String servletName)`
`Map<String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()`
`Enumeration`	`getServlets()` Deprecated.
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()`
`void`	`log(Exception e, String s)` Deprecated.
`void`	`log(String s)`
`void`	`log(String s, Throwable throwable)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setContextPath(String s)` Sets the context path.
`boolean`	`setInitParameter(String name, String value)` Sets the init parameter.
`void`	`setName(String name)` Sets the name.
`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

- Constructor Detail
  - MockServletContext
```
public MockServletContext()
```
    Instantiates a new mock servlet context.
  - MockServletContext
```
public MockServletContext(String name)
```
    Instantiates a new mock servlet context.
    
    Parameters:
    
    name - the name
  - MockServletContext
```
public MockServletContext(String name,
                          String path)
```
    Instantiates a new mock servlet context.
    
    Parameters:
    
    name - the name
    
    path - the path
- Method Detail
  - setName
```
public void setName(String name)
```
    Sets the name.
    
    Parameters:
    
    name - the new name
  - getLogBuffer
```
public String getLogBuffer()
```
    Gets the log buffer.
    
    Returns:
    
    the log buffer
  - getContext
```
public javax.servlet.ServletContext getContext(String s)
```
    Specified by:
    
    getContext in interface javax.servlet.ServletContext
  - getMajorVersion
```
public int getMajorVersion()
```
    Specified by:
    
    getMajorVersion in interface javax.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    Specified by:
    
    getMinorVersion in interface javax.servlet.ServletContext
  - getMimeType
```
public String getMimeType(String s)
```
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
  - getResourcePaths
```
public Set getResourcePaths(String s)
```
    Specified by:
    
    getResourcePaths in interface javax.servlet.ServletContext
  - getResource
```
public URL getResource(String s)
                throws MalformedURLException
```
    Specified by:
    
    getResource in interface javax.servlet.ServletContext
    
    Throws:
    
    MalformedURLException
  - getResourceAsStream
```
public InputStream getResourceAsStream(String s)
```
    Specified by:
    
    getResourceAsStream in interface javax.servlet.ServletContext
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String s)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletContext
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String s)
```
    Specified by:
    
    getNamedDispatcher in interface javax.servlet.ServletContext
  - getServlet
```
@Deprecated
public javax.servlet.Servlet getServlet(String s)
                                             throws javax.servlet.ServletException
```
    Deprecated.
    
    Specified by:
    
    getServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getServlets
```
@Deprecated
public Enumeration getServlets()
```
    Deprecated.
    
    Specified by:
    
    getServlets in interface javax.servlet.ServletContext
  - getServletNames
```
@Deprecated
public Enumeration getServletNames()
```
    Deprecated.
    
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - log
```
public void log(String s)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
@Deprecated
public void log(Exception e,
                            String s)
```
    Deprecated.
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
public void log(String s,
                Throwable throwable)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - setContextPath
```
public void setContextPath(String s)
```
    Sets the context path.
    
    Parameters:
    
    s - the new context path
  - getRealPath
```
public String getRealPath(String s)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletContext
  - getServerInfo
```
public String getServerInfo()
```
    Specified by:
    
    getServerInfo in interface javax.servlet.ServletContext
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    Sets the init parameter.
    
    Specified by:
    
    setInitParameter in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - the name
    
    value - the value
  - 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
  - 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
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletContext
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletContext
  - getServletContextName
```
public String getServletContextName()
```
    Specified by:
    
    getServletContextName in interface javax.servlet.ServletContext
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.ServletContext
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    Specified by:
    
    getEffectiveMajorVersion in interface javax.servlet.ServletContext
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Specified by:
    
    getEffectiveMinorVersion in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> servletClass)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - createServlet
```
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
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    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
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          String className)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          javax.servlet.Filter filter)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          Class<? extends javax.servlet.Filter> filterClass)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - createFilter
```
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
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    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
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Specified by:
    
    getSessionCookieConfig in interface javax.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Specified by:
    
    setSessionTrackingModes in interface javax.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Specified by:
    
    getDefaultSessionTrackingModes in interface javax.servlet.ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Specified by:
    
    getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(String className)
```
    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
  - addListener
```
public void addListener(Class<? extends EventListener> listenerClass)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - createListener
```
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
```
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
```
public void declareRoles(String... roleNames)
```
    Specified by:
    
    declareRoles in interface javax.servlet.ServletContext

Class MockServletContext

Field Summary

Fields inherited from interface javax.servlet.ServletContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockServletContext

MockServletContext

MockServletContext

Method Detail

setName

getLogBuffer

getContext

getMajorVersion

getMinorVersion

getMimeType

getResourcePaths

getResource

getResourceAsStream

getRequestDispatcher

getNamedDispatcher

getServlet

getServlets

getServletNames

log

log

log

setContextPath

getRealPath

getServerInfo

setInitParameter

getInitParameter

getInitParameterNames

getAttribute

getAttributeNames

setAttribute

removeAttribute

getServletContextName

getContextPath

getEffectiveMajorVersion

getEffectiveMinorVersion

addServlet

addServlet

addServlet

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getJspConfigDescriptor

getClassLoader

declareRoles