com.atlassian.jira.mock.servlet
Class MockHttpServletRequest

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

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

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

MockHttpServletRequest	addCookie(javax.servlet.http.Cookie cookie)
MockHttpServletRequest	addCookie(String name, String value)
Object	getAttribute(String key)
Enumeration	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
String	getContentType()
String	getContextPath()
javax.servlet.http.Cookie[]	getCookies()
long	getDateHeader(String string)
String	getHeader(String key)
Enumeration	getHeaderNames()
Enumeration	getHeaders(String string)
javax.servlet.ServletInputStream	getInputStream()
int	getIntHeader(String string)
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 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()
String	getServletPath()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSession	getSession(boolean b)
Principal	getUserPrincipal()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String string)
void	removeAttribute(String string)
void	setAttribute(String key, Object value)
void	setCharacterEncoding(String encoding)
MockHttpServletRequest	setContextPath(String contextPath)
MockHttpServletRequest	setCookies(javax.servlet.http.Cookie[] cookies)
MockHttpServletRequest	setCookies(Map<String,String> cookies)
void	setHeader(String key, String value)
void	setMethod(String method)
void	setParameter(String name, String value)
void	setProtocol(String protocol)
void	setRemoteAddr(String remoteAddr)
void	setRequestURL(String requestURL)
void	setServletPath(String servletPath)
javax.servlet.http.Cookie[]	toCookies(Map<String,String> cookieMap) Converts the key valeus of a map to an array of cookies

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)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

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

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

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)

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal 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

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

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

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Throws:

UnsupportedEncodingException

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

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

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

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)

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletRequest

getLocales

public Enumeration getLocales()

Specified by:

getLocales in interface javax.servlet.ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.ServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String string)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getRealPath

public String getRealPath(String string)

Specified by:

getRealPath in interface javax.servlet.ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface javax.servlet.ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface javax.servlet.ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface javax.servlet.ServletRequest

setRequestURL

public void setRequestURL(String requestURL)

setProtocol

public void setProtocol(String protocol)