Package org.glassfish.jersey.message.internal

Class InboundMessageContext

  • Direct Known Subclasses:
    ClientResponse, ContainerRequest
    public abstract class InboundMessageContext
extends java.lang.Object
    Base inbound message context implementation.

    • Field Detail

      • EMPTY

        private static final java.io.InputStream EMPTY

      • EMPTY_ANNOTATIONS

        private static final java.lang.annotation.Annotation[] EMPTY_ANNOTATIONS

      • WILDCARD_ACCEPTABLE_TYPE_SINGLETON_LIST

        private static final java.util.List<AcceptableMediaType> WILDCARD_ACCEPTABLE_TYPE_SINGLETON_LIST

      • headers

        private final javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> headers

      • translateNce

        private final boolean translateNce

    • Constructor Detail

      • InboundMessageContext

        public InboundMessageContext()
        Create new inbound message context.

      • InboundMessageContext

        public InboundMessageContext​(boolean translateNce)
        Create new inbound message context.
        Parameters:
        translateNce - if true, the NoContentException thrown by a selected message body reader will be translated into a BadRequestException as required by JAX-RS specification on the server side.

    • Method Detail

      • header

        public InboundMessageContext header​(java.lang.String name,
                                    java.lang.Object value)
        Add a new header value.
        Parameters:
        name - header name.
        value - header value.
        Returns:
        updated context.

      • headers

        public InboundMessageContext headers​(java.lang.String name,
                                     java.lang.Object... values)
        Add new header values.
        Parameters:
        name - header name.
        values - header values.
        Returns:
        updated context.

      • headers

        public InboundMessageContext headers​(java.lang.String name,
                                     java.lang.Iterable<?> values)
        Add new header values.
        Parameters:
        name - header name.
        values - header values.
        Returns:
        updated context.

      • headers

        public InboundMessageContext headers​(javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> newHeaders)
        Add new headers.
        Parameters:
        newHeaders - new headers.
        Returns:
        updated context.

      • headers

        public InboundMessageContext headers​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> newHeaders)
        Add new headers.
        Parameters:
        newHeaders - new headers.
        Returns:
        updated context.

      • remove

        public InboundMessageContext remove​(java.lang.String name)
        Remove a header.
        Parameters:
        name - header name.
        Returns:
        updated context.

      • iterableToList

        private static java.util.List<java.lang.String> iterableToList​(java.lang.Iterable<?> values)

      • getHeaderString

        public java.lang.String getHeaderString​(java.lang.String name)
        Get a message header as a single string value.

        Each single header value is converted to String using a RuntimeDelegate.HeaderDelegate if one is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available.

        Parameters:
        name - the message header.
        Returns:
        the message header value. If the message header is not present then null is returned. If the message header is present but has no value then the empty string is returned. If the message header is present more than once then the values of joined together and separated by a ',' character.

      • singleHeader

        private <T> T singleHeader​(java.lang.String name,
                           java.util.function.Function<java.lang.String,​T> converter,
                           boolean convertNull)
        Get a single typed header value.
        Parameters:
        name - header name.
        converter - from string conversion function. Is expected to throw ProcessingException if conversion fails.
        convertNull - if true this method calls the provided converter even for null. Otherwise this method returns the null without calling the converter.
        Returns:
        value of the header, or (possibly converted) null if not present.

      • exception

        private static HeaderValueException exception​(java.lang.String headerName,
                                              java.lang.Object headerValue,
                                              java.lang.Exception e)

      • getHeaders

        public javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> getHeaders()
        Get the mutable message headers multivalued map.
        Returns:
        mutable multivalued map of message headers.

      • getDate

        public java.util.Date getDate()
        Get message date.
        Returns:
        the message date, otherwise null if not present.

      • getIfMatch

        public java.util.Set<MatchingEntityTag> getIfMatch()
        Get If-Match header.
        Returns:
        the If-Match header value, otherwise null if not present.

      • getIfNoneMatch

        public java.util.Set<MatchingEntityTag> getIfNoneMatch()
        Get If-None-Match header.
        Returns:
        the If-None-Match header value, otherwise null if not present.

      • getLanguage

        public java.util.Locale getLanguage()
        Get the language of the entity.
        Returns:
        the language of the entity or null if not specified.

      • getLength

        public int getLength()
        Get Content-Length value.
        Returns:
        Content-Length as integer if present and valid number. In other cases returns -1.

      • getMediaType

        public javax.ws.rs.core.MediaType getMediaType()
        Get the media type of the entity.
        Returns:
        the media type or null if not specified (e.g. there's no message entity).

      • getQualifiedAcceptableMediaTypes

        public java.util.List<AcceptableMediaType> getQualifiedAcceptableMediaTypes()
        Get a list of media types that are acceptable for a request.
        Returns:
        a read-only list of requested response media types sorted according to their q-value, with highest preference first.

      • getQualifiedAcceptableLanguages

        public java.util.List<AcceptableLanguageTag> getQualifiedAcceptableLanguages()
        Get a list of languages that are acceptable for the message.
        Returns:
        a read-only list of acceptable languages sorted according to their q-value, with highest preference first.

      • getQualifiedAcceptCharset

        public java.util.List<AcceptableToken> getQualifiedAcceptCharset()
        Get the list of language tag from the "Accept-Charset" of an HTTP request.
        Returns:
        The list of AcceptableToken. This list is ordered with the highest quality acceptable charset occurring first.

      • getQualifiedAcceptEncoding

        public java.util.List<AcceptableToken> getQualifiedAcceptEncoding()
        Get the list of language tag from the "Accept-Charset" of an HTTP request.
        Returns:
        The list of AcceptableToken. This list is ordered with the highest quality acceptable charset occurring first.

      • getRequestCookies

        public java.util.Map<java.lang.String,​javax.ws.rs.core.Cookie> getRequestCookies()
        Get any cookies that accompanied the request.
        Returns:
        a read-only map of cookie name (String) to Cookie.

      • getAllowedMethods

        public java.util.Set<java.lang.String> getAllowedMethods()
        Get the allowed HTTP methods from the Allow HTTP header.
        Returns:
        the allowed HTTP methods, all methods will returned as upper case strings.

      • getResponseCookies

        public java.util.Map<java.lang.String,​javax.ws.rs.core.NewCookie> getResponseCookies()
        Get any new cookies set on the response message.
        Returns:
        a read-only map of cookie name (String) to a new cookie.

      • getEntityTag

        public javax.ws.rs.core.EntityTag getEntityTag()
        Get the entity tag.
        Returns:
        the entity tag, otherwise null if not present.

      • getLastModified

        public java.util.Date getLastModified()
        Get the last modified date.
        Returns:
        the last modified date, otherwise null if not present.

      • getLocation

        public java.net.URI getLocation()
        Get the location.
        Returns:
        the location URI, otherwise null if not present.

      • getLinks

        public java.util.Set<javax.ws.rs.core.Link> getLinks()
        Get the links attached to the message as header.
        Returns:
        links, may return empty Set if no links are present. Never returns null.

      • hasLink

        public boolean hasLink​(java.lang.String relation)
        Check if link for relation exists.
        Parameters:
        relation - link relation.
        Returns:
        true if the for the relation link exists, false otherwise.

      • getLink

        public javax.ws.rs.core.Link getLink​(java.lang.String relation)
        Get the link for the relation.
        Parameters:
        relation - link relation.
        Returns:
        the link for the relation, otherwise null if not present.

      • getLinkBuilder

        public javax.ws.rs.core.Link.Builder getLinkBuilder​(java.lang.String relation)
        Convenience method that returns a Link.Builder for the relation.
        Parameters:
        relation - link relation.
        Returns:
        the link builder for the relation, otherwise null if not present.

      • getWorkers

        public MessageBodyWorkers getWorkers()
        Get context message body workers.
        Returns:
        context message body workers.

      • setWorkers

        public void setWorkers​(MessageBodyWorkers workers)
        Set context message body workers.
        Parameters:
        workers - context message body workers.

      • hasEntity

        public boolean hasEntity()
        Check if there is a non-empty entity input stream is available in the message.

        The method returns true if the entity is present, returns false otherwise.

        Returns:
        true if there is an entity present in the message, false otherwise.

      • getEntityStream

        public java.io.InputStream getEntityStream()
        Get the entity input stream.
        Returns:
        entity input stream.

      • setEntityStream

        public void setEntityStream​(java.io.InputStream input)
        Set a new entity input stream.
        Parameters:
        input - new entity input stream.

      • readEntity

        public <T> T readEntity​(java.lang.Class<T> rawType,
                        PropertiesDelegate propertiesDelegate)
        Read entity from a context entity input stream.
        Type Parameters:
        T - entity Java object type.
        Parameters:
        rawType - raw Java entity type.
        propertiesDelegate - request-scoped properties delegate.
        Returns:
        entity read from a context entity input stream.

      • readEntity

        public <T> T readEntity​(java.lang.Class<T> rawType,
                        java.lang.annotation.Annotation[] annotations,
                        PropertiesDelegate propertiesDelegate)
        Read entity from a context entity input stream.
        Type Parameters:
        T - entity Java object type.
        Parameters:
        rawType - raw Java entity type.
        annotations - entity annotations.
        propertiesDelegate - request-scoped properties delegate.
        Returns:
        entity read from a context entity input stream.

      • readEntity

        public <T> T readEntity​(java.lang.Class<T> rawType,
                        java.lang.reflect.Type type,
                        PropertiesDelegate propertiesDelegate)
        Read entity from a context entity input stream.
        Type Parameters:
        T - entity Java object type.
        Parameters:
        rawType - raw Java entity type.
        type - generic Java entity type.
        propertiesDelegate - request-scoped properties delegate.
        Returns:
        entity read from a context entity input stream.

      • readEntity

        public <T> T readEntity​(java.lang.Class<T> rawType,
                        java.lang.reflect.Type type,
                        java.lang.annotation.Annotation[] annotations,
                        PropertiesDelegate propertiesDelegate)
        Read entity from a context entity input stream.
        Type Parameters:
        T - entity Java object type.
        Parameters:
        rawType - raw Java entity type.
        type - generic Java entity type.
        annotations - entity annotations.
        propertiesDelegate - request-scoped properties delegate.
        Returns:
        entity read from a context entity input stream.

      • bufferEntity

        public boolean bufferEntity()
                     throws javax.ws.rs.ProcessingException
        Buffer the entity stream (if not empty).
        Returns:
        true if the entity input stream was successfully buffered.
        Throws:
        javax.ws.rs.ProcessingException - in case of an IO error.

      • close

        public void close()
        Closes the underlying content stream.

      • getReaderInterceptors

        protected abstract java.lang.Iterable<javax.ws.rs.ext.ReaderInterceptor> getReaderInterceptors()
        Get reader interceptors bound to this context.

        Interceptors will be used when one of the readEntity methods is invoked.

        Returns:
        reader interceptors bound to this context.