Class ClientRequest
- All Implemented Interfaces:
javax.ws.rs.client.ClientRequestContext
,InjectionManagerSupplier
-
Nested Class Summary
Nested classes/interfaces inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext
OutboundMessageContext.StreamProvider
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate javax.ws.rs.core.Response
private boolean
private final ClientConfig
private boolean
private String
private boolean
private static final Logger
private final PropertiesDelegate
private Iterable<javax.ws.rs.ext.ReaderInterceptor>
private URI
private MessageBodyWorkers
private Iterable<javax.ws.rs.ext.WriterInterceptor>
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ClientRequest
(URI requestUri, ClientConfig clientConfig, PropertiesDelegate propertiesDelegate) Create new Jersey client request context.ClientRequest
(ClientRequest original) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abortWith
(javax.ws.rs.core.Response response) void
Add new accepted types to the message headers.void
accept
(javax.ws.rs.core.MediaType... 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
(javax.ws.rs.core.CacheControl cacheControl) Add new cache control entry to the message headers.void
cookie
(javax.ws.rs.core.Cookie cookie) Add new cookie to the message headers.(package private) void
doWriteEntity
(MessageBodyWorkers writeWorkers, javax.ws.rs.core.GenericType<?> entityType) Added only to make the code testable.void
Enable a buffering of serialized entity.void
Set message encoding.private void
javax.ws.rs.core.Response
Get the request filter chain aborting response if set, ornull
otherwise.(package private) ClientConfig
Get internal client configuration state.(package private) ClientRuntime
Get the underlying client runtime.javax.ws.rs.core.Configuration
Get injection manager.private javax.ws.rs.core.MediaType
getMediaType
(List<javax.ws.rs.core.MediaType> mediaTypes) (package private) PropertiesDelegate
Get the underlying properties delegate.getProperty
(String name) Iterable<javax.ws.rs.ext.ReaderInterceptor>
Get reader interceptors of this request.getUri()
Get the message body workers associated with the request.Iterable<javax.ws.rs.ext.WriterInterceptor>
Get writer interceptors of this request.boolean
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
Returns true if the request is called asynchronously usingAsyncInvoker
void
Set message language.void
Set message language.void
removeProperty
(String name) <T> T
resolveProperty
(String name, Class<T> type) Resolve a property value for the specified propertyname
.private <T> T
resolveProperty
(String name, Object defaultValue, Class<T> type) <T> T
resolveProperty
(String name, T defaultValue) Resolve a property value for the specified propertyname
.(package private) void
setAsynchronous
(boolean async) Sets the flag indicating whether the request is called asynchronously usingAsyncInvoker
.void
void
setProperty
(String name, Object object) (package private) void
setReaderInterceptors
(Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors) Set reader interceptors for this request.void
void
setWorkers
(MessageBodyWorkers workers) Set the message body workers associated with the request.(package private) void
setWriterInterceptors
(Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors) Set writer interceptors for this request.void
Set message content type.void
type
(javax.ws.rs.core.MediaType type) Set message content type.void
variant
(javax.ws.rs.core.Variant variant) Set message content variant (type, language and encoding).void
Write (serialize) the entity set in this request into theentity stream
.Methods inherited from class org.glassfish.jersey.message.internal.OutboundMessageContext
close, commitStream, enableBuffering, getAcceptableLanguages, getAcceptableMediaTypes, getAllowedMethods, getDate, getEntity, getEntityAnnotations, getEntityClass, getEntityStream, getEntityTag, getEntityType, getHeaders, getHeaderString, getLanguage, getLastModified, getLength, getLengthLong, getLink, getLinkBuilder, getLinks, getLocation, getMediaType, getRequestCookies, getResponseCookies, getStringHeaders, hasEntity, hasLink, isCommitted, replaceHeaders, setEntity, setEntity, setEntity, setEntity, setEntityAnnotations, setEntityStream, setEntityType, setMediaType, setStreamProvider
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
-
Field Details
-
clientConfig
-
propertiesDelegate
-
requestUri
-
httpMethod
-
abortResponse
private javax.ws.rs.core.Response abortResponse -
workers
-
asynchronous
private boolean asynchronous -
entityWritten
private boolean entityWritten -
writerInterceptors
-
readerInterceptors
-
ignoreUserAgent
private boolean ignoreUserAgent -
LOGGER
-
-
Constructor Details
-
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
Copy constructor.- Parameters:
original
- original instance.
-
-
Method Details
-
resolveProperty
Resolve a property value for the specified propertyname
.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 client-runtime configuration
this request belongs to. If there is a value defined in the client-runtime configuration, it is returned, otherwise the method returnsnull
if no such property is registered neither in the client runtime nor in the request-specific property bag.- 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
Resolve a property value for the specified propertyname
.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 client-runtime configuration
this request belongs to. If there is a value defined in the client-runtime configuration, it is returned, otherwise the method returnsdefaultValue
if no such property is registered neither in the client runtime nor in the request-specific property bag.- 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.
-
resolveProperty
-
getProperty
- Specified by:
getProperty
in interfacejavax.ws.rs.client.ClientRequestContext
-
getPropertyNames
- Specified by:
getPropertyNames
in interfacejavax.ws.rs.client.ClientRequestContext
-
setProperty
- Specified by:
setProperty
in interfacejavax.ws.rs.client.ClientRequestContext
-
removeProperty
- Specified by:
removeProperty
in interfacejavax.ws.rs.client.ClientRequestContext
-
getPropertiesDelegate
PropertiesDelegate getPropertiesDelegate()Get the underlying properties delegate.- Returns:
- underlying properties delegate.
-
getClientRuntime
ClientRuntime getClientRuntime()Get the underlying client runtime.- Returns:
- underlying client runtime.
-
getUri
- Specified by:
getUri
in interfacejavax.ws.rs.client.ClientRequestContext
-
setUri
- Specified by:
setUri
in interfacejavax.ws.rs.client.ClientRequestContext
-
getMethod
- Specified by:
getMethod
in interfacejavax.ws.rs.client.ClientRequestContext
-
setMethod
- Specified by:
setMethod
in interfacejavax.ws.rs.client.ClientRequestContext
-
getClient
- Specified by:
getClient
in interfacejavax.ws.rs.client.ClientRequestContext
-
abortWith
public void abortWith(javax.ws.rs.core.Response response) - Specified by:
abortWith
in interfacejavax.ws.rs.client.ClientRequestContext
-
getAbortResponse
public javax.ws.rs.core.Response getAbortResponse()Get the request filter chain aborting response if set, ornull
otherwise.- Returns:
- request filter chain aborting response if set, or
null
otherwise.
-
getConfiguration
public javax.ws.rs.core.Configuration getConfiguration()- Specified by:
getConfiguration
in interfacejavax.ws.rs.client.ClientRequestContext
-
getClientConfig
ClientConfig getClientConfig()Get internal client configuration state.- Returns:
- internal client configuration state.
-
getCookies
- Specified by:
getCookies
in interfacejavax.ws.rs.client.ClientRequestContext
-
getWorkers
Get the message body workers associated with the request.- Returns:
- message body workers.
-
setWorkers
Set the message body workers associated with the request.- Parameters:
workers
- message body workers.
-
accept
public void accept(javax.ws.rs.core.MediaType... types) Add new accepted types to the message headers.- Parameters:
types
- accepted types to be added.
-
accept
Add new accepted types to the message headers.- Parameters:
types
- accepted types to be added.
-
acceptLanguage
Add new accepted languages to the message headers.- Parameters:
locales
- accepted languages to be added.
-
acceptLanguage
Add new accepted languages to the message headers.- Parameters:
locales
- accepted languages to be added.
-
cookie
public void cookie(javax.ws.rs.core.Cookie cookie) Add new cookie to the message headers.- Parameters:
cookie
- cookie to be added.
-
cacheControl
public void cacheControl(javax.ws.rs.core.CacheControl cacheControl) Add new cache control entry to the message headers.- Parameters:
cacheControl
- cache control entry to be added.
-
encoding
Set message encoding.- Parameters:
encoding
- message encoding to be set.
-
language
Set message language.- Parameters:
language
- message language to be set.
-
language
Set message language.- Parameters:
language
- message language to be set.
-
type
public void type(javax.ws.rs.core.MediaType type) Set message content type.- Parameters:
type
- message content type to be set.
-
type
Set message content type.- Parameters:
type
- message content type to be set.
-
variant
public void variant(javax.ws.rs.core.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 usingAsyncInvoker
- Returns:
- True if the request is asynchronous; false otherwise.
-
setAsynchronous
void setAsynchronous(boolean async) Sets the flag indicating whether the request is called asynchronously usingAsyncInvoker
.- Parameters:
async
- 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 isCommonProperties.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 theentity stream
. -
writeEntity
Write (serialize) the entity set in this request into theentity stream
. The method usewriter interceptors
andmessage 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 thatOutboundMessageContext.setStreamProvider(org.glassfish.jersey.message.internal.OutboundMessageContext.StreamProvider)
and optionallyenableBuffering()
must be called before calling this method.- Throws:
IOException
- In the case of IO error.
-
doWriteEntity
void doWriteEntity(MessageBodyWorkers writeWorkers, javax.ws.rs.core.GenericType<?> entityType) throws IOException Added only to make the code testable.- Parameters:
writeWorkers
- Message body workers instance used to write the entity.entityType
- entity type.- Throws:
IOException
- whenMessageBodyWorkers.writeTo(Object, Class, Type, Annotation[], MediaType, MultivaluedMap, PropertiesDelegate, OutputStream, Iterable)
throws anIOException
. This state is always regarded as connection failure.
-
ensureMediaType
private void ensureMediaType() -
getMediaType
-
setWriterInterceptors
Set writer interceptors for this request.- Parameters:
writerInterceptors
- Writer interceptors in the interceptor execution order.
-
getWriterInterceptors
Get writer interceptors of this request.- Returns:
- Writer interceptors in the interceptor execution order.
-
getReaderInterceptors
Get reader interceptors of this request.- Returns:
- Reader interceptors in the interceptor execution order.
-
setReaderInterceptors
Set reader interceptors for this request.- Parameters:
readerInterceptors
- Reader interceptors in the interceptor execution order.
-
getInjectionManager
Description copied from interface:InjectionManagerSupplier
Get injection manager.- Specified by:
getInjectionManager
in interfaceInjectionManagerSupplier
- 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.
-