Package io.spine.web.given
Interface MockedRequest
-
- All Superinterfaces:
javax.servlet.http.HttpServletRequest
,javax.servlet.ServletRequest
- All Known Implementing Classes:
KnownRequest
public interface MockedRequest extends javax.servlet.http.HttpServletRequest
A mocked no-op servlet request.- API Note:
- Some of the methods are marked as deprecated to avoid
the deprecation warnings, as their
super
methods are marked as such.
-
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default boolean
authenticate(javax.servlet.http.HttpServletResponse response)
default @Nullable java.lang.String
changeSessionId()
default @Nullable javax.servlet.AsyncContext
getAsyncContext()
default @Nullable java.lang.Object
getAttribute(java.lang.String name)
default @Nullable java.util.Enumeration<java.lang.String>
getAttributeNames()
default @Nullable java.lang.String
getAuthType()
default @Nullable java.lang.String
getCharacterEncoding()
default int
getContentLength()
default long
getContentLengthLong()
default @Nullable java.lang.String
getContentType()
default @Nullable java.lang.String
getContextPath()
default @Nullable javax.servlet.http.Cookie[]
getCookies()
default long
getDateHeader(java.lang.String name)
default @Nullable javax.servlet.DispatcherType
getDispatcherType()
default @Nullable java.lang.String
getHeader(java.lang.String name)
default @Nullable java.util.Enumeration<java.lang.String>
getHeaderNames()
default @Nullable java.util.Enumeration<java.lang.String>
getHeaders(java.lang.String name)
default @Nullable javax.servlet.ServletInputStream
getInputStream()
default int
getIntHeader(java.lang.String name)
default @Nullable java.lang.String
getLocalAddr()
default @Nullable java.util.Locale
getLocale()
default @Nullable java.util.Enumeration<java.util.Locale>
getLocales()
default @Nullable java.lang.String
getLocalName()
default int
getLocalPort()
default @Nullable java.lang.String
getMethod()
default @Nullable java.lang.String
getParameter(java.lang.String name)
default @Nullable java.util.Map<java.lang.String,java.lang.String[]>
getParameterMap()
default @Nullable java.util.Enumeration<java.lang.String>
getParameterNames()
default @Nullable java.lang.String[]
getParameterValues(java.lang.String name)
default @Nullable javax.servlet.http.Part
getPart(java.lang.String name)
default @Nullable java.util.Collection<javax.servlet.http.Part>
getParts()
default @Nullable java.lang.String
getPathInfo()
default @Nullable java.lang.String
getPathTranslated()
default @Nullable java.lang.String
getProtocol()
default @Nullable java.lang.String
getQueryString()
default @Nullable java.io.BufferedReader
getReader()
default @Nullable java.lang.String
getRealPath(java.lang.String path)
Deprecated.default @Nullable java.lang.String
getRemoteAddr()
default @Nullable java.lang.String
getRemoteHost()
default int
getRemotePort()
default @Nullable java.lang.String
getRemoteUser()
default @Nullable javax.servlet.RequestDispatcher
getRequestDispatcher(java.lang.String path)
default @Nullable java.lang.String
getRequestedSessionId()
default @Nullable java.lang.String
getRequestURI()
default @Nullable java.lang.StringBuffer
getRequestURL()
default @Nullable java.lang.String
getScheme()
default @Nullable java.lang.String
getServerName()
default int
getServerPort()
default @Nullable javax.servlet.ServletContext
getServletContext()
default @Nullable java.lang.String
getServletPath()
default @Nullable javax.servlet.http.HttpSession
getSession()
default @Nullable javax.servlet.http.HttpSession
getSession(boolean create)
default @Nullable java.security.Principal
getUserPrincipal()
default boolean
isAsyncStarted()
default boolean
isAsyncSupported()
default boolean
isRequestedSessionIdFromCookie()
default boolean
isRequestedSessionIdFromUrl()
Deprecated.default boolean
isRequestedSessionIdFromURL()
default boolean
isRequestedSessionIdValid()
default boolean
isSecure()
default boolean
isUserInRole(java.lang.String role)
default void
login(java.lang.String username, java.lang.String password)
default void
logout()
default void
removeAttribute(java.lang.String name)
default void
setAttribute(java.lang.String name, java.lang.Object o)
default void
setCharacterEncoding(java.lang.String env)
default @Nullable javax.servlet.AsyncContext
startAsync()
default @Nullable javax.servlet.AsyncContext
startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
default <T extends javax.servlet.http.HttpUpgradeHandler>
@Nullable Tupgrade(java.lang.Class<T> handlerClass)
-
-
-
Method Detail
-
getRequestURI
default @Nullable java.lang.String getRequestURI()
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
-
getAuthType
default @Nullable java.lang.String getAuthType()
- Specified by:
getAuthType
in interfacejavax.servlet.http.HttpServletRequest
-
getCookies
default @Nullable javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in interfacejavax.servlet.http.HttpServletRequest
-
getDateHeader
default long getDateHeader(java.lang.String name)
- Specified by:
getDateHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeader
default @Nullable java.lang.String getHeader(java.lang.String name)
- Specified by:
getHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaders
default @Nullable java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaderNames
default @Nullable java.util.Enumeration<java.lang.String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
-
getIntHeader
default int getIntHeader(java.lang.String name)
- Specified by:
getIntHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getMethod
default @Nullable java.lang.String getMethod()
- Specified by:
getMethod
in interfacejavax.servlet.http.HttpServletRequest
-
getPathInfo
default @Nullable java.lang.String getPathInfo()
- Specified by:
getPathInfo
in interfacejavax.servlet.http.HttpServletRequest
-
getPathTranslated
default @Nullable java.lang.String getPathTranslated()
- Specified by:
getPathTranslated
in interfacejavax.servlet.http.HttpServletRequest
-
getContextPath
default @Nullable java.lang.String getContextPath()
- Specified by:
getContextPath
in interfacejavax.servlet.http.HttpServletRequest
-
getQueryString
default @Nullable java.lang.String getQueryString()
- Specified by:
getQueryString
in interfacejavax.servlet.http.HttpServletRequest
-
getRemoteUser
default @Nullable java.lang.String getRemoteUser()
- Specified by:
getRemoteUser
in interfacejavax.servlet.http.HttpServletRequest
-
isUserInRole
default boolean isUserInRole(java.lang.String role)
- Specified by:
isUserInRole
in interfacejavax.servlet.http.HttpServletRequest
-
getUserPrincipal
default @Nullable java.security.Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestedSessionId
default @Nullable java.lang.String getRequestedSessionId()
- Specified by:
getRequestedSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURL
default @Nullable java.lang.StringBuffer getRequestURL()
- Specified by:
getRequestURL
in interfacejavax.servlet.http.HttpServletRequest
-
getServletPath
default @Nullable java.lang.String getServletPath()
- Specified by:
getServletPath
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
default @Nullable javax.servlet.http.HttpSession getSession(boolean create)
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
default @Nullable javax.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
changeSessionId
default @Nullable java.lang.String changeSessionId()
- Specified by:
changeSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
default boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromCookie
default boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookie
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
default boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURL
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromUrl
@Deprecated default boolean isRequestedSessionIdFromUrl()
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfacejavax.servlet.http.HttpServletRequest
-
authenticate
default boolean authenticate(javax.servlet.http.HttpServletResponse response)
- Specified by:
authenticate
in interfacejavax.servlet.http.HttpServletRequest
-
login
default void login(java.lang.String username, java.lang.String password)
- Specified by:
login
in interfacejavax.servlet.http.HttpServletRequest
-
logout
default void logout()
- Specified by:
logout
in interfacejavax.servlet.http.HttpServletRequest
-
getParts
default @Nullable java.util.Collection<javax.servlet.http.Part> getParts()
- Specified by:
getParts
in interfacejavax.servlet.http.HttpServletRequest
-
getPart
default @Nullable javax.servlet.http.Part getPart(java.lang.String name)
- Specified by:
getPart
in interfacejavax.servlet.http.HttpServletRequest
-
upgrade
default <T extends javax.servlet.http.HttpUpgradeHandler> @Nullable T upgrade(java.lang.Class<T> handlerClass)
- Specified by:
upgrade
in interfacejavax.servlet.http.HttpServletRequest
-
getAttribute
default @Nullable java.lang.Object getAttribute(java.lang.String name)
- Specified by:
getAttribute
in interfacejavax.servlet.ServletRequest
-
getAttributeNames
default @Nullable java.util.Enumeration<java.lang.String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletRequest
-
getCharacterEncoding
default @Nullable java.lang.String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
setCharacterEncoding
default void setCharacterEncoding(java.lang.String env)
- Specified by:
setCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
getContentLength
default int getContentLength()
- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
-
getContentLengthLong
default long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfacejavax.servlet.ServletRequest
-
getContentType
default @Nullable java.lang.String getContentType()
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
-
getInputStream
default @Nullable javax.servlet.ServletInputStream getInputStream()
- Specified by:
getInputStream
in interfacejavax.servlet.ServletRequest
-
getParameter
default @Nullable java.lang.String getParameter(java.lang.String name)
- Specified by:
getParameter
in interfacejavax.servlet.ServletRequest
-
getParameterNames
default @Nullable java.util.Enumeration<java.lang.String> getParameterNames()
- Specified by:
getParameterNames
in interfacejavax.servlet.ServletRequest
-
getParameterValues
default @Nullable java.lang.String[] getParameterValues(java.lang.String name)
- Specified by:
getParameterValues
in interfacejavax.servlet.ServletRequest
-
getParameterMap
default @Nullable java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
- Specified by:
getParameterMap
in interfacejavax.servlet.ServletRequest
-
getProtocol
default @Nullable java.lang.String getProtocol()
- Specified by:
getProtocol
in interfacejavax.servlet.ServletRequest
-
getScheme
default @Nullable java.lang.String getScheme()
- Specified by:
getScheme
in interfacejavax.servlet.ServletRequest
-
getServerName
default @Nullable java.lang.String getServerName()
- Specified by:
getServerName
in interfacejavax.servlet.ServletRequest
-
getServerPort
default int getServerPort()
- Specified by:
getServerPort
in interfacejavax.servlet.ServletRequest
-
getReader
default @Nullable java.io.BufferedReader getReader()
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
-
getRemoteAddr
default @Nullable java.lang.String getRemoteAddr()
- Specified by:
getRemoteAddr
in interfacejavax.servlet.ServletRequest
-
getRemoteHost
default @Nullable java.lang.String getRemoteHost()
- Specified by:
getRemoteHost
in interfacejavax.servlet.ServletRequest
-
setAttribute
default void setAttribute(java.lang.String name, java.lang.Object o)
- Specified by:
setAttribute
in interfacejavax.servlet.ServletRequest
-
removeAttribute
default void removeAttribute(java.lang.String name)
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletRequest
-
getLocale
default @Nullable java.util.Locale getLocale()
- Specified by:
getLocale
in interfacejavax.servlet.ServletRequest
-
getLocales
default @Nullable java.util.Enumeration<java.util.Locale> getLocales()
- Specified by:
getLocales
in interfacejavax.servlet.ServletRequest
-
isSecure
default boolean isSecure()
- Specified by:
isSecure
in interfacejavax.servlet.ServletRequest
-
getRequestDispatcher
default @Nullable javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletRequest
-
getRealPath
@Deprecated default @Nullable java.lang.String getRealPath(java.lang.String path)
Deprecated.- Specified by:
getRealPath
in interfacejavax.servlet.ServletRequest
-
getRemotePort
default int getRemotePort()
- Specified by:
getRemotePort
in interfacejavax.servlet.ServletRequest
-
getLocalName
default @Nullable java.lang.String getLocalName()
- Specified by:
getLocalName
in interfacejavax.servlet.ServletRequest
-
getLocalAddr
default @Nullable java.lang.String getLocalAddr()
- Specified by:
getLocalAddr
in interfacejavax.servlet.ServletRequest
-
getLocalPort
default int getLocalPort()
- Specified by:
getLocalPort
in interfacejavax.servlet.ServletRequest
-
getServletContext
default @Nullable javax.servlet.ServletContext getServletContext()
- Specified by:
getServletContext
in interfacejavax.servlet.ServletRequest
-
startAsync
default @Nullable javax.servlet.AsyncContext startAsync() throws java.lang.IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
java.lang.IllegalStateException
-
startAsync
default @Nullable javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws java.lang.IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
java.lang.IllegalStateException
-
isAsyncStarted
default boolean isAsyncStarted()
- Specified by:
isAsyncStarted
in interfacejavax.servlet.ServletRequest
-
isAsyncSupported
default boolean isAsyncSupported()
- Specified by:
isAsyncSupported
in interfacejavax.servlet.ServletRequest
-
getAsyncContext
default @Nullable javax.servlet.AsyncContext getAsyncContext()
- Specified by:
getAsyncContext
in interfacejavax.servlet.ServletRequest
-
getDispatcherType
default @Nullable javax.servlet.DispatcherType getDispatcherType()
- Specified by:
getDispatcherType
in interfacejavax.servlet.ServletRequest
-
-