MockHttpServletRequest (Atlassian Jira

java.lang.Object
- com.atlassian.jira.mock.servlet.MockHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MockHttpServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest
```
Mock implementation of HttpServletRequest

Since:

v3.13

Constructor Summary

Constructors
Constructor and Description
`MockHttpServletRequest()`
`MockHttpServletRequest(BufferedReader bufferedReader)`
`MockHttpServletRequest(javax.servlet.http.HttpSession httpSession)` Use this constructor if you want to mock out the session returned from the request
`MockHttpServletRequest(javax.servlet.ServletInputStream servletInputStream)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MockHttpServletRequest`	`addCookie(javax.servlet.http.Cookie cookie)`
`MockHttpServletRequest`	`addCookie(String name, String value)`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String key)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String string)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String key)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String string)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String string)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`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 name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String string)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String string)`
`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 b)`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String string)`
`void`	`login(String username, String password)`
`void`	`logout()`
`void`	`removeAttribute(String string)`
`void`	`setAttribute(String key, Object value)`
`void`	`setCharacterEncoding(String encoding)`
`void`	`setContentType(String contentType)`
`MockHttpServletRequest`	`setContextPath(String contextPath)`
`MockHttpServletRequest`	`setCookies(javax.servlet.http.Cookie[] cookies)`
`MockHttpServletRequest`	`setCookies(Map<String,String> cookies)`
`void`	`setHeader(String key, String value)`
`void`	`setLocale(Locale locale)`
`void`	`setMethod(String method)`
`void`	`setParameter(String name, String value)`
`void`	`setProtocol(String protocol)`
`void`	`setRemoteAddr(String remoteAddr)`
`void`	`setRequestURL(String requestURL)`
`void`	`setServletContext(javax.servlet.ServletContext servletContext)`
`void`	`setServletPath(String servletPath)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`javax.servlet.http.Cookie[]`	`toCookies(Map<String,String> cookieMap)` Converts the key valeus of a map to an array of cookies
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`

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.ServletInputStream servletInputStream)

MockHttpServletRequest

public MockHttpServletRequest(BufferedReader bufferedReader)

MockHttpServletRequest
```
public MockHttpServletRequest(javax.servlet.http.HttpSession httpSession)
```
Use this constructor if you want to mock out the session returned from the request

Parameters:

httpSession - the session. Hint: use MockHttpSession

Method Detail

getAuthType
```
public 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 MockHttpServletRequest setCookies(javax.servlet.http.Cookie[] cookies)

setCookies

public MockHttpServletRequest setCookies(Map<String,String> cookies)

addCookie

public MockHttpServletRequest addCookie(javax.servlet.http.Cookie cookie)

addCookie

public MockHttpServletRequest addCookie(String name,
                                        String value)

toCookies
```
public javax.servlet.http.Cookie[] toCookies(Map<String,String> cookieMap)
```
Converts the key valeus of a map to an array of cookies

Parameters:

cookieMap - a map of cookies

Returns:

an array of cookies or null if its empty or null

getDateHeader
```
public long getDateHeader(String string)
```
Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader
```
public String getHeader(String key)
```
Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

setHeader

public void setHeader(String key,
                      String value)

getHeaders

public Enumeration getHeaders(String string)

getHeaderNames
```
public Enumeration getHeaderNames()
```
Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

getIntHeader
```
public int getIntHeader(String string)
```
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

getPathTranslated
```
public String getPathTranslated()
```
Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

getContextPath
```
public String getContextPath()
```

setContextPath

public MockHttpServletRequest setContextPath(String contextPath)

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

isUserInRole

public boolean isUserInRole(String string)

getUserPrincipal
```
public Principal getUserPrincipal()
```

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()
```

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(boolean b)
```
Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

getSession
```
public javax.servlet.http.HttpSession getSession()
```
Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

changeSessionId
```
public String changeSessionId()
```

isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
Specified by:

isRequestedSessionIdValid 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

getAttribute
```
public Object getAttribute(String key)
```
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

setCharacterEncoding

public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException

Throws:: UnsupportedEncodingException

getContentLength
```
public int getContentLength()
```
Specified by:

getContentLength in interface javax.servlet.ServletRequest

getContentLengthLong
```
public long getContentLengthLong()
```

getContentType
```
public String getContentType()
```
Specified by:

getContentType in interface javax.servlet.ServletRequest

setContentType

public void setContentType(String contentType)

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

Specified by:: getInputStream in interface javax.servlet.ServletRequest
Throws:: IOException

getParameter
```
public String getParameter(String name)
```
Specified by:

getParameter in interface javax.servlet.ServletRequest

setParameter

public void setParameter(String name,
                         String value)

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

getParameterMap
```
public Map getParameterMap()
```

getProtocol
```
public String getProtocol()
```
Specified by:

getProtocol 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

getReader
```
public BufferedReader getReader()
                         throws IOException
```
Specified by:

getReader in interface javax.servlet.ServletRequest

Throws:

IOException

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

setAttribute

public void setAttribute(String key,
                         Object value)

Specified by:: setAttribute in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(String string)

getLocale
```
public Locale getLocale()
```

getLocales

public Enumeration<Locale> getLocales()

setLocale
```
public void setLocale(Locale locale)
```

isSecure
```
public boolean isSecure()
```

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String string)

getRealPath
```
public String getRealPath(String string)
```
Specified by:

getRealPath in interface javax.servlet.ServletRequest

getRemotePort
```
public int getRemotePort()
```

getLocalName
```
public String getLocalName()
```

getLocalAddr
```
public String getLocalAddr()
```

getLocalPort
```
public int getLocalPort()
```

setRequestURL

public void setRequestURL(String requestURL)

setProtocol

public void setProtocol(String protocol)

authenticate

public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

login

public void login(String username,
                  String password)
           throws javax.servlet.ServletException

Throws:: javax.servlet.ServletException

logout

public void logout()
            throws javax.servlet.ServletException

Throws:: javax.servlet.ServletException

getParts

public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

getPart

public javax.servlet.http.Part getPart(String name)
                                throws IOException,
                                       javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

upgrade

public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

getServletContext

public javax.servlet.ServletContext getServletContext()

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

startAsync

public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException

Throws:: IllegalStateException

startAsync

public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws IllegalStateException

Throws:: IllegalStateException

isAsyncStarted
```
public boolean isAsyncStarted()
```

isAsyncSupported
```
public boolean isAsyncSupported()
```

getAsyncContext

public javax.servlet.AsyncContext getAsyncContext()

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

Class MockHttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockHttpServletRequest

MockHttpServletRequest

MockHttpServletRequest

MockHttpServletRequest

Method Detail

getAuthType

getCookies

setCookies

setCookies

addCookie

addCookie

toCookies

getDateHeader

getHeader

setHeader

getHeaders

getHeaderNames

getIntHeader

getMethod

setMethod

getPathInfo

getPathTranslated

getContextPath

setContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

setServletPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

setContentType

getInputStream

getParameter

setParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

setRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

setLocale

isSecure

getRequestDispatcher

getRealPath

getRemotePort

getLocalName

getLocalAddr

getLocalPort

setRequestURL