MockHttpServletRequest (JCMS API)

java.lang.Object
- com.jalios.jcms.test.MockHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MockHttpServletRequest
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest
```
This is a fake HttpServletRequest meant to be use for testing Warning: There is almost no logic inside this class, it only serve as a container for all the information that will be given through the constructor.

Since:

jcms-5.7.4

Version:

$Revision: 101813 $

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description
`MockHttpServletRequest(javax.servlet.http.HttpSession session)`
`MockHttpServletRequest(javax.servlet.http.HttpSession session, java.lang.String scheme, java.lang.String serverName, int serverPort, java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString, java.util.Hashtable parameterMap, java.util.HashMap attributeMap, java.util.HashMap headerMap)`
`MockHttpServletRequest(javax.servlet.http.HttpSession session, java.lang.String scheme, java.lang.String serverName, int serverPort, java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString, java.util.Hashtable parameterMap, java.util.HashMap attributeMap, java.util.HashMap headerMap, java.lang.String method, java.lang.String remoteAddr)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse arg0)`
`void`	`clearAttributes()`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`java.util.Enumeration`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration`	`getHeaderNames()`
`java.util.Enumeration`	`getHeaders(java.lang.String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(java.lang.String name)`
`java.lang.String`	`getLocalAddr()`
`java.util.Locale`	`getLocale()`
`java.util.Enumeration`	`getLocales()`
`java.lang.String`	`getLocalName()`
`int`	`getLocalPort()`
`java.lang.String`	`getMethod()`
`java.lang.String`	`getParameter(java.lang.String name)`
`java.util.Map`	`getParameterMap()`
`java.util.Enumeration`	`getParameterNames()`
`java.lang.String[]`	`getParameterValues(java.lang.String name)`
`java.lang.String`	`getPathInfo()`
`java.lang.String`	`getPathTranslated()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getQueryString()`
`java.io.BufferedReader`	`getReader()`
`java.lang.String`	`getRealPath(java.lang.String path)`
`java.lang.String`	`getRemoteAddr()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(java.lang.String path)`
`java.lang.String`	`getRequestedSessionId()`
`java.lang.String`	`getRequestURI()`
`java.lang.StringBuffer`	`getRequestURL()`
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`java.lang.String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`java.security.Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(java.lang.String role)`
`void`	`login(java.lang.String arg0, java.lang.String arg1)`
`void`	`logout()`
`void`	`removeAttribute(java.lang.String name)`
`void`	`setAttribute(java.lang.String name, java.lang.Object o)`
`void`	`setCharacterEncoding(java.lang.String env)`
`void`	`setCookies(javax.servlet.http.Cookie[] cookies)`
`void`	`setMethod(java.lang.String method)`
`void`	`setQueryString(java.lang.String queryString)`
`void`	`setRemoteAddr(java.lang.String remoteAddr)`
`void`	`setServerName(java.lang.String serverName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockHttpServletRequest
```
public MockHttpServletRequest(javax.servlet.http.HttpSession session)
```
  - MockHttpServletRequest
```
public MockHttpServletRequest(javax.servlet.http.HttpSession session,
                      java.lang.String scheme,
                      java.lang.String serverName,
                      int serverPort,
                      java.lang.String contextPath,
                      java.lang.String servletPath,
                      java.lang.String pathInfo,
                      java.lang.String queryString,
                      java.util.Hashtable parameterMap,
                      java.util.HashMap attributeMap,
                      java.util.HashMap headerMap)
```
  - MockHttpServletRequest
```
public MockHttpServletRequest(javax.servlet.http.HttpSession session,
                      java.lang.String scheme,
                      java.lang.String serverName,
                      int serverPort,
                      java.lang.String contextPath,
                      java.lang.String servletPath,
                      java.lang.String pathInfo,
                      java.lang.String queryString,
                      java.util.Hashtable parameterMap,
                      java.util.HashMap attributeMap,
                      java.util.HashMap headerMap,
                      java.lang.String method,
                      java.lang.String remoteAddr)
```
- Method Detail
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
  - setQueryString
```
public void setQueryString(java.lang.String queryString)
```
  - setMethod
```
public void setMethod(java.lang.String method)
```
  - setRemoteAddr
```
public void setRemoteAddr(java.lang.String remoteAddr)
```
  - clearAttributes
```
public void clearAttributes()
```
  - getScheme
```
public java.lang.String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public java.lang.String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getContextPath
```
public java.lang.String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public java.lang.String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getQueryString
```
public java.lang.String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getParameterMap
```
public java.util.Map getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getParameterNames
```
public java.util.Enumeration getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.Object o)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public java.util.Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - 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
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public java.util.Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public java.util.Enumeration getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getAuthType
```
public java.lang.String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - setCookies
```
public void setCookies(javax.servlet.http.Cookie[] cookies)
```
  - getMethod
```
public java.lang.String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public java.security.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(java.lang.String role)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public java.util.Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - getProtocol
```
public java.lang.String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException,
                                        java.lang.IllegalStateException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalStateException
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public java.lang.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(java.lang.String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse arg0)
                     throws java.io.IOException,
                            javax.servlet.ServletException
```
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - login
```
public void login(java.lang.String arg0,
         java.lang.String arg1)
           throws javax.servlet.ServletException
```
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Throws:
    
    javax.servlet.ServletException

Class MockHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockHttpServletRequest

MockHttpServletRequest

MockHttpServletRequest

Method Detail

setServerName

setQueryString

setMethod

setRemoteAddr

clearAttributes

getScheme

getServerName

getServerPort

getContextPath

getServletPath

getPathInfo

getQueryString

getParameterMap

getParameterNames

getParameterValues

getParameter

getAttribute

setAttribute

removeAttribute

getAttributeNames

getSession

getSession

getHeader

getHeaderNames

getRequestURI

getHeaders

getIntHeader

getDateHeader

getAuthType

getCookies

setCookies

getMethod

getPathTranslated

getRealPath

getRemoteUser

getRequestedSessionId

getRequestURL

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isUserInRole

getCharacterEncoding

getContentLength

getContentType

getInputStream

getLocale

getLocales

getProtocol

getReader

getRemoteAddr

getRemoteHost

getRemotePort

getRequestDispatcher

isSecure

setCharacterEncoding

getLocalAddr

getLocalName

getLocalPort

getServletContext

isAsyncStarted

isAsyncSupported

authenticate

login

logout