org.apache.myfaces.test.mock
Class MockServletContext

java.lang.Object
  extended by 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

Constructor Summary
MockServletContext()
           
 
Method Summary
 void addAttributeListener(javax.servlet.ServletContextAttributeListener listener)
          Add a new listener instance that should be notified about attribute changes.
 void addInitParameter(String name, String value)
          Add a context initialization parameter to the set of parameters recognized by this instance.
 void addMimeType(String extension, String contentType)
          Add a new MIME type mapping to the set of mappings recognized by this instance.
 Object getAttribute(String name)
          
 Enumeration getAttributeNames()
          
 javax.servlet.ServletContext getContext(String uripath)
          
 String getContextPath()
          
 String getInitParameter(String name)
          
 Enumeration getInitParameterNames()
          
 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()
          
 Enumeration getServlets()
          
 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 setDocumentRoot(File documentRoot)
          Set the document root for getRealPath() resolution.
 void setDocumentRoot(URI base)
           
 
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

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


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.