java.lang.Object
- org.glassfish.jersey.message.internal.MessageHeaderMethods
- - org.glassfish.jersey.message.internal.OutboundMessageContext
  - - org.glassfish.jersey.client.ClientRequest

All Implemented Interfaces:

ClientRequestContext, HttpHeaders, HttpHeaders, InjectionManagerSupplier, PropertiesResolver
```
public class ClientRequest
extends OutboundMessageContext
implements ClientRequestContext, HttpHeaders, InjectionManagerSupplier, PropertiesResolver
```
Jersey client request context.

Author:

Marek Potociar

Nested Class Summary
- Nested classes/interfaces inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext
  OutboundMessageContext.StreamProvider

Field Summary
- Fields inherited from class org.glassfish.jersey.message.internal.MessageHeaderMethods
  runtimeDelegateDecorator
- Fields inherited from interface jakarta.ws.rs.core.HttpHeaders
  ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_ID, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPIRES, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_UNMODIFIED_SINCE, LAST_EVENT_ID_HEADER, LAST_MODIFIED, LOCATION, RETRY_AFTER, SET_COOKIE, USER_AGENT, VARY, WWW_AUTHENTICATE
- Fields inherited from interface org.glassfish.jersey.http.HttpHeaders
  ACCEPT_PATCH, ACCEPT_RANGES, AGE, CONNECTION, CONTENT_RANGE, EXPECT, FORWARDED, FROM, IF_RANGE, LINK, MAX_FORWARDS, MIME_VERSION, ORIGIN, PROXY_AUTHENTICATE, PROXY_AUTHENTICATION_INFO, PROXY_AUTHORIZATION, PROXY_CONNECTION, RANGE, REFERER, SERVER, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, VIA

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`ClientRequest(URI requestUri, ClientConfig clientConfig, PropertiesDelegate propertiesDelegate)`	Create new Jersey client request context.
	`ClientRequest(ClientRequest original)`	Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`abortWith(Response response)`
`void`	`accept(MediaType... types)`	Add new accepted types to the message headers.
`void`	`accept(String... types)`	Add new accepted types to the message headers.
`void`	`acceptLanguage(String... locales)`	Add new accepted languages to the message headers.
`void`	`acceptLanguage(Locale... locales)`	Add new accepted languages to the message headers.
`void`	`cacheControl(CacheControl cacheControl)`	Add new cache control entry to the message headers.
`void`	`cancel(boolean mayInterruptIfRunning)`	Cancels this `ClientRequest`.
`void`	`cookie(Cookie cookie)`	Add new cookie to the message headers.
`void`	`enableBuffering()`	Enable a buffering of serialized entity.
`void`	`encoding(String encoding)`	Set message encoding.
`Response`	`getAbortResponse()`	Get the request filter chain aborting response if set, or `null` otherwise.
`JerseyClient`	`getClient()`
`Configuration`	`getConfiguration()`
`Map<String,Cookie>`	`getCookies()`
`InjectionManager`	`getInjectionManager()`
`String`	`getMethod()`
`Object`	`getProperty(String name)`
`Collection<String>`	`getPropertyNames()`
`Iterable<ReaderInterceptor>`	`getReaderInterceptors()`	Get reader interceptors of this request.
`List<String>`	`getRequestHeader(String name)`	Get the values of an HTTP request header if the header exists on the current request.
`MultivaluedMap<String,String>`	`getRequestHeaders()`
`URI`	`getUri()`
`MessageBodyWorkers`	`getWorkers()`	Get the message body workers associated with the request.
`Iterable<WriterInterceptor>`	`getWriterInterceptors()`	Get writer interceptors of this request.
`boolean`	`hasProperty(String name)`
`boolean`	`ignoreUserAgent()`	Indicates whether the User-Agent header should be omitted if not directly set to the map of headers.
`void`	`ignoreUserAgent(boolean ignore)`	Indicates whether the User-Agent header should be omitted if not directly set to the map of headers.
`boolean`	`isAsynchronous()`	Returns true if the request is called asynchronously using `AsyncInvoker`
`boolean`	`isCancelled()`	Returns `true` if this `ClientRequest` was cancelled before it completed normally.
`void`	`language(String language)`	Set message language.
`void`	`language(Locale language)`	Set message language.
`void`	`removeProperty(String name)`
`<T> T`	`resolveProperty(String name, Class<T> type)`
`<T> T`	`resolveProperty(String name, T defaultValue)`
`void`	`setMethod(String method)`
`void`	`setProperty(String name, Object object)`
`void`	`setUri(URI uri)`
`void`	`setWorkers(MessageBodyWorkers workers)`	Set the message body workers associated with the request.
`void`	`type(MediaType type)`	Set message content type.
`void`	`type(String type)`	Set message content type.
`void`	`variant(Variant variant)`	Set message content variant (type, language and encoding).
`void`	`writeEntity()`	Write (serialize) the entity set in this request into the `entity stream`.

Methods inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext
close, commitStream, enableBuffering, getAcceptableLanguages, getAcceptableMediaTypes, getEntity, getEntityAnnotations, getEntityClass, getEntityStream, getEntityType, getHeaders, getHeaderString, getHeaderValueExceptionContext, getLinks, getMediaType, getStringHeaders, hasEntity, isCommitted, replaceHeaders, setEntity, setEntity, setEntity, setEntity, setEntityAnnotations, setEntityStream, setEntityType, setMediaType, setStreamProvider

Methods inherited from class org.glassfish.jersey.message.internal.MessageHeaderMethods
containsHeaderString, containsHeaderString, exception, getAllowedMethods, getDate, getEntityTag, getLanguage, getLastModified, getLength, getLengthLong, getLink, getLinkBuilder, getLocation, getRequestCookies, getResponseCookies, hasLink, singleHeader, singleHeader

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

Methods inherited from interface jakarta.ws.rs.client.ClientRequestContext
getAcceptableLanguages, getAcceptableMediaTypes, getDate, getEntity, getEntityAnnotations, getEntityClass, getEntityStream, getEntityType, getHeaders, getHeaderString, getLanguage, getMediaType, getStringHeaders, hasEntity, setEntity, setEntity, setEntityStream

Methods inherited from interface jakarta.ws.rs.core.HttpHeaders
getAcceptableLanguages, getAcceptableMediaTypes, getDate, getHeaderString, getLanguage, getLength, getMediaType

- Constructor Detail
  - ClientRequest
```
protected ClientRequest(URI requestUri,
                        ClientConfig clientConfig,
                        PropertiesDelegate propertiesDelegate)
```
    Create new Jersey client request context.
    
    Parameters:
    
    requestUri - request Uri.
    
    clientConfig - request configuration.
    
    propertiesDelegate - properties delegate.
  - ClientRequest
```
public ClientRequest(ClientRequest original)
```
    Copy constructor.
    
    Parameters:
    
    original - original instance.
- Method Detail
  - resolveProperty
```
public <T> T resolveProperty(String name,
                             Class<T> type)
```
    Specified by:
    
    resolveProperty in interface PropertiesResolver
  - resolveProperty
```
public <T> T resolveProperty(String name,
                             T defaultValue)
```
    Specified by:
    
    resolveProperty in interface PropertiesResolver
  - hasProperty
```
public boolean hasProperty(String name)
```
    Specified by:
    
    hasProperty in interface ClientRequestContext
  - getProperty
```
public Object getProperty(String name)
```
    Specified by:
    
    getProperty in interface ClientRequestContext
  - getPropertyNames
```
public Collection<String> getPropertyNames()
```
    Specified by:
    
    getPropertyNames in interface ClientRequestContext
  - setProperty
```
public void setProperty(String name,
                        Object object)
```
    Specified by:
    
    setProperty in interface ClientRequestContext
  - removeProperty
```
public void removeProperty(String name)
```
    Specified by:
    
    removeProperty in interface ClientRequestContext
  - getUri
```
public URI getUri()
```
    Specified by:
    
    getUri in interface ClientRequestContext
  - setUri
```
public void setUri(URI uri)
```
    Specified by:
    
    setUri in interface ClientRequestContext
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface ClientRequestContext
  - setMethod
```
public void setMethod(String method)
```
    Specified by:
    
    setMethod in interface ClientRequestContext
  - getClient
```
public JerseyClient getClient()
```
    Specified by:
    
    getClient in interface ClientRequestContext
  - abortWith
```
public void abortWith(Response response)
```
    Specified by:
    
    abortWith in interface ClientRequestContext
  - getAbortResponse
```
public Response getAbortResponse()
```
    Get the request filter chain aborting response if set, or null otherwise.
    
    Returns:
    
    request filter chain aborting response if set, or null otherwise.
  - getConfiguration
```
public Configuration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface ClientRequestContext
    
    Overrides:
    
    getConfiguration in class OutboundMessageContext
  - getRequestHeader
```
public List<String> getRequestHeader(String name)
```
    Get the values of an HTTP request header if the header exists on the current request. The returned value will be a read-only List if the specified header exists or null if it does not. This is a shortcut for getRequestHeaders().get(name).
    
    Specified by:
    
    getRequestHeader in interface HttpHeaders
    
    Parameters:
    
    name - the header name, case insensitive.
    
    Returns:
    
    a read-only list of header values if the specified header exists, otherwise null.
    
    Throws:
    
    IllegalStateException - if called outside the scope of a request.
  - getRequestHeaders
```
public MultivaluedMap<String,String> getRequestHeaders()
```
    Specified by:
    
    getRequestHeaders in interface HttpHeaders
  - getCookies
```
public Map<String,Cookie> getCookies()
```
    Specified by:
    
    getCookies in interface ClientRequestContext
    
    Specified by:
    
    getCookies in interface HttpHeaders
  - getWorkers
```
public MessageBodyWorkers getWorkers()
```
    Get the message body workers associated with the request.
    
    Returns:
    
    message body workers.
  - setWorkers
```
public void setWorkers(MessageBodyWorkers workers)
```
    Set the message body workers associated with the request.
    
    Parameters:
    
    workers - message body workers.
  - accept
```
public void accept(MediaType... types)
```
    Add new accepted types to the message headers.
    
    Parameters:
    
    types - accepted types to be added.
  - accept
```
public void accept(String... types)
```
    Add new accepted types to the message headers.
    
    Parameters:
    
    types - accepted types to be added.
  - acceptLanguage
```
public void acceptLanguage(Locale... locales)
```
    Add new accepted languages to the message headers.
    
    Parameters:
    
    locales - accepted languages to be added.
  - acceptLanguage
```
public void acceptLanguage(String... locales)
```
    Add new accepted languages to the message headers.
    
    Parameters:
    
    locales - accepted languages to be added.
  - cookie
```
public void cookie(Cookie cookie)
```
    Add new cookie to the message headers.
    
    Parameters:
    
    cookie - cookie to be added.
  - cacheControl
```
public void cacheControl(CacheControl cacheControl)
```
    Add new cache control entry to the message headers.
    
    Parameters:
    
    cacheControl - cache control entry to be added.
  - encoding
```
public void encoding(String encoding)
```
    Set message encoding.
    
    Parameters:
    
    encoding - message encoding to be set.
  - language
```
public void language(String language)
```
    Set message language.
    
    Parameters:
    
    language - message language to be set.
  - language
```
public void language(Locale language)
```
    Set message language.
    
    Parameters:
    
    language - message language to be set.
  - type
```
public void type(MediaType type)
```
    Set message content type.
    
    Parameters:
    
    type - message content type to be set.
  - type
```
public void type(String type)
```
    Set message content type.
    
    Parameters:
    
    type - message content type to be set.
  - variant
```
public void variant(Variant variant)
```
    Set message content variant (type, language and encoding).
    
    Parameters:
    
    variant - message content content variant (type, language and encoding) to be set.
  - isAsynchronous
```
public boolean isAsynchronous()
```
    Returns true if the request is called asynchronously using AsyncInvoker
    
    Returns:
    
    True if the request is asynchronous; false otherwise.
  - enableBuffering
```
public void enableBuffering()
```
    Enable a buffering of serialized entity. The buffering will be configured from runtime configuration associated with this request. The property determining the size of the buffer is CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER.
    The buffering functionality is by default disabled and could be enabled by calling this method. In this case this method must be called before first bytes are written to the entity stream.
  - writeEntity
```
public void writeEntity()
                 throws IOException
```
    Write (serialize) the entity set in this request into the entity stream. The method use writer interceptors and message body writer.
    This method modifies the state of this request and therefore it can be called only once per request life cycle otherwise IllegalStateException is thrown.
    Note that OutboundMessageContext.setStreamProvider(org.glassfish.jersey.message.internal.OutboundMessageContext.StreamProvider) and optionally enableBuffering() must be called before calling this method.
    
    Throws:
    
    IOException - In the case of IO error.
  - getWriterInterceptors
```
public Iterable<WriterInterceptor> getWriterInterceptors()
```
    Get writer interceptors of this request.
    
    Returns:
    
    Writer interceptors in the interceptor execution order.
  - getReaderInterceptors
```
public Iterable<ReaderInterceptor> getReaderInterceptors()
```
    Get reader interceptors of this request.
    
    Returns:
    
    Reader interceptors in the interceptor execution order.
  - getInjectionManager
```
public InjectionManager getInjectionManager()
```
    Specified by:
    
    getInjectionManager in interface InjectionManagerSupplier
  - ignoreUserAgent
```
public boolean ignoreUserAgent()
```
    Indicates whether the User-Agent header should be omitted if not directly set to the map of headers.
    
    Returns:
    
    true if the header should be omitted, false otherwise.
  - ignoreUserAgent
```
public void ignoreUserAgent(boolean ignore)
```
    Indicates whether the User-Agent header should be omitted if not directly set to the map of headers.
    
    Parameters:
    
    ignore - true if the header should be omitted, false otherwise.
  - cancel
```
public void cancel(boolean mayInterruptIfRunning)
```
    Cancels this ClientRequest. May result in CancellationException later in this request processing if this ClientRequest is backed by a Future provided to JerseyInvocation.Builder.setCancellable(Future).
    
    Parameters:
    
    mayInterruptIfRunning - may have no effect or true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete
  - isCancelled
```
public boolean isCancelled()
```
    Returns true if this ClientRequest was cancelled before it completed normally.
    
    Returns:
    
    true if this ClientRequest was cancelled before it completed normally

Class ClientRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext

Field Summary

Fields inherited from class org.glassfish.jersey.message.internal.MessageHeaderMethods

Fields inherited from interface jakarta.ws.rs.core.HttpHeaders

Fields inherited from interface org.glassfish.jersey.http.HttpHeaders

Constructor Summary

Method Summary

Methods inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext

Methods inherited from class org.glassfish.jersey.message.internal.MessageHeaderMethods

Methods inherited from class java.lang.Object

Methods inherited from interface jakarta.ws.rs.client.ClientRequestContext

Methods inherited from interface jakarta.ws.rs.core.HttpHeaders

Constructor Detail

ClientRequest

ClientRequest

Method Detail

resolveProperty

resolveProperty

hasProperty

getProperty

getPropertyNames

setProperty

removeProperty

getUri

setUri

getMethod

setMethod

getClient

abortWith

getAbortResponse

getConfiguration

getRequestHeader

getRequestHeaders

getCookies

getWorkers

setWorkers

accept

accept

acceptLanguage

acceptLanguage

cookie

cacheControl

encoding

language

language

type

type

variant

isAsynchronous

enableBuffering

writeEntity

getWriterInterceptors

getReaderInterceptors

getInjectionManager

ignoreUserAgent

ignoreUserAgent

cancel

isCancelled