org.glassfish.jersey.client

Class ClientRequest

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, 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 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

Fields inherited from interface javax.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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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(Locale... locales) Add new accepted languages to the message headers.
void	acceptLanguage(String... 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() The related client/server side Configuration.
Map<String,Cookie>	getCookies()
InjectionManager	getInjectionManager() Get injection manager.
String	getMethod()
Object	getProperty(String name)
Collection<String>	getPropertyNames()
Iterable<ReaderInterceptor>	getReaderInterceptors() Get reader interceptors of this request.
List<String>	getRequestHeader(String name)
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	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(Locale language) Set message language.
void	language(String language) Set message language.
void	removeProperty(String name)
<T> T	resolveProperty(String name, Class<T> type) Resolve a property value for the specified property name.
<T> T	resolveProperty(String name, T defaultValue) Resolve a property value for the specified property name.
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 javax.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 javax.ws.rs.core.HttpHeaders

getAcceptableLanguages, getAcceptableMediaTypes, getDate, getHeaderString, getLanguage, getLength, getMediaType

Methods inherited from interface org.glassfish.jersey.internal.PropertiesResolver

create

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)

Description copied from interface: PropertiesResolver

Resolve a property value for the specified property name.

The method returns the value of the property registered in the request-specific property bag, if available. If no property for the given property name is found in the request-specific property bag, the method looks at the properties stored in the global runtime configuration this request belongs to. If there is a value defined in the runtime configuration, it is returned, otherwise the method returns null if no such property is registered neither in the runtime nor in the request-specific property bag.

Specified by:

resolveProperty in interface PropertiesResolver

Type Parameters:

T - property Java type.

Parameters:

name - property name.

type - expected property class type.

Returns:

resolved property value or null if no such property is registered.

resolveProperty

public <T> T resolveProperty(String name,
                             T defaultValue)

Description copied from interface: PropertiesResolver

Resolve a property value for the specified property name.

The method returns the value of the property registered in the request-specific property bag, if available. If no property for the given property name is found in the request-specific property bag, the method looks at the properties stored in the global runtime configuration this request belongs to. If there is a value defined in the runtime configuration, it is returned, otherwise the method returns defaultValue if no such property is registered neither in the runtime nor in the request-specific property bag.

Specified by:

resolveProperty in interface PropertiesResolver

Type Parameters:

T - property Java type.

Parameters:

name - property name.

defaultValue - default value to return if the property is not registered.

Returns:

resolved property value or defaultValue if no such property is registered.

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()

Description copied from class: OutboundMessageContext

The related client/server side Configuration. Can be null.

Specified by:

getConfiguration in interface ClientRequestContext

Overrides:

getConfiguration in class OutboundMessageContext

Returns:

Configuration the configuration

getRequestHeader

public List<String> getRequestHeader(String name)

Specified by:

getRequestHeader in interface HttpHeaders

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()

Description copied from interface: InjectionManagerSupplier

Get injection manager.

Specified by:

getInjectionManager in interface InjectionManagerSupplier

Returns:

injection manager.

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