Package org.apache.commons.fileupload2.jakarta.servlet5

Class JakartaMockHttpServletRequest

java.lang.Object

org.apache.commons.fileupload2.jakarta.servlet5.JakartaMockHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class JakartaMockHttpServletRequest
extends Object
implements HttpServletRequest

Test fixture for HttpServletRequest.

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
JakartaMockHttpServletRequest(byte[] requestData, String contentType)	Creates a new instance with the given request data and content type.
JakartaMockHttpServletRequest(InputStream requestInputStream, long requestLength, String contentType, int readLimit)	Creates a new instance with the given request data and content type.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse response)
String	changeSessionId()
AsyncContext	getAsyncContext()
Object	getAttribute(String arg0)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String arg0)
DispatcherType	getDispatcherType()
String	getHeader(String headerName)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String arg0)
ServletInputStream	getInputStream()
int	getIntHeader(String arg0)
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String arg0)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String arg0)
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String arg0)	Deprecated.
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String arg0)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
ServletContext	getServletContext()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean arg0)
Principal	getUserPrincipal()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String arg0)
void	login(String username, String password)
void	logout()
void	removeAttribute(String arg0)
void	setAttribute(String arg0, Object arg1)
void	setCharacterEncoding(String arg0)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Constructor Details

JakartaMockHttpServletRequest

public JakartaMockHttpServletRequest(byte[] requestData,
 String contentType)

Creates a new instance with the given request data and content type.

JakartaMockHttpServletRequest

public JakartaMockHttpServletRequest(InputStream requestInputStream,
 long requestLength,
 String contentType,
 int readLimit)

Creates a new instance with the given request data and content type.

Method Details

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

getAttribute

public Object getAttribute(String arg0)

Specified by:

getAttribute in interface ServletRequest

See Also:

• ServletRequest.getAttribute(String)

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

See Also:

• ServletRequest.getAttributeNames()

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

See Also:

• HttpServletRequest.getAuthType()

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

See Also:

• ServletRequest.getCharacterEncoding()

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

See Also:

• ServletRequest.getContentLength()

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

See Also:

• ServletRequest.getContentType()

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

See Also:

• HttpServletRequest.getContextPath()

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

See Also:

• HttpServletRequest.getCookies()

getDateHeader

public long getDateHeader(String arg0)

Specified by:

getDateHeader in interface HttpServletRequest

See Also:

• HttpServletRequest.getDateHeader(String)

getDispatcherType

public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest

getHeader

public String getHeader(String headerName)

Specified by:

getHeader in interface HttpServletRequest

See Also:

• HttpServletRequest.getHeader(String)

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

See Also:

• HttpServletRequest.getHeaderNames()

getHeaders

public Enumeration<String> getHeaders(String arg0)

Specified by:

getHeaders in interface HttpServletRequest

See Also:

• HttpServletRequest.getHeaders(String)

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Throws:

IOException

See Also:

• ServletRequest.getInputStream()

getIntHeader

public int getIntHeader(String arg0)

Specified by:

getIntHeader in interface HttpServletRequest

See Also:

• HttpServletRequest.getIntHeader(String)

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

See Also:

• ServletRequest.getLocalAddr()

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

See Also:

• ServletRequest.getLocale()

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface ServletRequest

See Also:

• ServletRequest.getLocales()

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

See Also:

• ServletRequest.getLocalName()

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

See Also:

• ServletRequest.getLocalPort()

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

See Also:

• HttpServletRequest.getMethod()

getParameter

public String getParameter(String arg0)

Specified by:

getParameter in interface ServletRequest

See Also:

• ServletRequest.getParameter(String)

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

See Also:

• ServletRequest.getParameterMap()

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

See Also:

• ServletRequest.getParameterNames()

getParameterValues

public String[] getParameterValues(String arg0)

Specified by:

getParameterValues in interface ServletRequest

See Also:

• ServletRequest.getParameterValues(String)

getPart

public Part getPart(String name)
             throws IOException,
ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

getParts

public Collection<Part> getParts()
                          throws IOException,
ServletException

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

See Also:

• HttpServletRequest.getPathInfo()

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

See Also:

• HttpServletRequest.getPathTranslated()

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

See Also:

• ServletRequest.getProtocol()

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

See Also:

• HttpServletRequest.getQueryString()

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

See Also:

• ServletRequest.getReader()

getRealPath

@Deprecated
public String getRealPath(String arg0)

Deprecated.

Specified by:

getRealPath in interface ServletRequest

See Also:

• ServletRequest.getRealPath(String)

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

See Also:

• ServletRequest.getRemoteAddr()

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

See Also:

• ServletRequest.getRemoteHost()

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

See Also:

• ServletRequest.getRemotePort()

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

See Also:

• HttpServletRequest.getRemoteUser()

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String arg0)

Specified by:

getRequestDispatcher in interface ServletRequest

See Also:

• ServletRequest.getRequestDispatcher(String)

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

See Also:

• HttpServletRequest.getRequestedSessionId()

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

See Also:

• HttpServletRequest.getRequestURI()

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

See Also:

• HttpServletRequest.getRequestURL()

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

See Also:

• ServletRequest.getScheme()

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

See Also:

• ServletRequest.getServerName()

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

See Also:

• ServletRequest.getServerPort()

getServletContext

public ServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

See Also:

• HttpServletRequest.getServletPath()

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

See Also:

• HttpServletRequest.getSession()

getSession

public HttpSession getSession(boolean arg0)

Specified by:

getSession in interface HttpServletRequest

See Also:

• HttpServletRequest.getSession(boolean)

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

See Also:

• HttpServletRequest.getUserPrincipal()

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

See Also:

• HttpServletRequest.isRequestedSessionIdFromCookie()

isRequestedSessionIdFromUrl

@Deprecated
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

See Also:

• HttpServletRequest.isRequestedSessionIdFromUrl()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

See Also:

• HttpServletRequest.isRequestedSessionIdFromURL()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

See Also:

• HttpServletRequest.isRequestedSessionIdValid()

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

See Also:

• ServletRequest.isSecure()

isUserInRole

public boolean isUserInRole(String arg0)

Specified by:

isUserInRole in interface HttpServletRequest

See Also:

• HttpServletRequest.isUserInRole(String)

login

public void login(String username,
 String password)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

removeAttribute

public void removeAttribute(String arg0)

Specified by:

removeAttribute in interface ServletRequest

See Also:

• ServletRequest.removeAttribute(String)

setAttribute

public void setAttribute(String arg0,
 Object arg1)

Specified by:

setAttribute in interface ServletRequest

See Also:

• ServletRequest.setAttribute(String, Object)

setCharacterEncoding

public void setCharacterEncoding(String arg0)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Throws:

UnsupportedEncodingException

See Also:

• ServletRequest.setCharacterEncoding(String)

startAsync

public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

startAsync

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

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

upgrade

public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                         throws IOException,
ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException