MockHstRequestBase (Hippo Site Toolkit 4.1.0 API)

java.lang.Object
- org.hippoecm.hst.mock.core.component.MockHstRequestBase

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

Direct Known Subclasses:

MockHstRequest
```
public class MockHstRequestBase
extends Object
implements javax.servlet.http.HttpServletRequest
```

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

MockHstRequestBase()

Constructors
Constructor and Description
`MockHstRequestBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(String name, Object value)`
`void`	`addParameter(String name, String value)`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse httpServletResponse)`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`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)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`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)`
`javax.servlet.http.Part`	`getPart(String s)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`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()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean arg0)`
`Principal`	`getUserPrincipal()`
`Set<String>`	`getUserRoleNames()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String roleName)`
`void`	`login(String s, String s2)`
`void`	`logout()`
`void`	`removeAttribute(String name)`
`void`	`removeParameter(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setAuthType(String authType)`
`void`	`setCharacterEncoding(String characterEncoding)`
`void`	`setContextPath(String contextPath)`
`void`	`setCookies(javax.servlet.http.Cookie[] cookies)`
`void`	`setHeader(String name, Object value)`
`void`	`setLocalAddr(String localAddr)`
`void`	`setLocale(Locale locale)`
`void`	`setLocales(List<Locale> locales)`
`void`	`setLocalName(String localName)`
`void`	`setLocalPort(int localPort)`
`void`	`setMethod(String method)`
`void`	`setPathInfo(String pathInfo)`
`void`	`setPathTranslated(String pathTranslated)`
`void`	`setProtocol(String protocol)`
`void`	`setQueryString(String queryString)`
`void`	`setRemoteAddr(String remoteAddr)`
`void`	`setRemoteHost(String remoteHost)`
`void`	`setRemoteUser(String remoteUser)`
`void`	`setRequestedSessionId(String requestedSessionId)`
`void`	`setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)`
`void`	`setRequestedSessionIdFromUrl(boolean requestedSessionIdFromUrl)`
`void`	`setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)`
`void`	`setRequestedSessionIdValid(boolean requestedSessionIdValid)`
`void`	`setRequestURI(String requestURI)`
`void`	`setRequestURL(StringBuffer requestURL)`
`void`	`setScheme(String scheme)`
`void`	`setServerName(String serverName)`
`void`	`setServletPath(String servletPath)`
`void`	`setSession(javax.servlet.http.HttpSession session)`
`void`	`setUserPrincipal(Principal userPrincipal)`
`void`	`setUserRoleNames(Set<String> userRoleNames)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`

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

- Constructor Detail
  - MockHstRequestBase
```
public MockHstRequestBase()
```
- Method Detail
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - setAuthType
```
public void setAuthType(String authType)
```
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - setContextPath
```
public void setContextPath(String contextPath)
```
  - 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)
```
  - 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
  - setHeader
```
public void setHeader(String name,
                      Object value)
```
  - addHeader
```
public void addHeader(String name,
                      Object value)
```
  - 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
  - setMethod
```
public void setMethod(String method)
```
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - setPathInfo
```
public void setPathInfo(String pathInfo)
```
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - setPathTranslated
```
public void setPathTranslated(String pathTranslated)
```
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - setQueryString
```
public void setQueryString(String queryString)
```
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - setRemoteUser
```
public void setRemoteUser(String remoteUser)
```
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - setRequestURI
```
public void setRequestURI(String requestURI)
```
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - setRequestURL
```
public void setRequestURL(StringBuffer requestURL)
```
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - setRequestedSessionId
```
public void setRequestedSessionId(String requestedSessionId)
```
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - setServletPath
```
public void setServletPath(String servletPath)
```
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - setSession
```
public void setSession(javax.servlet.http.HttpSession session)
```
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean arg0)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - setUserPrincipal
```
public void setUserPrincipal(Principal userPrincipal)
```
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - setRequestedSessionIdFromCookie
```
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
```
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - setRequestedSessionIdFromURL
```
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
```
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse httpServletResponse)
                     throws IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - login
```
public void login(String s,
                  String s2)
           throws javax.servlet.ServletException
```
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - getParts
```
public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
```
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(String s)
                                throws IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - setRequestedSessionIdFromUrl
```
public void setRequestedSessionIdFromUrl(boolean requestedSessionIdFromUrl)
```
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - setRequestedSessionIdValid
```
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
```
  - isUserInRole
```
public boolean isUserInRole(String roleName)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getUserRoleNames
```
public Set<String> getUserRoleNames()
```
  - setUserRoleNames
```
public void setUserRoleNames(Set<String> userRoleNames)
```
  - 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()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - setLocalAddr
```
public void setLocalAddr(String localAddr)
```
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - setLocalName
```
public void setLocalName(String localName)
```
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
  - setLocalPort
```
public void setLocalPort(int localPort)
```
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - setLocale
```
public void setLocale(Locale locale)
```
  - getLocales
```
public Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - setLocales
```
public void setLocales(List<Locale> locales)
```
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - addParameter
```
public void addParameter(String name,
                         String value)
```
  - removeParameter
```
public void removeParameter(String name)
```
  - 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
  - setProtocol
```
public void setProtocol(String protocol)
```
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - 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
  - setRemoteAddr
```
public void setRemoteAddr(String remoteAddr)
```
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - setRemoteHost
```
public void setRemoteHost(String remoteHost)
```
  - 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
  - setScheme
```
public void setScheme(String scheme)
```
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - setServerName
```
public void setServerName(String serverName)
```
  - 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)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException

Class MockHstRequestBase

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockHstRequestBase

Method Detail

getAuthType

setAuthType

getContextPath

setContextPath

getCookies

setCookies

getDateHeader

getHeader

setHeader

addHeader

getHeaderNames

getHeaders

getIntHeader

getMethod

setMethod

getPathInfo

setPathInfo

getPathTranslated

setPathTranslated

getQueryString

setQueryString

getRemoteUser

setRemoteUser

getRequestURI

setRequestURI

getRequestURL

setRequestURL

getRequestedSessionId

setRequestedSessionId

getServletPath

setServletPath

getSession

setSession

getSession

getUserPrincipal

setUserPrincipal

isRequestedSessionIdFromCookie

setRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

setRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

authenticate

login

logout

getParts

getPart

setRequestedSessionIdFromUrl

isRequestedSessionIdValid

setRequestedSessionIdValid

isUserInRole

getUserRoleNames

setUserRoleNames

getAttribute

getAttributeNames

getCharacterEncoding

getContentLength

getContentType

getInputStream

getLocalAddr

setLocalAddr

getLocalName

setLocalName

getLocalPort

getServletContext

startAsync

startAsync

isAsyncStarted

isAsyncSupported

getAsyncContext

getDispatcherType

setLocalPort