org.apache.juneau.rest.mock.MockRestRequest

All Implemented Interfaces:: AutoCloseable, Configurable, HttpUriRequest, HttpMessage, HttpRequest

public class MockRestRequest extends RestRequest

A subclass of RestRequest with additional features for mocked testing.

Instances of this class are instantiated through methods on MockRestClient such as MockRestClient.post(Object,Object)

Notes:

This class is not thread safe.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.BeanSession
BeanSession.Builder
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

MockRestRequest(RestClient client, URI uri, String method, boolean hasBody)

Constructs a REST call with the specified method name.
Method Summary

Modifier and Type

Method

Description

MockRestRequest

accept(String value)

Sets the value for the Accept request header.

MockRestRequest

acceptCharset(String value)

Sets the value for the Accept-Charset request header.

MockRestRequest

attribute(String name, Object value)

Adds an attribute to the underlying HttpServletRequest object.

MockRestRequest

attributes(Map<String,Object> value)

Replaces the attributes on the underlying HttpServletRequest object.

MockRestRequest

authType(String value)

Overrides the authorization type value on the underlying HttpServletRequest object.

MockRestRequest

cancellable(Cancellable cancellable)

Sets Cancellable for the ongoing operation.

MockRestRequest

characterEncoding(String value)

Overrides the character encoding value on the underlying HttpServletRequest object.

MockRestRequest

config(RequestConfig value)

Sets the actual request configuration.

MockRestRequest

content(Object value)

Sets the body of this request.

MockRestRequest

content(Object input, HttpPartSchema schema)

Sets the body of this request.

MockRestRequest

contentString(Object input)

Sets the body of this request as straight text bypassing the serializer.

MockRestRequest

contentType(String value)

Sets the value for the Content-Type request header.

MockRestRequest

context(HttpContext context)

Override the context to use for the execution.

MockRestRequest

contextPath(String value)

Overrides the context path on the underlying HttpServletRequest object.

MockRestRequest

cookies(jakarta.servlet.http.Cookie[] value)

Overrides the cookies on the underlying HttpServletRequest object.

MockRestRequest

debug()

Sets Debug: value header on this request.

MockRestRequest

dispatcherType(jakarta.servlet.DispatcherType value)

Overrides the dispatcher type value on the underlying HttpServletRequest object.

MockRestRequest

errorCodes(Predicate<Integer> value)

Allows you to override what status codes are considered error codes that would result in a RestCallException.

MockRestRequest

formData(String name, Object value)

Adds a form-data parameter to the request body.

MockRestRequest

formData(NameValuePair... parts)

Appends multiple form-data parameters to the request.

MockRestRequest

formDataBean(Object value)

Appends multiple form-data parameters to the request from properties defined on a Java bean.

MockRestRequest

formDataCustom(Object value)

Adds form-data parameters as the entire body of the request.

MockRestRequest

formDataPairs(String... pairs)

Adds form-data parameters to the request body using free-form key/value pairs.

Map<String,Object>

getAttributeMap()

Returns the attributes to add to the underlying HttpServletRequest object.

String

getAuthType()

Returns the authorization type value to set on the underlying HttpServletRequest object.

String

getCharacterEncoding()

Returns the value to set for the return value on the underlying ServletRequest.getCharacterEncoding() method.

String

getContextPath()

Returns the context path to set on the underlying HttpServletRequest object.

jakarta.servlet.http.Cookie[]

getCookies()

Returns the cookies to set on the underlying HttpServletRequest object.

jakarta.servlet.DispatcherType

getDispatcherType()

Returns the dispatcher type value to set on the underlying HttpServletRequest object.

jakarta.servlet.http.HttpSession

getHttpSession()

Returns the HTTP session to set on the underlying HttpServletRequest object.

String

getLocalAddr()

Returns the local address value to set on the underlying HttpServletRequest object.

Locale

getLocale()

Returns the locale to set on the underlying HttpServletRequest object.

String

getLocalName()

Returns the local name value to set on the underlying HttpServletRequest object.

Integer

getLocalPort()

Returns the local port value to set on the underlying HttpServletRequest object.

String

getPathInfo()

Returns the path-info value to set on the underlying HttpServletRequest object.

String

getPathTranslated()

Returns the path-translated value to set on the underlying HttpServletRequest object.

String

getProtocol()

Returns the HTTP protocol value to set on the underlying HttpServletRequest object.

String

getQueryString()

Returns the query string to set on the underlying HttpServletRequest object.

String

getRemoteAddr()

Returns the remote address value to set on the underlying HttpServletRequest object.

String

getRemoteHost()

Returns the remote host value to set on the underlying HttpServletRequest object.

Integer

getRemotePort()

Returns the remote port value to set on the underlying HttpServletRequest object.

String

getRemoteUser()

Returns the remote user to set on the underlying HttpServletRequest object.

Map<String,jakarta.servlet.RequestDispatcher>

getRequestDispatcherMap()

Returns the request dispatcher to set on the underlying HttpServletRequest obhject.

String

getRequestedSessionId()

Returns the requested session ID to set on the underlying HttpServletRequest object.

String

getRequestURI()

Returns the request URI to set on the underlying HttpServletRequest object.

String[]

getRoles()

Returns the user roles to set on the underlying HttpServletRequest object.

String

getScheme()

Returns the HTTP schema value to set on the underlying HttpServletRequest object.

String

getServerName()

Returns the server name value to set on the underlying HttpServletRequest object.

Integer

getServerPort()

Returns the server port value to set on the underlying HttpServletRequest object.

jakarta.servlet.ServletContext

getServletContext()

Returns the servlet context to set on the underlying HttpServletRequest object.

String

getServletPath()

Returns the servlet path to set on the underlying HttpServletRequest object.

Principal

getUserPrincipal()

Returns the user principal to set on the underlying HttpServletRequest object.

MockRestRequest

header(String name, Object value)

Appends a header to the request.

MockRestRequest

header(Header part)

Appends a header to the request.

MockRestRequest

headerPairs(String... pairs)

Appends multiple headers to the request using freeform key/value pairs.

MockRestRequest

headers(Header... parts)

Appends multiple headers to the request.

MockRestRequest

headersBean(Object value)

Appends multiple headers to the request from properties defined on a Java bean.

MockRestRequest

html()

Convenience method for specifying HTML as the marshalling transmission media type for this request only.

MockRestRequest

htmlDoc()

Convenience method for specifying HTML DOC as the marshalling transmission media type for this request only.

MockRestRequest

htmlStrippedDoc()

Convenience method for specifying Stripped HTML DOC as the marshalling transmission media type for this request only.

MockRestRequest

httpSession(jakarta.servlet.http.HttpSession value)

Overrides the HTTP session on the underlying HttpServletRequest object.

MockRestRequest

ignoreErrors()

Prevent RestCallExceptions from being thrown when HTTP status 400+ is encountered.

MockRestRequest

interceptors(RestCallInterceptor... interceptors)

Add one or more interceptors for this call only.

MockRestRequest

json()

Convenience method for specifying JSON as the marshalling transmission media type for this request only.

MockRestRequest

json5()

Convenience method for specifying Simplified JSON as the marshalling transmission media type for this request only.

MockRestRequest

localAddr(String value)

Overrides the local address value on the underlying HttpServletRequest object.

MockRestRequest

locale(Locale value)

Overrides the locale on the underlying HttpServletRequest object.

MockRestRequest

localName(String value)

Overrides the local name value on the underlying HttpServletRequest object.

MockRestRequest

localPort(int value)

Overrides the local port value on the underlying HttpServletRequest object.

MockRestRequest

mediaType(String value)

Shortcut for setting the Accept and Content-Type headers on a request.

MockRestRequest

msgPack()

Convenience method for specifying MessagePack as the marshalling transmission media type for this request only.

MockRestRequest

noTrace()

When called, No-Trace: true is added to requests.

MockRestRequest

openApi()

Convenience method for specifying OpenAPI as the marshalling transmission media type for this request only.

MockRestRequest

parser(Class<? extends Parser> parser)

Specifies the parser to use on the response body.

MockRestRequest

parser(Parser parser)

Specifies the parser to use on the response body.

MockRestRequest

pathData(String name, Object value)

Sets or replaces a path parameter of the form "{name}" in the URI.

MockRestRequest

pathData(NameValuePair... parts)

Sets or replaces multiple path parameters on the request.

MockRestRequest

pathDataBean(Object value)

Sets multiple path parameters to the request from properties defined on a Java bean.

MockRestRequest

pathDataPairs(String... pairs)

Replaces path parameters of the form "{name}" in the URI using free-form key/value pairs.

MockRestRequest

pathInfo(String value)

Overrides the path-info value on the underlying HttpServletRequest object.

MockRestRequest

pathTranslated(String value)

Overrides the path-translated value on the underlying HttpServletRequest object.

MockRestRequest

plainText()

Convenience method for specifying Plain Text as the marshalling transmission media type for this request only.

MockRestRequest

protocol(String value)

Overrides the HTTP protocol value on the underlying HttpServletRequest object.

MockRestRequest

protocolVersion(ProtocolVersion version)

Sets the protocol version for this request.

MockRestRequest

queryCustom(Object value)

Adds a free-form custom query.

MockRestRequest

queryData(String name, Object value)

Appends a query parameter to the URI of the request.

MockRestRequest

queryData(NameValuePair... parts)

Appends multiple query parameters to the request.

MockRestRequest

queryDataBean(Object value)

Appends multiple query parameters to the request from properties defined on a Java bean.

MockRestRequest

queryDataPairs(String... pairs)

Adds query parameters to the URI query using free-form key/value pairs..

MockRestRequest

queryString(String value)

Overrides the query string on the underlying HttpServletRequest object.

MockRestRequest

remoteAddr(String value)

Overrides the remote address value on the underlying HttpServletRequest object.

MockRestRequest

remoteHost(String value)

Overrides the remote host value on the underlying HttpServletRequest object.

MockRestRequest

remotePort(int value)

Overrides the remote port value on the underlying HttpServletRequest object.

MockRestRequest

remoteUser(String value)

Overrides the remote user on the underlying HttpServletRequest object.

MockRestRequest

requestDispatcher(String path, jakarta.servlet.RequestDispatcher value)

Overrides the request dispatcher on the underlying HttpServletRequest object.

MockRestRequest

requestedSessionId(String value)

Overrides the requested session ID on the underlying HttpServletRequest object.

MockRestRequest

requestURI(String value)

Overrides the request URI on the underlying HttpServletRequest object.

MockRestRequest

rethrow(Class<?>... values)

Rethrow any of the specified exception types if a matching Exception-Name header is found.

MockRestRequest

role(String role)

Specifies the value for the security roles on the underlying HttpServletRequest object.

MockRestRequest

roles(String... roles)

Specifies the user roles on the underlying HttpServletRequest object.

MockRestRequest

serializer(Class<? extends Serializer> serializer)

Specifies the serializer to use on the request body.

MockRestRequest

serializer(Serializer serializer)

Specifies the serializer to use on the request body.

MockRestRequest

serverName(String value)

Overrides the server name value on the underlying HttpServletRequest object.

MockRestRequest

serverPort(int value)

Overrides the server port value on the underlying HttpServletRequest object.

MockRestRequest

servletContext(jakarta.servlet.ServletContext value)

Overrides the servlet context on the underlying HttpServletRequest object.

MockRestRequest

servletPath(String value)

Overrides the servlet path on the underlying HttpServletRequest object.

MockRestRequest

suppressLogging()

Causes logging to be suppressed for the duration of this request.

MockRestRequest

target(HttpHost target)

Specifies the target host for the request.

MockRestRequest

uon()

Convenience method for specifying UON as the marshalling transmission media type for this request only.

MockRestRequest

uri(Object uri)

Sets the URI for this request.

MockRestRequest

uriFragment(String fragment)

Sets the URI fragment.

MockRestRequest

uriHost(String host)

Sets the URI host.

MockRestRequest

uriPort(int port)

Sets the URI port.

MockRestRequest

uriScheme(String value)

Overrides the HTTP schema value on the underlying HttpServletRequest object.

MockRestRequest

uriUserInfo(String userInfo)

Sets the URI user info.

MockRestRequest

uriUserInfo(String username, String password)

Sets the URI user info.

MockRestRequest

urlEnc()

Convenience method for specifying URL-Encoding as the marshalling transmission media type for this request only.

MockRestRequest

userPrincipal(Principal value)

Overrides the user principal on the underlying HttpServletRequest object.

MockRestRequest

xml()

Convenience method for specifying XML as the marshalling transmission media type for this request only.

Methods inherited from class org.apache.juneau.rest.client.RestRequest
abort, addHeader, addHeader, close, complete, completed, completeFuture, containsHeader, createHeader, createInnerRequest, createPart, getAllHeaders, getConfig, getFirstHeader, getFormData, getHeaders, getHeaders, getHttpEntity, getLastHeader, getMethod, getParams, getPathData, getProtocolVersion, getQueryData, getRequestLine, getResponse, getResponse, getResponseAsString, getURI, hasHttpEntity, headerIterator, headerIterator, isAborted, isDebug, log, log, properties, removeHeader, removeHeaders, run, runFuture, setHeader, setHeader, setHeaders, setParams

Methods inherited from class org.apache.juneau.BeanSession
addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession
checkForWarnings, getContext, getSessionProperties, getWarnings, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- MockRestRequest
  
  protected MockRestRequest(RestClient client, URI uri, String method, boolean hasBody) throws RestCallException
  
  Constructs a REST call with the specified method name.
  
  Parameters:
  
  client - The client that created this request.
  
  uri - The target URI.
  
  method - The HTTP method name (uppercase).
  
  hasBody - Whether this method has a body.
  
  Throws:
  
  RestCallException - If an exception or non-200 response code occurred during the connection attempt.
Method Details
- accept
  
  public MockRestRequest accept(String value) throws RestCallException
  
  Description copied from class: RestRequest
  
  Sets the value for the Accept request header.
  This overrides the media type specified on the parser, but is overridden by calling header("Accept", value);
  
  Overrides:
  
  accept in class RestRequest
  
  Parameters:
  
  value - The new header value.
  Can be null (header will not be set).
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- acceptCharset
  
  public MockRestRequest acceptCharset(String value) throws RestCallException
  
  Description copied from class: RestRequest
  
  Sets the value for the Accept-Charset request header.
  This is a shortcut for calling header("Accept-Charset", value);
  
  Overrides:
  
  acceptCharset in class RestRequest
  
  Parameters:
  
  value - The new header value.
  Can be null (header will not be set).
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- attribute
  
  public MockRestRequest attribute(String name, Object value)
  
  Adds an attribute to the underlying HttpServletRequest object.
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  name - The servlet request attribute name.
  
  value - The servlet request attribute value.
  
  Returns:
  
  This object.
- attributes
  
  public MockRestRequest attributes(Map<String,Object> value)
  
  Replaces the attributes on the underlying HttpServletRequest object.
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new servlet attribute values.
  
  Returns:
  
  This object.
- authType
  
  public MockRestRequest authType(String value)
  
  Overrides the authorization type value on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getAuthType().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- cancellable
  
  public MockRestRequest cancellable(Cancellable cancellable)
  
  Description copied from class: RestRequest
  
  Sets Cancellable for the ongoing operation.
  
  Overrides:
  
  cancellable in class RestRequest
  
  Parameters:
  
  cancellable - The cancellable object.
  Can be null (no cancellation will be available).
  
  Returns:
  
  This object.
- characterEncoding
  
  public MockRestRequest characterEncoding(String value)
  
  Overrides the character encoding value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getCharacterEncoding().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- config
  
  public MockRestRequest config(RequestConfig value)
  
  Description copied from class: RestRequest
  
  Sets the actual request configuration.
  
  Overrides:
  
  config in class RestRequest
  
  Parameters:
  
  value - The new value.
  Can be null (default configuration will be used).
  
  Returns:
  
  This object.
- content
  
  public MockRestRequest content(Object value)
  
  Description copied from class: RestRequest
  
  Sets the body of this request.
  Overrides:
  
  content in class RestRequest
  
  Parameters:
  
  value - The input to be sent to the REST resource (only valid for PUT/POST/PATCH) requests.
  Can be of the following types:
  
  Reader - Raw contents of Reader will be serialized to remote resource.
  InputStream - Raw contents of InputStream will be serialized to remote resource.
  HttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
  HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
  Object - POJO to be converted to text using the Serializer registered with the RestClient.
  PartList - Converted to a URL-encoded FORM post.
  A Supplier of anything on this list.
  
  Can be null (no body will be sent).
  
  Returns:
  
  This object.
- content
  
  public MockRestRequest content(Object input, HttpPartSchema schema)
  
  Description copied from class: RestRequest
  
  Sets the body of this request.
  Overrides:
  
  content in class RestRequest
  
  Parameters:
  
  input - The input to be sent to the REST resource (only valid for PUT/POST/PATCH) requests.
  Can be of the following types:
  
  Reader - Raw contents of Reader will be serialized to remote resource.
  InputStream - Raw contents of InputStream will be serialized to remote resource.
  HttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
  HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
  Object - POJO to be converted to text using the Serializer registered with the RestClient.
  PartList - Converted to a URL-encoded FORM post.
  A Supplier of anything on this list.
  
  schema - The schema object that defines the format of the output.
  
  If null, defaults to HttpPartSchema.DEFAULT.
  Only used if serializer is schema-aware (e.g. OpenApiSerializer).
  
  Returns:
  
  This object.
- contentString
  
  public MockRestRequest contentString(Object input) throws RestCallException
  
  Description copied from class: RestRequest
  
  Sets the body of this request as straight text bypassing the serializer.
  client .put("/foo") .content(new StringReader("foo")) .contentType("text/foo") .run(); client .put("/foo") .bodyString("foo") .run();
  
  Note that this is different than the following which will serialize foo as a JSON string "foo".
  client .put("/foo") .json() .content("foo") .run();
  
  Overrides:
  
  contentString in class RestRequest
  
  Parameters:
  
  input - The input to be sent to the REST resource (only valid for PUT/POST/PATCH) requests.
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - If a retry was attempted, but the entity was not repeatable.
- contentType
  
  public MockRestRequest contentType(String value) throws RestCallException
  
  Description copied from class: RestRequest
  
  Sets the value for the Content-Type request header.
  This overrides the media type specified on the serializer, but is overridden by calling header("Content-Type", value);
  
  Overrides:
  
  contentType in class RestRequest
  
  Parameters:
  
  value - The new header value.
  Can be null (header will not be set).
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- context
  
  public MockRestRequest context(HttpContext context)
  
  Description copied from class: RestRequest
  
  Override the context to use for the execution.
  
  Overrides:
  
  context in class RestRequest
  
  Parameters:
  
  context - The context to use for the execution, or null to use the default context.
  
  Returns:
  
  This object.
- contextPath
  
  public MockRestRequest contextPath(String value)
  
  Overrides the context path on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getContextPath().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- cookies
  
  public MockRestRequest cookies(jakarta.servlet.http.Cookie[] value)
  
  Overrides the cookies on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getCookies().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- debug
  
  public MockRestRequest debug() throws RestCallException
  
  Description copied from class: RestRequest
  
  Sets Debug: value header on this request.
  
  Overrides:
  
  debug in class RestRequest
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- dispatcherType
  
  public MockRestRequest dispatcherType(jakarta.servlet.DispatcherType value)
  
  Overrides the dispatcher type value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getDispatcherType().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- errorCodes
  
  public MockRestRequest errorCodes(Predicate<Integer> value)
  
  Description copied from class: RestRequest
  
  Allows you to override what status codes are considered error codes that would result in a RestCallException.
  The default error code predicate is: x -> x >= 400.
  
  Overrides:
  
  errorCodes in class RestRequest
  
  Parameters:
  
  value - The new predicate for calculating error codes.
  Cannot be null.
  
  Returns:
  
  This object.
- formData
  
  public MockRestRequest formData(NameValuePair... parts)
  
  Description copied from class: RestRequest
  
  Appends multiple form-data parameters to the request.
  Example:
  
  // Appends two form-data parameters to the request. client .get(URI) .formData( BasicStringPart.of("foo", "bar"), BasicBooleanPart.of("baz", true) ) .run();
  
  Overrides:
  
  formData in class RestRequest
  
  Parameters:
  
  parts - The parameters to set. null values are ignored.
  
  Returns:
  
  This object.
- formData
  
  public MockRestRequest formData(String name, Object value)
  
  Description copied from class: RestRequest
  
  Adds a form-data parameter to the request body.
  Example:
  
  // Adds form data parameter "foo=bar". client .formPost(URI) .formData("foo", "bar") .run();
  
  Overrides:
  
  formData in class RestRequest
  
  Parameters:
  
  name - The parameter name.
  Cannot be null or empty (parameter will not be created).
  
  value - The parameter value.
  Non-string values are converted to strings using the HttpPartSerializer defined on the client.
  Can be null.
  
  Returns:
  
  This object.
- formDataBean
  
  public MockRestRequest formDataBean(Object value)
  
  Description copied from class: RestRequest
  
  Appends multiple form-data parameters to the request from properties defined on a Java bean.
  Example:
  
  public class MyFormData { public String getFooBar() { return "baz"; } public Integer getQux() { return 123; } } // Appends form data "fooBar=baz&qux=123". client .get(URI) .formDataBean(new MyFormData()) .run();
  
  Overrides:
  
  formDataBean in class RestRequest
  
  Parameters:
  
  value - The bean containing the properties to set as form-data parameter values.
  Cannot be null.
  
  Returns:
  
  This object.
- formDataCustom
  
  public MockRestRequest formDataCustom(Object value)
  
  Description copied from class: RestRequest
  
  Adds form-data parameters as the entire body of the request.
  Example:
  
  // Creates form data "foo=bar&baz=qux". client .formPost(URI) .formDataCustom("foo=bar&baz=qux") .run(); // Creates form data "foo=bar&baz=qux" using StringEntity. client .formPost(URI) .formDataCustom(new StringEntity("foo=bar&baz=qux","application/x-www-form-urlencoded")) .run(); // Creates form data "foo=bar&baz=qux" using StringEntity and body(). client .formPost(URI) .content(new StringEntity("foo=bar&baz=qux","application/x-www-form-urlencoded")) .run();
  Overrides:
  
  formDataCustom in class RestRequest
  
  Parameters:
  
  value - The parameter value.
  Can be any of the following types:
  
  CharSequence
  Reader - Raw contents of Reader will be serialized to remote resource.
  InputStream - Raw contents of InputStream will be serialized to remote resource.
  HttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
  HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
  Object - POJO to be converted to text using the Serializer registered with the RestClient.
  PartList - Converted to a URL-encoded FORM post.
  
  Can be null (no body will be sent).
  
  Returns:
  
  This object.
- formDataPairs
  
  public MockRestRequest formDataPairs(String... pairs) throws RestCallException
  
  Description copied from class: RestRequest
  
  Adds form-data parameters to the request body using free-form key/value pairs.
  Example:
  
  // Creates form data "key1=val1&key2=val2". client .formPost(URI) .formDataPairs("key1","val1","key2","val2") .run();
  Overrides:
  
  formDataPairs in class RestRequest
  
  Parameters:
  
  pairs - The form-data key/value pairs.
  
  Values can be any POJO.
  Values converted to a string using the configured part serializer.
  
  Cannot be null.
  Must have an even number of elements (key/value pairs).
  Null keys are ignored (parameter will not be created).
  Null values are allowed.
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- getAttributeMap
  
  public Map<String,Object> getAttributeMap()
  
  Returns the attributes to add to the underlying HttpServletRequest object.
  
  Returns:
  
  The attributes to add to the underlying HttpServletRequest object.
- getAuthType
  
  public String getAuthType()
  
  Returns the authorization type value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The authorization type value to set on the underlying HttpServletRequest object.
- getCharacterEncoding
  
  public String getCharacterEncoding()
  
  Returns the value to set for the return value on the underlying ServletRequest.getCharacterEncoding() method.
  
  Returns:
  
  The value to set for the return value on the underlying ServletRequest.getCharacterEncoding() method.
- getContextPath
  
  public String getContextPath()
  
  Returns the context path to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The context path to set on the underlying HttpServletRequest object.
- getCookies
  
  public jakarta.servlet.http.Cookie[] getCookies()
  
  Returns the cookies to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The cookies to set on the underlying HttpServletRequest object.
- getDispatcherType
  
  public jakarta.servlet.DispatcherType getDispatcherType()
  
  Returns the dispatcher type value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The dispatcher type value to set on the underlying HttpServletRequest object.
- getHttpSession
  
  public jakarta.servlet.http.HttpSession getHttpSession()
  
  Returns the HTTP session to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The HTTP session to set on the underlying HttpServletRequest object.
- getLocalAddr
  
  public String getLocalAddr()
  
  Returns the local address value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The local address value to set on the underlying HttpServletRequest object.
- getLocale
  
  public Locale getLocale()
  
  Returns the locale to set on the underlying HttpServletRequest object.
  Overrides:
  
  getLocale in class BeanSession
  
  Returns:
  
  The locale to set on the underlying HttpServletRequest object.
  
  See Also:
  
  BeanContext.Builder.locale(Locale)
- getLocalName
  
  public String getLocalName()
  
  Returns the local name value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The local name value to set on the underlying HttpServletRequest object.
- getLocalPort
  
  public Integer getLocalPort()
  
  Returns the local port value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The local port value to set on the underlying HttpServletRequest object.
- getPathInfo
  
  public String getPathInfo()
  
  Returns the path-info value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The path-info value to set on the underlying HttpServletRequest object.
- getPathTranslated
  
  public String getPathTranslated()
  
  Returns the path-translated value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The path-translated value to set on the underlying HttpServletRequest object.
- getProtocol
  
  public String getProtocol()
  
  Returns the HTTP protocol value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The HTTP protocol value to set on the underlying HttpServletRequest object.
- getQueryString
  
  public String getQueryString()
  
  Returns the query string to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The query string to set on the underlying HttpServletRequest object.
- getRemoteAddr
  
  public String getRemoteAddr()
  
  Returns the remote address value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The remote address value to set on the underlying HttpServletRequest object.
- getRemoteHost
  
  public String getRemoteHost()
  
  Returns the remote host value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The remote host value to set on the underlying HttpServletRequest object.
- getRemotePort
  
  public Integer getRemotePort()
  
  Returns the remote port value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The remote port value to set on the underlying HttpServletRequest object.
- getRemoteUser
  
  public String getRemoteUser()
  
  Returns the remote user to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The remote user to set on the underlying HttpServletRequest object.
- getRequestDispatcherMap
  
  public Map<String,jakarta.servlet.RequestDispatcher> getRequestDispatcherMap()
  
  Returns the request dispatcher to set on the underlying HttpServletRequest obhject.
  
  Returns:
  
  The value of the requestDispatcherMap property on this bean, or null if it is not set.
- getRequestedSessionId
  
  public String getRequestedSessionId()
  
  Returns the requested session ID to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The requested session ID to set on the underlying HttpServletRequest object.
- getRequestURI
  
  public String getRequestURI()
  
  Returns the request URI to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The request URI to set on the underlying HttpServletRequest object.
- getRoles
  
  public String[] getRoles()
  
  Returns the user roles to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The user roles to set on the underlying HttpServletRequest object.
- getScheme
  
  public String getScheme()
  
  Returns the HTTP schema value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The HTTP schema value to set on the underlying HttpServletRequest object.
- getServerName
  
  public String getServerName()
  
  Returns the server name value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The server name value to set on the underlying HttpServletRequest object.
- getServerPort
  
  public Integer getServerPort()
  
  Returns the server port value to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The server port value to set on the underlying HttpServletRequest object.
- getServletContext
  
  public jakarta.servlet.ServletContext getServletContext()
  
  Returns the servlet context to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The servlet context to set on the underlying HttpServletRequest object.
- getServletPath
  
  public String getServletPath()
  
  Returns the servlet path to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The servlet path to set on the underlying HttpServletRequest object.
- getUserPrincipal
  
  public Principal getUserPrincipal()
  
  Returns the user principal to set on the underlying HttpServletRequest object.
  
  Returns:
  
  The user principal to set on the underlying HttpServletRequest object.
- header
  
  public MockRestRequest header(Header part)
  
  Description copied from class: RestRequest
  
  Appends a header to the request.
  Example:
  
  // Adds header "Foo: bar". client .get(URI) .header(Accept.TEXT_XML) .run();
  
  Overrides:
  
  header in class RestRequest
  
  Parameters:
  
  part - The parameter to set. null values are ignored.
  
  Returns:
  
  This object.
- header
  
  public MockRestRequest header(String name, Object value)
  
  Description copied from class: RestRequest
  
  Appends a header to the request.
  Example:
  
  // Adds header "Foo: bar". client .get(URI) .header("Foo", "bar") .run();
  
  Overrides:
  
  header in class RestRequest
  
  Parameters:
  
  name - The parameter name.
  
  value - The parameter value.
  Non-string values are converted to strings using the HttpPartSerializer defined on the client.
  
  Returns:
  
  This object.
- headerPairs
  
  public MockRestRequest headerPairs(String... pairs)
  
  Description copied from class: RestRequest
  
  Appends multiple headers to the request using freeform key/value pairs.
  Example:
  
  // Adds headers "Foo: bar" and "Baz: qux". client .get(URI) .headerPairs("Foo","bar","Baz","qux") .run();
  
  Overrides:
  
  headerPairs in class RestRequest
  
  Parameters:
  
  pairs - The header key/value pairs.
  Cannot be null.
  Must have an even number of elements (key/value pairs).
  Null keys are ignored (header will not be created).
  Null values are allowed.
  
  Returns:
  
  This object.
- headers
  
  public MockRestRequest headers(Header... parts)
  
  Description copied from class: RestRequest
  
  Appends multiple headers to the request.
  Example:
  
  // Appends two headers to the request. client .get(URI) .headers( BasicHeader.of("Foo", "bar"), Accept.TEXT_XML ) .run();
  
  Overrides:
  
  headers in class RestRequest
  
  Parameters:
  
  parts - The parameters to set. null values are ignored.
  
  Returns:
  
  This object.
- headersBean
  
  public MockRestRequest headersBean(Object value)
  
  Description copied from class: RestRequest
  
  Appends multiple headers to the request from properties defined on a Java bean.
  Uses PropertyNamerDUCS for resolving the header names from property names.
  Example:
  
  @Bean public class MyHeaders { public String getFooBar() { return "baz"; } public Integer getQux() { return 123; } } // Appends headers "Foo-Bar: baz" and "Qux: 123". client .get(URI) .headersBean(new MyHeaders()) .run();
  
  Overrides:
  
  headersBean in class RestRequest
  
  Parameters:
  
  value - The bean containing the properties to set as header values.
  Cannot be null.
  
  Returns:
  
  This object.
- html
  
  public MockRestRequest html()
  
  Description copied from class: RestRequest
  Convenience method for specifying HTML as the marshalling transmission media type for this request only.
  POJOs are converted to HTML without any sort of doc wrappers.
  HtmlSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  HtmlParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/html" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/html" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(HtmlSerializer.class).parser(HtmlParser.class).
  Overrides:
  
  html in class RestRequest
  
  Returns:
  
  This object.
- htmlDoc
  
  public MockRestRequest htmlDoc()
  
  Description copied from class: RestRequest
  Convenience method for specifying HTML DOC as the marshalling transmission media type for this request only.
  POJOs are converted to fully renderable HTML pages.
  HtmlDocSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  HtmlParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/html" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/html" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(HtmlDocSerializer.class).parser(HtmlParser.class).
  Overrides:
  
  htmlDoc in class RestRequest
  
  Returns:
  
  This object.
- htmlStrippedDoc
  
  public MockRestRequest htmlStrippedDoc()
  
  Description copied from class: RestRequest
  Convenience method for specifying Stripped HTML DOC as the marshalling transmission media type for this request only.
  Same as RestRequest.htmlDoc() but without the header and body tags and page title and description.
  HtmlStrippedDocSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  HtmlParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/html+stripped" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/html+stripped" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(HtmlStrippedDocSerializer.class).parser(HtmlParser.class).
  Overrides:
  
  htmlStrippedDoc in class RestRequest
  
  Returns:
  
  This object.
- httpSession
  
  public MockRestRequest httpSession(jakarta.servlet.http.HttpSession value)
  
  Overrides the HTTP session on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getSession().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- ignoreErrors
  
  public MockRestRequest ignoreErrors()
  
  Description copied from class: RestRequest
  
  Prevent RestCallExceptions from being thrown when HTTP status 400+ is encountered.
  This overrides the ignoreErrors property on the client.
  
  Overrides:
  
  ignoreErrors in class RestRequest
  
  Returns:
  
  This object.
- interceptors
  
  public MockRestRequest interceptors(RestCallInterceptor... interceptors) throws RestCallException
  
  Description copied from class: RestRequest
  
  Add one or more interceptors for this call only.
  
  Overrides:
  
  interceptors in class RestRequest
  
  Parameters:
  
  interceptors - The interceptors to add to this call.
  Cannot contain null values.
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - If init method on interceptor threw an exception.
- json
  
  public MockRestRequest json()
  
  Description copied from class: RestRequest
  Convenience method for specifying JSON as the marshalling transmission media type for this request only.
  JsonSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  JsonParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "application/json" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "application/json" unless overridden RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(JsonSerializer.class).parser(JsonParser.class).
  Overrides:
  
  json in class RestRequest
  
  Returns:
  
  This object.
- json5
  
  public MockRestRequest json5()
  
  Description copied from class: RestRequest
  Convenience method for specifying Simplified JSON as the marshalling transmission media type for this request only.
  Simplified JSON is typically useful for automated tests because you can do simple string comparison of results without having to escape lots of quotes.
  Json5Serializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Json5Parser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "application/json" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String), or per-request via RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "application/json+simple" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String), or per-request via RestRequest.header(String,Object) or RestRequest.contentType(String).
  Can be combined with other marshaller setters such as RestRequest.xml() to provide support for multiple languages.
  
  When multiple languages are supported, the Accept and Content-Type headers control which marshallers are used, or uses the last-enabled language if the headers are not set.
  
  Identical to calling serializer(Json5Serializer.class).parser(Json5Parser.class).
  Overrides:
  
  json5 in class RestRequest
  
  Returns:
  
  This object.
- localAddr
  
  public MockRestRequest localAddr(String value)
  
  Overrides the local address value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getLocalAddr().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- locale
  
  public MockRestRequest locale(Locale value)
  
  Overrides the locale on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getLocale().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- localName
  
  public MockRestRequest localName(String value)
  
  Overrides the local name value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getLocalName().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- localPort
  
  public MockRestRequest localPort(int value)
  
  Overrides the local port value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getLocalPort().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- mediaType
  
  public MockRestRequest mediaType(String value) throws RestCallException
  
  Description copied from class: RestRequest
  
  Shortcut for setting the Accept and Content-Type headers on a request.
  
  Overrides:
  
  mediaType in class RestRequest
  
  Parameters:
  
  value - The new header values.
  Can be null (headers will not be set).
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- msgPack
  
  public MockRestRequest msgPack()
  
  Description copied from class: RestRequest
  Convenience method for specifying MessagePack as the marshalling transmission media type for this request only.
  MessagePack is a binary equivalent to JSON that takes up considerably less space than JSON.
  MsgPackSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  MsgPackParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "octal/msgpack" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "octal/msgpack" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(MsgPackSerializer.class).parser(MsgPackParser.class).
  Overrides:
  
  msgPack in class RestRequest
  
  Returns:
  
  This object.
- noTrace
  
  public MockRestRequest noTrace() throws RestCallException
  
  Description copied from class: RestRequest
  
  When called, No-Trace: true is added to requests.
  This gives the opportunity for the servlet to not log errors on invalid requests. This is useful for testing purposes when you don't want your log file to show lots of errors that are simply the results of testing.
  
  Overrides:
  
  noTrace in class RestRequest
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- openApi
  
  public MockRestRequest openApi()
  
  Description copied from class: RestRequest
  Convenience method for specifying OpenAPI as the marshalling transmission media type for this request only.
  OpenAPI is a language that allows serialization to formats that use HttpPartSchema objects to describe their structure.
  OpenApiSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  Typically the RestRequest.content(Object, HttpPartSchema) method will be used to specify the body of the request with the schema describing it's structure.
  
  OpenApiParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  Typically the ResponseContent.schema(HttpPartSchema) method will be used to specify the structure of the response body.
  
  Accept request header will be set to "text/openapi" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/openapi" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(OpenApiSerializer.class).parser(OpenApiParser.class).
  Overrides:
  
  openApi in class RestRequest
  
  Returns:
  
  This object.
- parser
  
  public MockRestRequest parser(Class<? extends Parser> parser)
  
  Description copied from class: RestRequest
  
  Specifies the parser to use on the response body.
  Overrides the parsers specified on the RestClient.
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  If the Accept header is not set on the request, it will be set to the media type of this parser.
  
  Overrides:
  
  parser in class RestRequest
  
  Parameters:
  
  parser - The parser used to parse POJOs from the body of the HTTP response.
  Cannot be null.
  
  Returns:
  
  This object.
- parser
  
  public MockRestRequest parser(Parser parser)
  
  Description copied from class: RestRequest
  
  Specifies the parser to use on the response body.
  Overrides the parsers specified on the RestClient.
  The parser is not modified by any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  If the Accept header is not set on the request, it will be set to the media type of this parser.
  
  Overrides:
  
  parser in class RestRequest
  
  Parameters:
  
  parser - The parser used to parse POJOs from the body of the HTTP response.
  Cannot be null.
  
  Returns:
  
  This object.
- pathData
  
  public MockRestRequest pathData(NameValuePair... parts)
  
  Description copied from class: RestRequest
  
  Sets or replaces multiple path parameters on the request.
  Example:
  
  // Appends two path parameters to the request. client .get(URI) .pathData( BasicStringPart.of("foo", "bar"), BasicBooleanPart.of("baz", true) ) .run();
  
  Overrides:
  
  pathData in class RestRequest
  
  Parameters:
  
  parts - The parameters to set. null values are ignored.
  
  Returns:
  
  This object.
- pathData
  
  public MockRestRequest pathData(String name, Object value)
  
  Description copied from class: RestRequest
  
  Sets or replaces a path parameter of the form "{name}" in the URI.
  Example:
  
  // Sets path to "/bar". client .get("/{foo}") .pathData("foo", "bar") .run();
  
  Overrides:
  
  pathData in class RestRequest
  
  Parameters:
  
  name - The parameter name.
  Cannot be null or empty (parameter will not be created).
  
  value - The parameter value.
  Non-string values are converted to strings using the HttpPartSerializer defined on the client.
  Can be null.
  
  Returns:
  
  This object.
- pathDataBean
  
  public MockRestRequest pathDataBean(Object value)
  
  Description copied from class: RestRequest
  
  Sets multiple path parameters to the request from properties defined on a Java bean.
  Example:
  
  public class MyPathVars { public String getFooBar() { return "baz"; } public Integer getQux() { return 123; } } // Given path "/{fooBar}/{qux}/", gets converted to "/baz/123/". client .get(URI) .pathDataBean(new MyPathVars()) .run();
  
  Overrides:
  
  pathDataBean in class RestRequest
  
  Parameters:
  
  value - The bean containing the properties to set as path parameter values.
  Cannot be null.
  
  Returns:
  
  This object.
- pathDataPairs
  
  public MockRestRequest pathDataPairs(String... pairs)
  
  Description copied from class: RestRequest
  
  Replaces path parameters of the form "{name}" in the URI using free-form key/value pairs.
  Example:
  
  // Sets path to "/baz/qux". client .get("/{foo}/{bar}") .pathDataPairs( "foo","baz", "bar","qux" ) .run();
  Overrides:
  
  pathDataPairs in class RestRequest
  
  Parameters:
  
  pairs - The path key/value pairs.
  
  Values can be any POJO.
  Values converted to a string using the configured part serializer.
  
  Cannot be null.
  Must have an even number of elements (key/value pairs).
  Null keys are ignored (parameter will not be created).
  Null values are allowed.
  
  Returns:
  
  This object.
- pathInfo
  
  public MockRestRequest pathInfo(String value)
  
  Overrides the path-info value on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getPathInfo().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- pathTranslated
  
  public MockRestRequest pathTranslated(String value)
  
  Overrides the path-translated value on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getPathTranslated().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- plainText
  
  public MockRestRequest plainText()
  
  Description copied from class: RestRequest
  Convenience method for specifying Plain Text as the marshalling transmission media type for this request only.
  Plain text marshalling typically only works on simple POJOs that can be converted to and from strings using swaps, swap methods, etc...
  PlainTextSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  PlainTextParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/plain" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/plain" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(PlainTextSerializer.class).parser(PlainTextParser.class).
  Overrides:
  
  plainText in class RestRequest
  
  Returns:
  
  This object.
- protocol
  
  public MockRestRequest protocol(String value)
  
  Overrides the HTTP protocol value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getProtocol().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- protocolVersion
  
  public MockRestRequest protocolVersion(ProtocolVersion version)
  
  Description copied from class: RestRequest
  
  Sets the protocol version for this request.
  
  Overrides:
  
  protocolVersion in class RestRequest
  
  Parameters:
  
  version - The protocol version for this request.
  Can be null (default protocol version will be used).
  
  Returns:
  
  This object.
- queryCustom
  
  public MockRestRequest queryCustom(Object value)
  
  Description copied from class: RestRequest
  
  Adds a free-form custom query.
  Example:
  
  // Adds query parameter "foo=bar&baz=qux". client .get(URI) .queryCustom("foo=bar&baz=qux") .run();
  Overrides:
  
  queryCustom in class RestRequest
  
  Parameters:
  
  value - The parameter value.
  Can be any of the following types:
  
  CharSequence
  Reader - Raw contents of Reader will be serialized to remote resource.
  InputStream - Raw contents of InputStream will be serialized to remote resource.
  PartList - Converted to a URL-encoded query.
  
  Can be null (no custom query will be set).
  
  Returns:
  
  This object.
- queryData
  
  public MockRestRequest queryData(NameValuePair... parts)
  
  Description copied from class: RestRequest
  
  Appends multiple query parameters to the request.
  Example:
  
  // Appends two query parameters to the request. client .get(URI) .queryData( BasicStringPart.of("foo", "bar"), BasicBooleanPart.of("baz", true) ) .run();
  
  Overrides:
  
  queryData in class RestRequest
  
  Parameters:
  
  parts - The parameters to set. null values are ignored.
  
  Returns:
  
  This object.
- queryData
  
  public MockRestRequest queryData(String name, Object value)
  
  Description copied from class: RestRequest
  
  Appends a query parameter to the URI of the request.
  Example:
  
  // Adds query parameter "foo=bar". client .get(URI) .queryData("foo", "bar") .run();
  
  Overrides:
  
  queryData in class RestRequest
  
  Parameters:
  
  name - The parameter name.
  Cannot be null or empty (parameter will not be created).
  
  value - The parameter value.
  Non-string values are converted to strings using the HttpPartSerializer defined on the client.
  Can be null.
  
  Returns:
  
  This object.
- queryDataBean
  
  public MockRestRequest queryDataBean(Object value)
  
  Description copied from class: RestRequest
  
  Appends multiple query parameters to the request from properties defined on a Java bean.
  Example:
  
  public class MyQuery { public String getFooBar() { return "baz"; } public Integer getQux() { return 123; } } // Appends query "fooBar=baz&qux=123". client .get(URI) .queryDataBean(new MyQuery()) .run();
  
  Overrides:
  
  queryDataBean in class RestRequest
  
  Parameters:
  
  value - The bean containing the properties to set as query parameter values.
  Cannot be null.
  
  Returns:
  
  This object.
- queryDataPairs
  
  public MockRestRequest queryDataPairs(String... pairs) throws RestCallException
  
  Description copied from class: RestRequest
  
  Adds query parameters to the URI query using free-form key/value pairs..
  Example:
  
  // Adds query parameters "foo=bar&baz=qux". client .get(URI) .queryDataPairs("foo","bar","baz","qux") .run();
  Overrides:
  
  queryDataPairs in class RestRequest
  
  Parameters:
  
  pairs - The query key/value pairs.
  
  Values can be any POJO.
  Values converted to a string using the configured part serializer.
  
  Cannot be null.
  Must have an even number of elements (key/value pairs).
  Null keys are ignored (parameter will not be created).
  Null values are allowed.
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid input.
- queryString
  
  public MockRestRequest queryString(String value)
  
  Overrides the query string on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getQueryString().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- remoteAddr
  
  public MockRestRequest remoteAddr(String value)
  
  Overrides the remote address value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getRemoteAddr().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- remoteHost
  
  public MockRestRequest remoteHost(String value)
  
  Overrides the remote host value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getRemoteHost().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- remotePort
  
  public MockRestRequest remotePort(int value)
  
  Overrides the remote port value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getRemotePort().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- remoteUser
  
  public MockRestRequest remoteUser(String value)
  
  Overrides the remote user on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getRemoteUser().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- requestDispatcher
  
  public MockRestRequest requestDispatcher(String path, jakarta.servlet.RequestDispatcher value)
  
  Overrides the request dispatcher on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getRequestDispatcher(String).
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  path - The path to the resource being resolved.
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- requestedSessionId
  
  public MockRestRequest requestedSessionId(String value)
  
  Overrides the requested session ID on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getRequestedSessionId().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- requestURI
  
  public MockRestRequest requestURI(String value)
  
  Overrides the request URI on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getRequestURI().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- rethrow
  
  public MockRestRequest rethrow(Class<?>... values)
  
  Description copied from class: RestRequest
  
  Rethrow any of the specified exception types if a matching Exception-Name header is found.
  Rethrown exceptions will be set on the caused-by exception of RestCallException when thrown from the RestRequest.run() method.
  Can be called multiple times to append multiple rethrows.
  
  Overrides:
  
  rethrow in class RestRequest
  
  Parameters:
  
  values - The classes to rethrow.
  Cannot be null.
  Null elements are ignored (only non-null classes that extend Throwable are added).
  
  Returns:
  
  This object.
- role
  
  public MockRestRequest role(String role)
  
  Specifies the value for the security roles on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.isUserInRole(String).
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  role - The role to add to this request (e.g. "ROLE_ADMIN").
  
  Returns:
  
  This object.
- roles
  
  public MockRestRequest roles(String... roles)
  
  Specifies the user roles on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.isUserInRole(String).
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  roles - The roles to add to this request (e.g. "ROLE_ADMIN").
  
  Returns:
  
  This object.
- serializer
  
  public MockRestRequest serializer(Class<? extends Serializer> serializer)
  
  Description copied from class: RestRequest
  
  Specifies the serializer to use on the request body.
  Overrides the serializers specified on the RestClient.
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  If the Content-Type header is not set on the request, it will be set to the media type of this serializer.
  
  Overrides:
  
  serializer in class RestRequest
  
  Parameters:
  
  serializer - The serializer used to serialize POJOs to the body of the HTTP request.
  Can be null (will use default serializer matching Content-Type).
  
  Returns:
  
  This object.
- serializer
  
  public MockRestRequest serializer(Serializer serializer)
  
  Description copied from class: RestRequest
  
  Specifies the serializer to use on the request body.
  Overrides the serializers specified on the RestClient.
  The serializer is not modified by an of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  If the Content-Type header is not set on the request, it will be set to the media type of this serializer.
  
  Overrides:
  
  serializer in class RestRequest
  
  Parameters:
  
  serializer - The serializer used to serialize POJOs to the body of the HTTP request.
  Can be null (will use default serializer matching Content-Type).
  
  Returns:
  
  This object.
- serverName
  
  public MockRestRequest serverName(String value)
  
  Overrides the server name value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getServerName().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- serverPort
  
  public MockRestRequest serverPort(int value)
  
  Overrides the server port value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getServerPort().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- servletContext
  
  public MockRestRequest servletContext(jakarta.servlet.ServletContext value)
  
  Overrides the servlet context on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getServletContext().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- servletPath
  
  public MockRestRequest servletPath(String value)
  
  Overrides the servlet path on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getServletPath().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- suppressLogging
  
  public MockRestRequest suppressLogging()
  
  Description copied from class: RestRequest
  
  Causes logging to be suppressed for the duration of this request.
  Overrides the RestRequest.debug() setting on this request or client.
  
  Overrides:
  
  suppressLogging in class RestRequest
  
  Returns:
  
  This object.
- target
  
  public MockRestRequest target(HttpHost target)
  
  Description copied from class: RestRequest
  
  Specifies the target host for the request.
  
  Overrides:
  
  target in class RestRequest
  
  Parameters:
  
  target - The target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
  
  Returns:
  
  This object.
- uon
  
  public MockRestRequest uon()
  
  Description copied from class: RestRequest
  Convenience method for specifying UON as the marshalling transmission media type for this request only.
  UON is Url-Encoding Object notation that is equivalent to JSON but suitable for transmission as URL-encoded query and form post values.
  UonSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  UonParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/uon" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/uon" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(UonSerializer.class).parser(UonParser.class).
  Overrides:
  
  uon in class RestRequest
  
  Returns:
  
  This object.
- uri
  
  public MockRestRequest uri(Object uri) throws RestCallException
  
  Description copied from class: RestRequest
  Sets the URI for this request.
  Can be any of the following types:
  
  URI
  URL
  URIBuilder
  Anything else converted to a string using Object.toString().
  
  Relative URI strings will be interpreted as relative to the root URI defined on the client.
  Overrides:
  
  uri in class RestRequest
  
  Parameters:
  
  uri - The URI of the remote REST resource.
  This overrides the URI passed in from the client.
  Can be any of the following types:
  
  URIBuilder
  URI
  URL
  String
  Object - Converted to String using toString()
  
  Cannot be null.
  
  Returns:
  
  This object.
  
  Throws:
  
  RestCallException - Invalid URI syntax detected.
- uriFragment
  
  public MockRestRequest uriFragment(String fragment)
  
  Description copied from class: RestRequest
  
  Sets the URI fragment.
  
  Overrides:
  
  uriFragment in class RestRequest
  
  Parameters:
  
  fragment - The URI fragment. The value is expected to be unescaped and may contain non ASCII characters.
  Can be null (fragment will be cleared).
  
  Returns:
  
  This object.
- uriHost
  
  public MockRestRequest uriHost(String host)
  
  Description copied from class: RestRequest
  
  Sets the URI host.
  
  Overrides:
  
  uriHost in class RestRequest
  
  Parameters:
  
  host - The new URI host.
  Can be null (host will be cleared).
  
  Returns:
  
  This object.
- uriPort
  
  public MockRestRequest uriPort(int port)
  
  Description copied from class: RestRequest
  
  Sets the URI port.
  
  Overrides:
  
  uriPort in class RestRequest
  
  Parameters:
  
  port - The new URI port.
  
  Returns:
  
  This object.
- uriScheme
  
  public MockRestRequest uriScheme(String value)
  
  Overrides the HTTP schema value on the underlying HttpServletRequest object.
  Affects the results of calling ServletRequest.getScheme().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Overrides:
  
  uriScheme in class RestRequest
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- uriUserInfo
  
  public MockRestRequest uriUserInfo(String userInfo)
  
  Description copied from class: RestRequest
  
  Sets the URI user info.
  
  Overrides:
  
  uriUserInfo in class RestRequest
  
  Parameters:
  
  userInfo - The new URI user info.
  Can be null (user info will be cleared).
  
  Returns:
  
  This object.
- uriUserInfo
  
  public MockRestRequest uriUserInfo(String username, String password)
  
  Description copied from class: RestRequest
  
  Sets the URI user info.
  
  Overrides:
  
  uriUserInfo in class RestRequest
  
  Parameters:
  
  username - The new URI username.
  Can be null.
  
  password - The new URI password.
  Can be null.
  
  Returns:
  
  This object.
- urlEnc
  
  public MockRestRequest urlEnc()
  
  Description copied from class: RestRequest
  Convenience method for specifying URL-Encoding as the marshalling transmission media type for this request only.
  UrlEncodingSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  This serializer is NOT used when using the RestRequest.formData(String, Object) (and related) methods for constructing the request body. Instead, the part serializer specified via RestClient.Builder.partSerializer(Class) is used.
  
  UrlEncodingParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "application/x-www-form-urlencoded" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "application/x-www-form-urlencoded" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(UrlEncodingSerializer.class).parser(UrlEncodingParser.class).
  Overrides:
  
  urlEnc in class RestRequest
  
  Returns:
  
  This object.
- userPrincipal
  
  public MockRestRequest userPrincipal(Principal value)
  
  Overrides the user principal on the underlying HttpServletRequest object.
  Affects the results of calling HttpServletRequest.getUserPrincipal().
  This value gets copied to the servlet request after the call to HttpClientConnection.sendRequestHeader(HttpRequest) and right before HttpClientConnection.sendRequestEntity(HttpEntityEnclosingRequest).
  
  Parameters:
  
  value - The new value for this setting.
  
  Returns:
  
  This object.
- xml
  
  public MockRestRequest xml()
  
  Description copied from class: RestRequest
  Convenience method for specifying XML as the marshalling transmission media type for this request only.
  XmlSerializer will be used to serialize POJOs to request bodies unless overridden per request via RestRequest.serializer(Serializer).
  
  The serializer can be configured using any of the serializer property setters (e.g. RestClient.Builder.sortCollections()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  XmlParser will be used to parse POJOs from response bodies unless overridden per request via RestRequest.parser(Parser).
  
  The parser can be configured using any of the parser property setters (e.g. RestClient.Builder.strict()) or bean context property setters (e.g. RestClient.Builder.swaps(Class...)) defined on this builder class.
  
  Accept request header will be set to "text/xml" unless overridden by RestRequest.header(String,Object) or RestRequest.accept(String).
  Content-Type request header will be set to "text/xml" unless overridden by RestRequest.header(String,Object) or RestRequest.contentType(String).
  Identical to calling serializer(XmlSerializer.class).parser(XmlParser.class).
  Overrides:
  
  xml in class RestRequest
  
  Returns:
  
  This object.

Class MockRestRequest

Notes:

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.BeanSession

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.rest.client.RestRequest

Methods inherited from class org.apache.juneau.BeanSession

Methods inherited from class org.apache.juneau.ContextSession

Methods inherited from class java.lang.Object

Constructor Details

MockRestRequest

Method Details

accept

acceptCharset

attribute

attributes

authType

cancellable

characterEncoding

config

content

content

contentString

contentType

context

contextPath

cookies

debug

dispatcherType

errorCodes

formData

Example:

formData

Example:

formDataBean

Example:

formDataCustom

Example:

formDataPairs

Example:

getAttributeMap

getAuthType

getCharacterEncoding

getContextPath

getCookies

getDispatcherType

getHttpSession

getLocalAddr

getLocale

getLocalName

getLocalPort

getPathInfo

getPathTranslated

getProtocol

getQueryString

getRemoteAddr

getRemoteHost

getRemotePort

getRemoteUser

getRequestDispatcherMap

getRequestedSessionId

getRequestURI

getRoles

getScheme

getServerName

getServerPort

getServletContext

getServletPath

getUserPrincipal

header

Example:

header

Example:

headerPairs

Example:

headers

Example:

headersBean