Package io.spine.web.given
Class KnownRequest
- java.lang.Object
-
- io.spine.web.given.KnownRequest
-
- All Implemented Interfaces:
MockedRequest
,javax.servlet.http.HttpServletRequest
,javax.servlet.ServletRequest
public final class KnownRequest extends java.lang.Object implements MockedRequest
A mocked servlet request with pre-defined content.- Implementation Note:
- The request is effectively immutable and does not pay attention to any modification attempts. Such a mocked implementation may be used for tests where one do not care if anything may be adjusted in the request while the request is being processed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KnownRequest.Builder
A builder for producingKnownRequest
instances.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KnownRequest
create(java.lang.String content)
Creates a new mocked request with specifiedcontent
and default any type.static KnownRequest
create(java.lang.String content, com.google.common.net.MediaType type)
Creates a new mocked request with specifiedcontent
andtype
.static KnownRequest
empty()
Creates an empty request.int
getContentLength()
long
getContentLengthLong()
@NonNull java.lang.String
getContentType()
@Nullable java.lang.String
getHeader(java.lang.String name)
java.util.Enumeration<java.lang.String>
getHeaderNames()
java.util.Enumeration<java.lang.String>
getHeaders(java.lang.String name)
java.io.BufferedReader
getReader()
@NonNull java.lang.String
getRequestURI()
static KnownRequest.Builder
newBuilder()
Creates a new request builder.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.spine.web.given.MockedRequest
authenticate, changeSessionId, getAsyncContext, getAttribute, getAttributeNames, getAuthType, getCharacterEncoding, getContextPath, getCookies, getDateHeader, getDispatcherType, getInputStream, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMethod, getParameter, getParameterMap, getParameterNames, getParameterValues, getPart, getParts, getPathInfo, getPathTranslated, getProtocol, getQueryString, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getRequestURL, getScheme, getServerName, getServerPort, getServletContext, getServletPath, getSession, getSession, getUserPrincipal, isAsyncStarted, isAsyncSupported, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, login, logout, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync, upgrade
-
-
-
-
Method Detail
-
empty
public static KnownRequest empty()
Creates an empty request.
-
newBuilder
public static KnownRequest.Builder newBuilder()
Creates a new request builder.
-
create
public static KnownRequest create(java.lang.String content)
Creates a new mocked request with specifiedcontent
and default any type.
-
create
public static KnownRequest create(java.lang.String content, com.google.common.net.MediaType type)
Creates a new mocked request with specifiedcontent
andtype
.
-
getHeader
public @Nullable java.lang.String getHeader(java.lang.String name)
- Specified by:
getHeader
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getHeader
in interfaceMockedRequest
-
getHeaders
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getHeaders
in interfaceMockedRequest
-
getHeaderNames
public java.util.Enumeration<java.lang.String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getHeaderNames
in interfaceMockedRequest
-
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interfaceMockedRequest
- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfaceMockedRequest
- Specified by:
getContentLengthLong
in interfacejavax.servlet.ServletRequest
-
getContentType
public @NonNull java.lang.String getContentType()
- Specified by:
getContentType
in interfaceMockedRequest
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
-
getReader
public java.io.BufferedReader getReader()
- Specified by:
getReader
in interfaceMockedRequest
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
-
getRequestURI
public @NonNull java.lang.String getRequestURI()
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
- Specified by:
getRequestURI
in interfaceMockedRequest
-
-