org.apache.myfaces.test.mock
Class MockHttpServletRequest

java.lang.Object
  extended by org.apache.myfaces.test.mock.MockHttpServletRequest
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class MockHttpServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest

Mock implementation of HttpServletContext.

$Id$

Since:
1.0.0

Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
MockHttpServletRequest()
           
MockHttpServletRequest(javax.servlet.http.HttpSession session)
           
MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString)
           
MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString, javax.servlet.http.HttpSession session)
           
 
Method Summary
 void addAttributeListener(javax.servlet.ServletRequestAttributeListener listener)
          Add a new listener instance that should be notified about attribute changes.
 void addCookie(javax.servlet.http.Cookie c)
           
 void addDateHeader(String name, long value)
          Add a date-valued header for this request.
 void addHeader(String name, String value)
          Add a String-valued header for this request.
 void addIntHeader(String name, int value)
          Add an integer-valued header for this request.
 void addParameter(String name, String value)
          Add a request parameter for this request.
 Object getAttribute(String name)
          
 Enumeration getAttributeNames()
          
 String getAuthType()
          
 String getCharacterEncoding()
          
 int getContentLength()
          
 String getContentType()
          
 String getContextPath()
          
 javax.servlet.http.Cookie[] getCookies()
          
 long getDateHeader(String name)
          
 String getHeader(String name)
          
 Enumeration getHeaderNames()
          
 Enumeration getHeaders(String name)
          
 javax.servlet.ServletInputStream getInputStream()
          
 int getIntHeader(String name)
          
 String getLocalAddr()
          
 Locale getLocale()
          
 Enumeration getLocales()
          
 String getLocalName()
          
 int getLocalPort()
          
 String getMethod()
          
 String getParameter(String name)
          
 Map getParameterMap()
          
 Enumeration getParameterNames()
          
 String[] getParameterValues(String name)
          
 String getPathInfo()
          
 String getPathTranslated()
          
 String getProtocol()
          
 String getQueryString()
          
 BufferedReader getReader()
          
 String getRealPath(String path)
          
 String getRemoteAddr()
          
 String getRemoteHost()
          
 int getRemotePort()
          
 String getRemoteUser()
          
 javax.servlet.RequestDispatcher getRequestDispatcher(String path)
          
 String getRequestedSessionId()
          
 String getRequestURI()
          
 StringBuffer getRequestURL()
          
 String getScheme()
          
 String getServerName()
          
 int getServerPort()
          
 javax.servlet.ServletContext getServletContext()
          Return the ServletContext associated with this request.
 String getServletPath()
          
 javax.servlet.http.HttpSession getSession()
          
 javax.servlet.http.HttpSession getSession(boolean create)
          
 Principal getUserPrincipal()
          
 boolean isRequestedSessionIdFromCookie()
          
 boolean isRequestedSessionIdFromUrl()
          
 boolean isRequestedSessionIdFromURL()
          
 boolean isRequestedSessionIdValid()
          
 boolean isSecure()
          
 boolean isUserInRole(String role)
          
 void removeAttribute(String name)
          
 void setAttribute(String name, Object value)
          
 void setCharacterEncoding(String characterEncoding)
          
 void setHttpSession(javax.servlet.http.HttpSession session)
          Set the HttpSession associated with this request.
 void setInputStream(MockServletInputStream stream)
           
 void setLocale(Locale locale)
          Set the Locale associated with this request.
 void setMethod(String method)
           
 void setPathElements(String contextPath, String servletPath, String pathInfo, String queryString)
          Set the parsed path elements associated with this request.
 void setServletContext(javax.servlet.ServletContext servletContext)
          Set the ServletContext associated with this request.
 void setUserPrincipal(Principal principal)
          Set the Principal associated with this request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockHttpServletRequest

public MockHttpServletRequest()

MockHttpServletRequest

public MockHttpServletRequest(javax.servlet.http.HttpSession session)

MockHttpServletRequest

public MockHttpServletRequest(String contextPath,
                              String servletPath,
                              String pathInfo,
                              String queryString)

MockHttpServletRequest

public MockHttpServletRequest(String contextPath,
                              String servletPath,
                              String pathInfo,
                              String queryString,
                              javax.servlet.http.HttpSession session)
Method Detail

addAttributeListener

public void addAttributeListener(javax.servlet.ServletRequestAttributeListener listener)

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

Parameters:
listener - The new listener to register

addDateHeader

public void addDateHeader(String name,
                          long value)

Add a date-valued header for this request.

Parameters:
name - Header name
value - Header value

addHeader

public void addHeader(String name,
                      String value)

Add a String-valued header for this request.

Parameters:
name - Header name
value - Header value

addIntHeader

public void addIntHeader(String name,
                         int value)

Add an integer-valued header for this request.

Parameters:
name - Header name
value - Header value

addParameter

public void addParameter(String name,
                         String value)

Add a request parameter for this request.

Parameters:
name - Parameter name
value - Parameter value

addCookie

public void addCookie(javax.servlet.http.Cookie c)

getServletContext

public javax.servlet.ServletContext getServletContext()

Return the ServletContext associated with this request.


setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession session)

Set the HttpSession associated with this request.

Parameters:
session - The new session

setLocale

public void setLocale(Locale locale)

Set the Locale associated with this request.

Parameters:
locale - The new locale

setPathElements

public void setPathElements(String contextPath,
                            String servletPath,
                            String pathInfo,
                            String queryString)

Set the parsed path elements associated with this request.

Parameters:
contextPath - The context path
servletPath - The servlet path
pathInfo - The extra path information
queryString - The query string

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Set the ServletContext associated with this request.

Parameters:
servletContext - The new servlet context

setUserPrincipal

public void setUserPrincipal(Principal principal)

Set the Principal associated with this request.

Parameters:
principal - The new Principal

setMethod

public void setMethod(String method)

getAuthType

public String getAuthType()

Specified by:
getAuthType in interface javax.servlet.http.HttpServletRequest

getContextPath

public String getContextPath()

Specified by:
getContextPath in interface javax.servlet.http.HttpServletRequest

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:
getCookies in interface javax.servlet.http.HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:
getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:
getHeader in interface javax.servlet.http.HttpServletRequest

getHeaderNames

public Enumeration getHeaderNames()

Specified by:
getHeaderNames in interface javax.servlet.http.HttpServletRequest

getHeaders

public Enumeration getHeaders(String name)

Specified by:
getHeaders in interface javax.servlet.http.HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:
getIntHeader in interface javax.servlet.http.HttpServletRequest

getMethod

public String getMethod()

Specified by:
getMethod in interface javax.servlet.http.HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:
getPathInfo in interface javax.servlet.http.HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:
getPathTranslated in interface javax.servlet.http.HttpServletRequest

getQueryString

public String getQueryString()

Specified by:
getQueryString in interface javax.servlet.http.HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:
getRemoteUser in interface javax.servlet.http.HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:
getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:
getRequestURI in interface javax.servlet.http.HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:
getRequestURL in interface javax.servlet.http.HttpServletRequest

getServletPath

public String getServletPath()

Specified by:
getServletPath in interface javax.servlet.http.HttpServletRequest

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:
getSession in interface javax.servlet.http.HttpServletRequest

getSession

public javax.servlet.http.HttpSession getSession(boolean create)

Specified by:
getSession in interface javax.servlet.http.HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:
getUserPrincipal in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:
isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Specified by:
isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:
isUserInRole in interface javax.servlet.http.HttpServletRequest

getAttribute

public Object getAttribute(String name)

Specified by:
getAttribute in interface javax.servlet.ServletRequest

getAttributeNames

public Enumeration getAttributeNames()

Specified by:
getAttributeNames in interface javax.servlet.ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:
getCharacterEncoding in interface javax.servlet.ServletRequest

getContentLength

public int getContentLength()

Specified by:
getContentLength in interface javax.servlet.ServletRequest

getContentType

public String getContentType()

Specified by:
getContentType in interface javax.servlet.ServletRequest

getInputStream

public javax.servlet.ServletInputStream getInputStream()

Specified by:
getInputStream in interface javax.servlet.ServletRequest

setInputStream

public void setInputStream(MockServletInputStream stream)

getLocale

public Locale getLocale()

Specified by:
getLocale in interface javax.servlet.ServletRequest

getLocales

public Enumeration getLocales()

Specified by:
getLocales in interface javax.servlet.ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:
getLocalAddr in interface javax.servlet.ServletRequest

getLocalName

public String getLocalName()

Specified by:
getLocalName in interface javax.servlet.ServletRequest

getLocalPort

public int getLocalPort()

Specified by:
getLocalPort in interface javax.servlet.ServletRequest

getParameter

public String getParameter(String name)

Specified by:
getParameter in interface javax.servlet.ServletRequest

getParameterMap

public Map getParameterMap()

Specified by:
getParameterMap in interface javax.servlet.ServletRequest

getParameterNames

public Enumeration getParameterNames()

Specified by:
getParameterNames in interface javax.servlet.ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:
getParameterValues in interface javax.servlet.ServletRequest

getProtocol

public String getProtocol()

Specified by:
getProtocol in interface javax.servlet.ServletRequest

getReader

public BufferedReader getReader()

Specified by:
getReader in interface javax.servlet.ServletRequest

getRealPath

public String getRealPath(String path)

Specified by:
getRealPath in interface javax.servlet.ServletRequest

getRemoteAddr

public String getRemoteAddr()

Specified by:
getRemoteAddr in interface javax.servlet.ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:
getRemoteHost in interface javax.servlet.ServletRequest

getRemotePort

public int getRemotePort()

Specified by:
getRemotePort in interface javax.servlet.ServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

Specified by:
getRequestDispatcher in interface javax.servlet.ServletRequest

getScheme

public String getScheme()

Specified by:
getScheme in interface javax.servlet.ServletRequest

getServerName

public String getServerName()

Specified by:
getServerName in interface javax.servlet.ServletRequest

getServerPort

public int getServerPort()

Specified by:
getServerPort in interface javax.servlet.ServletRequest

isSecure

public boolean isSecure()

Specified by:
isSecure in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:
removeAttribute in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:
setAttribute in interface javax.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Specified by:
setCharacterEncoding in interface javax.servlet.ServletRequest


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