Uses of Class
org.apache.juneau.rest.client.RestRequest
Packages that use RestRequest
Package
Description
REST Client API
REST Server Mock API
-
Uses of RestRequest in org.apache.juneau.rest.client
Methods in org.apache.juneau.rest.client that return RestRequestModifier and TypeMethodDescriptionSets the value for theAccept request header.RestRequest.acceptCharset
(String value) Sets the value for theAccept-Charset request header.Performs a REST call where the entire call is specified in a simple string.RestRequest.cancellable
(Cancellable cancellable) SetsCancellable
for the ongoing operation.RestRequest.completed()
Deprecated.RestRequest.config
(RequestConfig value) Sets the actual request configuration.Sets the body of this request.RestRequest.content
(Object input, HttpPartSchema schema) Sets the body of this request.RestRequest.contentString
(Object input) Sets the body of this request as straight text bypassing the serializer.RestRequest.contentType
(String value) Sets the value for theContent-Type request header.RestRequest.context
(HttpContext context) Override the context to use for the execution.protected RestRequest
RestClient.createRequest
(URI uri, String method, boolean hasBody) Creates aRestRequest
object from the specifiedHttpRequest
object.RestRequest.debug()
SetsDebug: value header on this request.Perform aDELETE request against the specified URI.RestRequest.errorCodes
(Predicate<Integer> value) Allows you to override what status codes are considered error codes that would result in aRestCallException
.Adds a form-data parameter to the request body.RestRequest.formData
(NameValuePair... parts) Appends multiple form-data parameters to the request.RestRequest.formDataBean
(Object value) Appends multiple form-data parameters to the request from properties defined on a Java bean.RestRequest.formDataCustom
(Object value) Adds form-data parameters as the entire body of the request.RestRequest.formDataPairs
(String... pairs) Adds form-data parameters to the request body using free-form key/value pairs.Same asRestClient.formPost(Object, Object)
but doesn't specify the input yet.Perform aPOST request with a content type ofapplication/x-www-form-urlencoded against the specified URI.RestClient.formPostPairs
(Object uri, String... parameters) Perform aPOST request with a content type ofapplication/x-www-form-urlencoded against the specified URI.RestClient.get()
Perform aGET request against the root URI.Perform aGET request against the specified URI.RestResponse.getRequest()
Returns the request object that created this response object.RestRequestCreated.getRestRequest()
Returns theRestRequest
object that created theHttpRequest
.Perform aHEAD request against the specified URI.Appends a header to the request.Appends a header to the request.RestRequest.headerPairs
(String... pairs) Appends multiple headers to the request using freeform key/value pairs.Appends multiple headers to the request.RestRequest.headersBean
(Object value) Appends multiple headers to the request from properties defined on a Java bean.RestRequest.html()
Convenience method for specifying HTML as the marshalling transmission media type for this request only.RestRequest.htmlDoc()
Convenience method for specifying HTML DOC as the marshalling transmission media type for this request only.RestRequest.htmlStrippedDoc()
Convenience method for specifying Stripped HTML DOC as the marshalling transmission media type for this request only.RestRequest.ignoreErrors()
PreventRestCallExceptions
from being thrown when HTTP status 400+ is encountered.RestRequest.interceptors
(RestCallInterceptor... interceptors) Add one or more interceptors for this call only.RestRequest.json()
Convenience method for specifying JSON as the marshalling transmission media type for this request only.RestRequest.json5()
Convenience method for specifying Simplified JSON as the marshalling transmission media type for this request only.Logs a message.Logs a message.Shortcut for setting theAccept andContent-Type headers on a request.RestRequest.msgPack()
Convenience method for specifying MessagePack as the marshalling transmission media type for this request only.RestRequest.noTrace()
When called,No-Trace: true is added to requests.RestRequest.openApi()
Convenience method for specifying OpenAPI as the marshalling transmission media type for this request only.Perform anOPTIONS request against the specified URI.Specifies the parser to use on the response body.Specifies the parser to use on the response body.Same asRestClient.patch(Object, Object)
but don't specify the input yet.Perform aPATCH request against the specified URI.RestClient.patch
(Object uri, String body, ContentType contentType) Perform aPATCH request against the specified URI as a plain text body bypassing the serializer.Sets or replaces a path parameter of the form"{name}" in the URI.RestRequest.pathData
(NameValuePair... parts) Sets or replaces multiple path parameters on the request.RestRequest.pathDataBean
(Object value) Sets multiple path parameters to the request from properties defined on a Java bean.RestRequest.pathDataPairs
(String... pairs) Replaces path parameters of the form"{name}" in the URI using free-form key/value pairs.RestRequest.plainText()
Convenience method for specifying Plain Text as the marshalling transmission media type for this request only.Same asRestClient.post(Object, Object)
but don't specify the input yet.Perform aPOST request against the specified URI.RestClient.post
(Object uri, String body, ContentType contentType) Perform aPOST request against the specified URI as a plain text body bypassing the serializer.RestRequest.protocolVersion
(ProtocolVersion version) Sets the protocol version for this request.Same asRestClient.put(Object, Object)
but don't specify the input yet.Perform aPUT request against the specified URI.RestClient.put
(Object uri, String body, ContentType contentType) Perform aPUT request against the specified URI using a plain text body bypassing the serializer.RestRequest.queryCustom
(Object value) Adds a free-form custom query.Appends a query parameter to the URI of the request.RestRequest.queryData
(NameValuePair... parts) Appends multiple query parameters to the request.RestRequest.queryDataBean
(Object value) Appends multiple query parameters to the request from properties defined on a Java bean.RestRequest.queryDataPairs
(String... pairs) Adds query parameters to the URI query using free-form key/value pairs..Perform a generic REST call.Perform a generic REST call.Perform a generic REST call.protected RestRequest
RestClient.request
(RestOperation op) Perform an arbitrary request against the specified URI.Rethrow any of the specified exception types if a matchingException-Name header is found.RestRequest.serializer
(Class<? extends Serializer> serializer) Specifies the serializer to use on the request body.RestRequest.serializer
(Serializer serializer) Specifies the serializer to use on the request body.RestRequest.suppressLogging()
Causes logging to be suppressed for the duration of this request.Specifies the target host for the request.RestRequest.uon()
Convenience method for specifying UON as the marshalling transmission media type for this request only.Sets the URI for this request.RestRequest.uriFragment
(String fragment) Sets the URI fragment.Sets the URI host.RestRequest.uriPort
(int port) Sets the URI port.Sets the URI scheme.RestRequest.uriUserInfo
(String userInfo) Sets the URI user info.RestRequest.uriUserInfo
(String username, String password) Sets the URI user info.RestRequest.urlEnc()
Convenience method for specifying URL-Encoding as the marshalling transmission media type for this request only.RestRequest.xml()
Convenience method for specifying XML as the marshalling transmission media type for this request only.Methods in org.apache.juneau.rest.client with parameters of type RestRequestModifier and TypeMethodDescriptionprotected RestResponse
RestClient.createResponse
(RestRequest request, HttpResponse httpResponse, Parser parser) Creates aRestResponse
object from the specifiedHttpResponse
object.protected void
RestClient.onCallClose
(RestRequest req, RestResponse res) Interceptor method called immediately after the RestRequest object is created and all headers/query/form-data has been set on the request from the client.protected void
RestClient.onCallConnect
(RestRequest req, RestResponse res) Interceptor method called immediately after an HTTP response has been received.protected void
RestClient.onCallInit
(RestRequest req) Interceptor method called immediately after the RestRequest object is created and all headers/query/form-data has been copied from the client.void
BasicRestCallInterceptor.onClose
(RestRequest req, RestResponse res) void
RestCallInterceptor.onClose
(RestRequest req, RestResponse res) Called when the response body is consumed.void
BasicRestCallInterceptor.onConnect
(RestRequest req, RestResponse res) void
RestCallInterceptor.onConnect
(RestRequest req, RestResponse res) Called immediately after an HTTP response has been received.void
BasicRestCallInterceptor.onInit
(RestRequest req) void
RestCallInterceptor.onInit
(RestRequest req) Called immediately afterRestRequest
object is created and all headers/query/form-data has been copied from the client to the request object.Method parameters in org.apache.juneau.rest.client with type arguments of type RestRequestModifier and TypeMethodDescriptionRestClient.Builder.logRequests
(DetailLevel detail, Level level, BiPredicate<RestRequest, RestResponse> test) Log requests.Constructors in org.apache.juneau.rest.client with parameters of type RestRequestModifierConstructorDescriptionResponseContent
(RestClient client, RestRequest request, RestResponse response, Parser parser) Constructor.ResponseHeader
(String name, RestRequest request, RestResponse response, Header header) Constructor.protected
RestResponse
(RestClient client, RestRequest request, HttpResponse response, Parser parser) Constructor. -
Uses of RestRequest in org.apache.juneau.rest.mock
Subclasses of RestRequest in org.apache.juneau.rest.mockModifier and TypeClassDescriptionclass
A subclass ofRestRequest
with additional features for mocked testing.Methods in org.apache.juneau.rest.mock with parameters of type RestRequestModifier and TypeMethodDescriptionprotected MockRestResponse
MockRestClient.createResponse
(RestRequest req, HttpResponse httpResponse, Parser parser) Method parameters in org.apache.juneau.rest.mock with type arguments of type RestRequestModifier and TypeMethodDescriptionMockRestClient.Builder.logRequests
(DetailLevel detail, Level level, BiPredicate<RestRequest, RestResponse> test) Constructors in org.apache.juneau.rest.mock with parameters of type RestRequestModifierConstructorDescriptionMockRestResponse
(RestClient client, RestRequest request, HttpResponse response, Parser parser) Constructor.