Class ClientRequest

    • Field Detail

      • requestUri

        private java.net.URI requestUri
      • httpMethod

        private java.lang.String httpMethod
      • abortResponse

        private javax.ws.rs.core.Response abortResponse
      • asynchronous

        private boolean asynchronous
      • entityWritten

        private boolean entityWritten
      • writerInterceptors

        private java.lang.Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors
      • readerInterceptors

        private java.lang.Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors
      • ignoreUserAgent

        private boolean ignoreUserAgent
      • LOGGER

        private static final java.util.logging.Logger LOGGER
    • Constructor Detail

      • ClientRequest

        protected ClientRequest​(java.net.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​(java.lang.String name,
                                     java.lang.Class<T> type)
        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 client-runtime configuration this request belongs to. If there is a value defined in the client-runtime configuration, it is returned, otherwise the method returns null 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

        public <T> T resolveProperty​(java.lang.String name,
                                     T defaultValue)
        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 client-runtime configuration this request belongs to. If there is a value defined in the client-runtime configuration, it is returned, otherwise the method returns defaultValue 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

        private <T> T resolveProperty​(java.lang.String name,
                                      java.lang.Object defaultValue,
                                      java.lang.Class<T> type)
      • getProperty

        public java.lang.Object getProperty​(java.lang.String name)
        Specified by:
        getProperty in interface javax.ws.rs.client.ClientRequestContext
      • getPropertyNames

        public java.util.Collection<java.lang.String> getPropertyNames()
        Specified by:
        getPropertyNames in interface javax.ws.rs.client.ClientRequestContext
      • setProperty

        public void setProperty​(java.lang.String name,
                                java.lang.Object object)
        Specified by:
        setProperty in interface javax.ws.rs.client.ClientRequestContext
      • removeProperty

        public void removeProperty​(java.lang.String name)
        Specified by:
        removeProperty in interface javax.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

        public java.net.URI getUri()
        Specified by:
        getUri in interface javax.ws.rs.client.ClientRequestContext
      • setUri

        public void setUri​(java.net.URI uri)
        Specified by:
        setUri in interface javax.ws.rs.client.ClientRequestContext
      • getMethod

        public java.lang.String getMethod()
        Specified by:
        getMethod in interface javax.ws.rs.client.ClientRequestContext
      • setMethod

        public void setMethod​(java.lang.String method)
        Specified by:
        setMethod in interface javax.ws.rs.client.ClientRequestContext
      • getClient

        public JerseyClient getClient()
        Specified by:
        getClient in interface javax.ws.rs.client.ClientRequestContext
      • abortWith

        public void abortWith​(javax.ws.rs.core.Response response)
        Specified by:
        abortWith in interface javax.ws.rs.client.ClientRequestContext
      • getAbortResponse

        public javax.ws.rs.core.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 javax.ws.rs.core.Configuration getConfiguration()
        Specified by:
        getConfiguration in interface javax.ws.rs.client.ClientRequestContext
      • getClientConfig

        ClientConfig getClientConfig()
        Get internal client configuration state.
        Returns:
        internal client configuration state.
      • getCookies

        public java.util.Map<java.lang.String,​javax.ws.rs.core.Cookie> getCookies()
        Specified by:
        getCookies in interface javax.ws.rs.client.ClientRequestContext
      • 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​(javax.ws.rs.core.MediaType... types)
        Add new accepted types to the message headers.
        Parameters:
        types - accepted types to be added.
      • accept

        public void accept​(java.lang.String... types)
        Add new accepted types to the message headers.
        Parameters:
        types - accepted types to be added.
      • acceptLanguage

        public void acceptLanguage​(java.util.Locale... locales)
        Add new accepted languages to the message headers.
        Parameters:
        locales - accepted languages to be added.
      • acceptLanguage

        public void acceptLanguage​(java.lang.String... locales)
        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

        public void encoding​(java.lang.String encoding)
        Set message encoding.
        Parameters:
        encoding - message encoding to be set.
      • language

        public void language​(java.lang.String language)
        Set message language.
        Parameters:
        language - message language to be set.
      • language

        public void language​(java.util.Locale 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

        public void type​(java.lang.String 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 using AsyncInvoker
        Returns:
        True if the request is asynchronous; false otherwise.
      • setAsynchronous

        void setAsynchronous​(boolean async)
        Sets the flag indicating whether the request is called asynchronously using AsyncInvoker.
        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 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.

      • ensureMediaType

        private void ensureMediaType()
      • getMediaType

        private javax.ws.rs.core.MediaType getMediaType​(java.util.List<javax.ws.rs.core.MediaType> mediaTypes)
      • setWriterInterceptors

        void setWriterInterceptors​(java.lang.Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors)
        Set writer interceptors for this request.
        Parameters:
        writerInterceptors - Writer interceptors in the interceptor execution order.
      • getWriterInterceptors

        public java.lang.Iterable<javax.ws.rs.ext.WriterInterceptor> getWriterInterceptors()
        Get writer interceptors of this request.
        Returns:
        Writer interceptors in the interceptor execution order.
      • getReaderInterceptors

        public java.lang.Iterable<javax.ws.rs.ext.ReaderInterceptor> getReaderInterceptors()
        Get reader interceptors of this request.
        Returns:
        Reader interceptors in the interceptor execution order.
      • setReaderInterceptors

        void setReaderInterceptors​(java.lang.Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors)
        Set reader interceptors for this request.
        Parameters:
        readerInterceptors - Reader interceptors in the interceptor execution order.
      • 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.