Package com.helger.servlet.mock

Class MockHttpServletRequest

java.lang.Object

com.helger.servlet.mock.MockHttpServletRequest

All Implemented Interfaces:

com.helger.commons.locale.IHasLocale, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest

Direct Known Subclasses:

OfflineHttpServletRequest

@NotThreadSafe
public class MockHttpServletRequest
extends Object
implements jakarta.servlet.http.HttpServletRequest, com.helger.commons.locale.IHasLocale

Mock implementation of HttpServletRequest.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_INVOKE_HTTP_LISTENER
static com.helger.commons.http.EHttpMethod	DEFAULT_METHOD	The default HTTP method: GET
static String	DEFAULT_PROTOCOL
static String	DEFAULT_REMOTE_ADDR
static String	DEFAULT_REMOTE_HOST
static String	DEFAULT_SCHEME
static String	DEFAULT_SERVER_ADDR
static String	DEFAULT_SERVER_NAME
static int	DEFAULT_SERVER_PORT

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
MockHttpServletRequest()	Create a new MockHttpServletRequest with a default MockServletContext.
MockHttpServletRequest(jakarta.servlet.ServletContext aServletContext)	Create a new MockHttpServletRequest.
MockHttpServletRequest(jakarta.servlet.ServletContext aServletContext, com.helger.commons.http.EHttpMethod eMethod)	Create a new MockHttpServletRequest.
MockHttpServletRequest(jakarta.servlet.ServletContext aServletContext, com.helger.commons.http.EHttpMethod eMethod, boolean bInvokeHttpListeners)	Create a new MockHttpServletRequest.

Method Summary

Modifier and Type	Method	Description
MockHttpServletRequest	addHeader(String sName, String aValue)	Add a header entry for the given name.
MockHttpServletRequest	addParameter(String sName, String sValue)	Add a single value for the specified HTTP parameter.
MockHttpServletRequest	addParameter(String sName, String[] aValues)	Add an array of values for the specified HTTP parameter.
MockHttpServletRequest	addParameters(List<? extends com.helger.commons.url.URLParameter> aParams)	Adds all provided parameters without replacing any existing values.
MockHttpServletRequest	addPreferredLocale(Locale aLocale)	Add a new preferred locale, before any existing locales.
MockHttpServletRequest	addUserRole(String sRole)
boolean	authenticate(jakarta.servlet.http.HttpServletResponse response)
String	changeSessionId()
protected void	checkActive()	Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.
MockHttpServletRequest	clearAttributes()	Clear all of this request's attributes.
void	close()	Mark this request as completed, keeping its state.
jakarta.servlet.AsyncContext	getAsyncContext()
Object	getAttribute(String sName)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
Charset	getCharacterEncodingObj()
Charset	getCharacterEncodingObjOrDefault()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
jakarta.servlet.http.Cookie[]	getCookies()
long	getDateHeader(String sName)	Deprecated.
jakarta.servlet.DispatcherType	getDispatcherType()
String	getHeader(String sName)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String sName)
jakarta.servlet.ServletInputStream	getInputStream()	Note: do not change the content via setContent(byte[]), while an input stream is open, because this may lead to indeterministic results!
int	getIntHeader(String sName)	Deprecated.
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
com.helger.commons.http.EHttpMethod	getMethodEnum()
String	getParameter(String sName)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String sName)
jakarta.servlet.http.Part	getPart(String name)
com.helger.commons.collection.impl.ICommonsCollection<jakarta.servlet.http.Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String sPath)	Deprecated.
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
MockRequestDispatcher	getRequestDispatcher(String sPath)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
jakarta.servlet.ServletContext	getServletContext()
String	getServletPath()
jakarta.servlet.http.HttpSession	getSession()
jakarta.servlet.http.HttpSession	getSession(boolean bCreate)
String	getSessionID()
Principal	getUserPrincipal()
void	invalidate()	Invalidate this request, clearing its state and invoking all HTTP event listener.
boolean	isActive()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String sRole)
void	login(String username, String password)
void	logout()
MockHttpServletRequest	removeAllParameters()	Removes all existing parameters.
void	removeAttribute(String sName)
MockHttpServletRequest	removeHeader(String sName)
MockHttpServletRequest	removeParameter(String sName)	Remove already registered values for the specified HTTP parameter, if any.
MockHttpServletRequest	setAllPaths(String sRequestURL)	Set all path related members to the value to be deduced from the request URI.
void	setAttribute(String sName, Object aValue)
MockHttpServletRequest	setAuthType(String sAuthType)
void	setCharacterEncoding(String sCharacterEncoding)
void	setCharacterEncoding(Charset aCharacterEncoding)
MockHttpServletRequest	setContent(byte[] aContent)
MockHttpServletRequest	setContentType(com.helger.commons.mime.IMimeType aContentType)
MockHttpServletRequest	setContentType(String sContentType)
MockHttpServletRequest	setContextPath(String sContextPath)
MockHttpServletRequest	setCookies(jakarta.servlet.http.Cookie[] aCookies)
MockHttpServletRequest	setLocalAddr(String sLocalAddr)
MockHttpServletRequest	setLocalName(String sLocalName)
MockHttpServletRequest	setLocalPort(int nLocalPort)
MockHttpServletRequest	setMethod(com.helger.commons.http.EHttpMethod eMethod)
MockHttpServletRequest	setParameter(String sName, String sValue)	Set a single value for the specified HTTP parameter.
MockHttpServletRequest	setParameter(String sName, String[] aValues)	Set an array of values for the specified HTTP parameter.
MockHttpServletRequest	setParameters(List<? extends com.helger.commons.url.URLParameter> aParams)	Sets all provided parameters replacing any existing values for the provided parameter names.
MockHttpServletRequest	setPathInfo(String sPathInfo)
MockHttpServletRequest	setProtocol(String sProtocol)
MockHttpServletRequest	setQueryString(String sQueryString)
MockHttpServletRequest	setRemoteAddr(String sRemoteAddr)
MockHttpServletRequest	setRemoteHost(String sRemoteHost)
MockHttpServletRequest	setRemotePort(int nRemotePort)
MockHttpServletRequest	setRemoteUser(String sRemoteUser)
MockHttpServletRequest	setRequestedSessionIdFromCookie(boolean bRequestedSessionIdFromCookie)
MockHttpServletRequest	setRequestedSessionIdFromURL(boolean bRequestedSessionIdFromURL)
MockHttpServletRequest	setRequestedSessionIdValid(boolean bRequestedSessionIdValid)
MockHttpServletRequest	setRequestURI(String sRequestURI)
MockHttpServletRequest	setScheme(String sScheme)
MockHttpServletRequest	setSecure(boolean bSecure)
MockHttpServletRequest	setServerName(String sServerName)
MockHttpServletRequest	setServerPort(int nServerPort)
MockHttpServletRequest	setServletPath(String sServletPath)
MockHttpServletRequest	setSession(jakarta.servlet.http.HttpSession aHttpSession)
MockHttpServletRequest	setSessionID(String sSessionID)	Define the session ID to be used when creating a new session
MockHttpServletRequest	setUserPrincipal(Principal aUserPrincipal)
jakarta.servlet.AsyncContext	startAsync()
jakarta.servlet.AsyncContext	startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse)
<T extends jakarta.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

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Field Detail

DEFAULT_INVOKE_HTTP_LISTENER

public static final boolean DEFAULT_INVOKE_HTTP_LISTENER

See Also:

Constant Field Values

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

See Also:

Constant Field Values

DEFAULT_SERVER_ADDR

public static final String DEFAULT_SERVER_ADDR

See Also:

Constant Field Values

DEFAULT_SERVER_NAME

public static final String DEFAULT_SERVER_NAME

See Also:

Constant Field Values

DEFAULT_SERVER_PORT

public static final int DEFAULT_SERVER_PORT

DEFAULT_REMOTE_ADDR

public static final String DEFAULT_REMOTE_ADDR

See Also:

Constant Field Values

DEFAULT_REMOTE_HOST

public static final String DEFAULT_REMOTE_HOST

See Also:

Constant Field Values

DEFAULT_METHOD

public static final com.helger.commons.http.EHttpMethod DEFAULT_METHOD

The default HTTP method: GET

Constructor Detail

MockHttpServletRequest

public MockHttpServletRequest()

Create a new MockHttpServletRequest with a default MockServletContext.

See Also:

MockServletContext

MockHttpServletRequest

public MockHttpServletRequest(@Nullable
                              jakarta.servlet.ServletContext aServletContext)

Create a new MockHttpServletRequest.

Parameters:

aServletContext - the ServletContext that the request runs in (may be null to use a default MockServletContext)

See Also:

MockServletContext

MockHttpServletRequest

public MockHttpServletRequest(@Nullable
                              jakarta.servlet.ServletContext aServletContext,
                              @Nullable
                              com.helger.commons.http.EHttpMethod eMethod)

Create a new MockHttpServletRequest.

Parameters:

aServletContext - the ServletContext that the request runs in (may be null to use a default MockServletContext)

eMethod - the request method (may be null)

See Also:

MockServletContext

MockHttpServletRequest

public MockHttpServletRequest(@Nullable
                              jakarta.servlet.ServletContext aServletContext,
                              @Nullable
                              com.helger.commons.http.EHttpMethod eMethod,
                              boolean bInvokeHttpListeners)

Create a new MockHttpServletRequest.

Parameters:

aServletContext - the ServletContext that the request runs in (may be null to use a default MockServletContext)

eMethod - the request method (may be null)

bInvokeHttpListeners - if true than the HTTP request event listeners from MockHttpListener are triggered

See Also:

setMethod(com.helger.commons.http.EHttpMethod), MockServletContext

Method Detail

getServletContext

@Nonnull
public final jakarta.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface jakarta.servlet.ServletRequest

Returns:

the ServletContext that this request is associated with. (Not available in the standard HttpServletRequest interface for some reason.). Never null.

isActive

public boolean isActive()

Returns:

whether this request is still active (that is, not completed yet).

close

public void close()

Mark this request as completed, keeping its state.

invalidate

public void invalidate()

Invalidate this request, clearing its state and invoking all HTTP event listener.

See Also:

close(), clearAttributes()

checkActive

protected void checkActive()

Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.

getAttribute

@Nullable
public Object getAttribute(@Nullable
                           String sName)

Specified by:

getAttribute in interface jakarta.servlet.ServletRequest

getAttributeNames

@Nonnull
public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface jakarta.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 String sCharacterEncoding)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 Charset aCharacterEncoding)

getCharacterEncoding

@Nullable
public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletRequest

getCharacterEncodingObj

@Nullable
public Charset getCharacterEncodingObj()

getCharacterEncodingObjOrDefault

@Nonnull
public Charset getCharacterEncodingObjOrDefault()

setContent

@Nonnull
public MockHttpServletRequest setContent(@Nullable
                                         byte[] aContent)

getContentLength

@CheckForSigned
public int getContentLength()

Specified by:

getContentLength in interface jakarta.servlet.ServletRequest

setContentType

@Nonnull
public MockHttpServletRequest setContentType(@Nullable
                                             com.helger.commons.mime.IMimeType aContentType)

setContentType

@Nonnull
public MockHttpServletRequest setContentType(@Nullable
                                             String sContentType)

getContentType

@Nullable
public String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletRequest

getInputStream

@Nullable
public jakarta.servlet.ServletInputStream getInputStream()

Note: do not change the content via setContent(byte[]), while an input stream is open, because this may lead to indeterministic results!

Specified by:

getInputStream in interface jakarta.servlet.ServletRequest

Returns:

null if no content is present. If non- null the caller is responsible for closing the InputStream.

setParameter

@Nonnull
public MockHttpServletRequest setParameter(@Nonnull
                                           String sName,
                                           @Nullable
                                           String sValue)

Set a single value for the specified HTTP parameter.

If there are already one or more values registered for the given parameter name, they will be replaced.

Parameters:

sName - Parameter name

sValue - Parameter value

Returns:

this

setParameter

@Nonnull
public MockHttpServletRequest setParameter(@Nonnull
                                           String sName,
                                           @Nullable
                                           String[] aValues)

Set an array of values for the specified HTTP parameter.

If there are already one or more values registered for the given parameter name, they will be replaced.

Parameters:

sName - Parameter name

aValues - Parameter values

Returns:

this

setParameters

@Nonnull
public MockHttpServletRequest setParameters(@Nullable
                                            List<? extends com.helger.commons.url.URLParameter> aParams)

Sets all provided parameters replacing any existing values for the provided parameter names. To add without replacing existing values, use addParameters(List).

Parameters:

aParams - Parameter name value map. May be null.

Returns:

this

addParameter

@Nonnull
public final MockHttpServletRequest addParameter(@Nonnull
                                                 String sName,
                                                 @Nullable
                                                 String sValue)

Add a single value for the specified HTTP parameter.

If there are already one or more values registered for the given parameter name, the given value will be added to the end of the list.

Parameters:

sName - Parameter name

sValue - Parameter value

Returns:

this

addParameter

@Nonnull
public final MockHttpServletRequest addParameter(@Nonnull
                                                 String sName,
                                                 @Nullable
                                                 String[] aValues)

Add an array of values for the specified HTTP parameter.

If there are already one or more values registered for the given parameter name, the given values will be added to the end of the list.

Parameters:

sName - Parameter name

aValues - Parameter values

Returns:

this

addParameters

@Nonnull
public MockHttpServletRequest addParameters(@Nullable
                                            List<? extends com.helger.commons.url.URLParameter> aParams)

Adds all provided parameters without replacing any existing values. To replace existing values, use setParameters(List).

Parameters:

aParams - Parameter name value map

Returns:

this

removeParameter

@Nonnull
public MockHttpServletRequest removeParameter(@Nonnull
                                              String sName)

Remove already registered values for the specified HTTP parameter, if any.

Parameters:

sName - Parameter name

Returns:

this

removeAllParameters

@Nonnull
public MockHttpServletRequest removeAllParameters()

Removes all existing parameters.

Returns:

this

getParameter

@Nullable
public String getParameter(@Nonnull
                           String sName)

Specified by:

getParameter in interface jakarta.servlet.ServletRequest

getParameterNames

@Nonnull
public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface jakarta.servlet.ServletRequest

getParameterValues

@Nullable
@ReturnsMutableCopy
public String[] getParameterValues(@Nonnull
                                   String sName)

Specified by:

getParameterValues in interface jakarta.servlet.ServletRequest

getParameterMap

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface jakarta.servlet.ServletRequest

setProtocol

@Nonnull
public MockHttpServletRequest setProtocol(@Nullable
                                          String sProtocol)

getProtocol

@Nullable
public String getProtocol()

Specified by:

getProtocol in interface jakarta.servlet.ServletRequest

setScheme

@Nonnull
public MockHttpServletRequest setScheme(@Nullable
                                        String sScheme)

getScheme

@Nullable
public String getScheme()

Specified by:

getScheme in interface jakarta.servlet.ServletRequest

setServerName

@Nonnull
public MockHttpServletRequest setServerName(@Nullable
                                            String sServerName)

getServerName

@Nullable
public String getServerName()

Specified by:

getServerName in interface jakarta.servlet.ServletRequest

setServerPort

@Nonnull
public MockHttpServletRequest setServerPort(int nServerPort)

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface jakarta.servlet.ServletRequest

getReader

@Nullable
public BufferedReader getReader()

Specified by:

getReader in interface jakarta.servlet.ServletRequest

setRemoteAddr

@Nonnull
public MockHttpServletRequest setRemoteAddr(@Nullable
                                            String sRemoteAddr)

getRemoteAddr

@Nullable
public String getRemoteAddr()

Specified by:

getRemoteAddr in interface jakarta.servlet.ServletRequest

setRemoteHost

@Nonnull
public MockHttpServletRequest setRemoteHost(@Nullable
                                            String sRemoteHost)

getRemoteHost

@Nullable
public String getRemoteHost()

Specified by:

getRemoteHost in interface jakarta.servlet.ServletRequest

setAttribute

public void setAttribute(@Nonnull
                         String sName,
                         @Nullable
                         Object aValue)

Specified by:

setAttribute in interface jakarta.servlet.ServletRequest

removeAttribute

public void removeAttribute(@Nonnull
                            String sName)

Specified by:

removeAttribute in interface jakarta.servlet.ServletRequest

clearAttributes

@Nonnull
public MockHttpServletRequest clearAttributes()

Clear all of this request's attributes.

Returns:

this

addPreferredLocale

@Nonnull
public MockHttpServletRequest addPreferredLocale(@Nonnull
                                                 Locale aLocale)

Add a new preferred locale, before any existing locales.

Parameters:

aLocale - preferred locale

Returns:

this

getLocale

@Nonnull
public Locale getLocale()

Specified by:

getLocale in interface com.helger.commons.locale.IHasLocale

Specified by:

getLocale in interface jakarta.servlet.ServletRequest

getLocales

@Nonnull
@Nonempty
public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface jakarta.servlet.ServletRequest

setSecure

@Nonnull
public MockHttpServletRequest setSecure(boolean bSecure)

isSecure

public boolean isSecure()

Specified by:

isSecure in interface jakarta.servlet.ServletRequest

getRequestDispatcher

@Nonnull
public MockRequestDispatcher getRequestDispatcher(@Nonnull
                                                  String sPath)

Specified by:

getRequestDispatcher in interface jakarta.servlet.ServletRequest

getRealPath

@Deprecated(forRemoval=false)
public String getRealPath(@Nonnull
                          String sPath)

Deprecated.

Specified by:

getRealPath in interface jakarta.servlet.ServletRequest

setRemotePort

@Nonnull
public MockHttpServletRequest setRemotePort(int nRemotePort)

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface jakarta.servlet.ServletRequest

setLocalName

@Nonnull
public MockHttpServletRequest setLocalName(@Nullable
                                           String sLocalName)

getLocalName

@Nullable
public String getLocalName()

Specified by:

getLocalName in interface jakarta.servlet.ServletRequest

setLocalAddr

@Nonnull
public MockHttpServletRequest setLocalAddr(@Nullable
                                           String sLocalAddr)

getLocalAddr

@Nullable
public String getLocalAddr()

Specified by:

getLocalAddr in interface jakarta.servlet.ServletRequest

setLocalPort

@Nonnull
public MockHttpServletRequest setLocalPort(int nLocalPort)

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface jakarta.servlet.ServletRequest

setAuthType

@Nonnull
public MockHttpServletRequest setAuthType(@Nullable
                                          String sAuthType)

getAuthType

@Nullable
public String getAuthType()

Specified by:

getAuthType in interface jakarta.servlet.http.HttpServletRequest

setCookies

@Nonnull
public MockHttpServletRequest setCookies(@Nullable
                                         jakarta.servlet.http.Cookie[] aCookies)

getCookies

@Nullable
public jakarta.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface jakarta.servlet.http.HttpServletRequest

addHeader

@Nonnull
public final MockHttpServletRequest addHeader(@Nullable
                                              String sName,
                                              @Nullable
                                              String aValue)

Add a header entry for the given name.

If there was no entry for that header name before, the value will be used as-is. In case of an existing entry, a String array will be created, adding the given value (more specifically, its toString representation) as further element.

Multiple values can only be stored as list of Strings, following the Servlet spec (see getHeaders accessor). As alternative to repeated addHeader calls for individual elements, you can use a single call with an entire array or Collection of values as parameter.

Parameters:

sName - header name

aValue - header value

Returns:

this

See Also:

getHeaderNames(), getHeader(java.lang.String), getHeaders(java.lang.String), getDateHeader(java.lang.String), getIntHeader(java.lang.String)

removeHeader

@Nonnull
public MockHttpServletRequest removeHeader(@Nullable
                                           String sName)

getDateHeader

@UnsupportedOperation
@Deprecated(forRemoval=false)
public long getDateHeader(@Nullable
                          String sName)

Deprecated.

Specified by:

getDateHeader in interface jakarta.servlet.http.HttpServletRequest

getIntHeader

@UnsupportedOperation
@Deprecated(forRemoval=false)
public int getIntHeader(@Nullable
                        String sName)

Deprecated.

Specified by:

getIntHeader in interface jakarta.servlet.http.HttpServletRequest

getHeader

@Nullable
public String getHeader(@Nullable
                        String sName)

Specified by:

getHeader in interface jakarta.servlet.http.HttpServletRequest

getHeaders

@Nonnull
public Enumeration<String> getHeaders(@Nullable
                                      String sName)

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletRequest

getHeaderNames

@Nonnull
public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletRequest

setMethod

@Nonnull
public final MockHttpServletRequest setMethod(@Nullable
                                              com.helger.commons.http.EHttpMethod eMethod)

getMethodEnum

@Nullable
public com.helger.commons.http.EHttpMethod getMethodEnum()

getMethod

@Nullable
public String getMethod()

Specified by:

getMethod in interface jakarta.servlet.http.HttpServletRequest

setPathInfo

@Nonnull
public MockHttpServletRequest setPathInfo(@Nullable
                                          String sPathInfo)

getPathInfo

@Nullable
public String getPathInfo()

Specified by:

getPathInfo in interface jakarta.servlet.http.HttpServletRequest

getPathTranslated

@Nullable
public String getPathTranslated()

Specified by:

getPathTranslated in interface jakarta.servlet.http.HttpServletRequest

setContextPath

@Nonnull
public MockHttpServletRequest setContextPath(@Nullable
                                             String sContextPath)

getContextPath

@Nullable
public String getContextPath()

Specified by:

getContextPath in interface jakarta.servlet.http.HttpServletRequest

setQueryString

@Nonnull
public MockHttpServletRequest setQueryString(@Nullable
                                             String sQueryString)

getQueryString

@Nullable
public String getQueryString()

Specified by:

getQueryString in interface jakarta.servlet.http.HttpServletRequest

setRemoteUser

@Nonnull
public MockHttpServletRequest setRemoteUser(@Nullable
                                            String sRemoteUser)

getRemoteUser

@Nullable
public String getRemoteUser()

Specified by:

getRemoteUser in interface jakarta.servlet.http.HttpServletRequest

addUserRole

@Nonnull
public MockHttpServletRequest addUserRole(@Nullable
                                          String sRole)

isUserInRole

public boolean isUserInRole(@Nullable
                            String sRole)

Specified by:

isUserInRole in interface jakarta.servlet.http.HttpServletRequest

setUserPrincipal

@Nonnull
public MockHttpServletRequest setUserPrincipal(@Nullable
                                               Principal aUserPrincipal)

getUserPrincipal

@Nullable
public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest

getRequestedSessionId

@Nullable
public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest

setRequestURI

@Nonnull
public MockHttpServletRequest setRequestURI(@Nullable
                                            String sRequestURI)

getRequestURI

@Nullable
public String getRequestURI()

Specified by:

getRequestURI in interface jakarta.servlet.http.HttpServletRequest

getRequestURL

@Nonnull
public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface jakarta.servlet.http.HttpServletRequest

setServletPath

@Nonnull
public MockHttpServletRequest setServletPath(@Nullable
                                             String sServletPath)

getServletPath

@Nullable
public String getServletPath()

Specified by:

getServletPath in interface jakarta.servlet.http.HttpServletRequest

setSessionID

@Nonnull
public MockHttpServletRequest setSessionID(@Nullable
                                           String sSessionID)

Define the session ID to be used when creating a new session

Parameters:

sSessionID - The session ID to be used. If it is null a unique session ID is generated.

Returns:

this

getSessionID

@Nullable
public String getSessionID()

Returns:

The session ID to use or null if a new session ID should be generated!

setSession

@Nonnull
public MockHttpServletRequest setSession(@Nullable
                                         jakarta.servlet.http.HttpSession aHttpSession)

getSession

@Nullable
public jakarta.servlet.http.HttpSession getSession(boolean bCreate)

Specified by:

getSession in interface jakarta.servlet.http.HttpServletRequest

getSession

@Nonnull
public jakarta.servlet.http.HttpSession getSession()

Specified by:

getSession in interface jakarta.servlet.http.HttpServletRequest

setRequestedSessionIdValid

@Nonnull
public MockHttpServletRequest setRequestedSessionIdValid(boolean bRequestedSessionIdValid)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest

setRequestedSessionIdFromCookie

@Nonnull
public MockHttpServletRequest setRequestedSessionIdFromCookie(boolean bRequestedSessionIdFromCookie)

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest

setRequestedSessionIdFromURL

@Nonnull
public MockHttpServletRequest setRequestedSessionIdFromURL(boolean bRequestedSessionIdFromURL)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated(forRemoval=false)
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest

startAsync

@UnsupportedOperation
public jakarta.servlet.AsyncContext startAsync()

Specified by:

startAsync in interface jakarta.servlet.ServletRequest

startAsync

@UnsupportedOperation
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest servletRequest,
                                               jakarta.servlet.ServletResponse servletResponse)

Specified by:

startAsync in interface jakarta.servlet.ServletRequest

isAsyncStarted

@UnsupportedOperation
public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface jakarta.servlet.ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface jakarta.servlet.ServletRequest

getAsyncContext

@UnsupportedOperation
public jakarta.servlet.AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface jakarta.servlet.ServletRequest

getDispatcherType

public jakarta.servlet.DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface jakarta.servlet.ServletRequest

authenticate

@UnsupportedOperation
public boolean authenticate(jakarta.servlet.http.HttpServletResponse response)
                     throws IOException,
                            jakarta.servlet.ServletException

Specified by:

authenticate in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

login

@UnsupportedOperation
public void login(String username,
                  String password)
           throws jakarta.servlet.ServletException

Specified by:

login in interface jakarta.servlet.http.HttpServletRequest

Throws:

jakarta.servlet.ServletException

logout

@UnsupportedOperation
public void logout()
            throws jakarta.servlet.ServletException

Specified by:

logout in interface jakarta.servlet.http.HttpServletRequest

Throws:

jakarta.servlet.ServletException

getParts

@UnsupportedOperation
public com.helger.commons.collection.impl.ICommonsCollection<jakarta.servlet.http.Part> getParts()
                                                                                          throws IOException,
                                                                                                 jakarta.servlet.ServletException

Specified by:

getParts in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

getPart

@UnsupportedOperation
public jakarta.servlet.http.Part getPart(String name)
                                  throws IOException,
                                         jakarta.servlet.ServletException

Specified by:

getPart in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

setAllPaths

@Nonnull
public MockHttpServletRequest setAllPaths(@Nullable
                                          String sRequestURL)

Set all path related members to the value to be deduced from the request URI.

Parameters:

sRequestURL - The request URL to parse and set correctly. If it is null or empty, all methods are set to null .

Returns:

this

See Also:

setScheme(String), setServerName(String), setServerPort(int), setContextPath(String), setServletPath(String), setPathInfo(String), setQueryString(String), setParameters(List)

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface jakarta.servlet.ServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface jakarta.servlet.http.HttpServletRequest

upgrade

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

Specified by:

upgrade in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException