Package org.glassfish.jersey.server

Class ContainerResponse

  • All Implemented Interfaces:
    javax.ws.rs.container.ContainerResponseContext
    public class ContainerResponse
extends java.lang.Object
implements javax.ws.rs.container.ContainerResponseContext
    Jersey container response context.

    • Field Detail

      • status

        private javax.ws.rs.core.Response.StatusType status

      • mappedFromException

        private boolean mappedFromException

      • closed

        private boolean closed

    • Constructor Detail

      • ContainerResponse

        public ContainerResponse​(ContainerRequest requestContext,
                         javax.ws.rs.core.Response response)
        Create a new Jersey container response context.
        Parameters:
        requestContext - associated container request context.
        response - response instance initializing the response context.

      • ContainerResponse

        ContainerResponse​(ContainerRequest requestContext,
                  OutboundJaxrsResponse response)
        Create a new Jersey container response context.
        Parameters:
        requestContext - associated container request context.
        response - response instance initializing the response context.

    • Method Detail

      • isMappedFromException

        public boolean isMappedFromException()
        Returns true if the response is result of the exception (for example created during exception mapping).
        Returns:
        True if this response was created based on the exception, false otherwise.

      • setMappedFromException

        public void setMappedFromException​(boolean mappedFromException)
        Sets the flag indicating whether the response was created based on the exception.
        Parameters:
        mappedFromException - True if this exception if result of the exception (for example result of exception mapping).

      • getStatus

        public int getStatus()
        Specified by:
        getStatus in interface javax.ws.rs.container.ContainerResponseContext

      • setStatus

        public void setStatus​(int code)
        Specified by:
        setStatus in interface javax.ws.rs.container.ContainerResponseContext

      • setStatusInfo

        public void setStatusInfo​(javax.ws.rs.core.Response.StatusType status)
        Specified by:
        setStatusInfo in interface javax.ws.rs.container.ContainerResponseContext

      • getStatusInfo

        public javax.ws.rs.core.Response.StatusType getStatusInfo()
        Specified by:
        getStatusInfo in interface javax.ws.rs.container.ContainerResponseContext

      • getRequestContext

        public ContainerRequest getRequestContext()
        Get the associated container request context paired with this response context.
        Returns:
        associated container request context.

      • getCookies

        public java.util.Map<java.lang.String,​javax.ws.rs.core.NewCookie> getCookies()
        Specified by:
        getCookies in interface javax.ws.rs.container.ContainerResponseContext

      • getWrappedMessageContext

        public OutboundMessageContext getWrappedMessageContext()
        Get the wrapped response message context.
        Returns:
        wrapped response message context.

      • getHeaderString

        public java.lang.String getHeaderString​(java.lang.String name)
        Specified by:
        getHeaderString in interface javax.ws.rs.container.ContainerResponseContext

      • getHeaders

        public javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.Object> getHeaders()
        Specified by:
        getHeaders in interface javax.ws.rs.container.ContainerResponseContext

      • getStringHeaders

        public javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> getStringHeaders()
        Specified by:
        getStringHeaders in interface javax.ws.rs.container.ContainerResponseContext

      • getDate

        public java.util.Date getDate()
        Specified by:
        getDate in interface javax.ws.rs.container.ContainerResponseContext

      • getLanguage

        public java.util.Locale getLanguage()
        Specified by:
        getLanguage in interface javax.ws.rs.container.ContainerResponseContext

      • getMediaType

        public javax.ws.rs.core.MediaType getMediaType()
        Specified by:
        getMediaType in interface javax.ws.rs.container.ContainerResponseContext

      • getAllowedMethods

        public java.util.Set<java.lang.String> getAllowedMethods()
        Specified by:
        getAllowedMethods in interface javax.ws.rs.container.ContainerResponseContext

      • getLength

        public int getLength()
        Specified by:
        getLength in interface javax.ws.rs.container.ContainerResponseContext

      • getEntityTag

        public javax.ws.rs.core.EntityTag getEntityTag()
        Specified by:
        getEntityTag in interface javax.ws.rs.container.ContainerResponseContext

      • getLastModified

        public java.util.Date getLastModified()
        Specified by:
        getLastModified in interface javax.ws.rs.container.ContainerResponseContext

      • getLocation

        public java.net.URI getLocation()
        Specified by:
        getLocation in interface javax.ws.rs.container.ContainerResponseContext

      • getLinks

        public java.util.Set<javax.ws.rs.core.Link> getLinks()
        Specified by:
        getLinks in interface javax.ws.rs.container.ContainerResponseContext

      • hasLink

        public boolean hasLink​(java.lang.String relation)
        Specified by:
        hasLink in interface javax.ws.rs.container.ContainerResponseContext

      • getLink

        public javax.ws.rs.core.Link getLink​(java.lang.String relation)
        Specified by:
        getLink in interface javax.ws.rs.container.ContainerResponseContext

      • getLinkBuilder

        public javax.ws.rs.core.Link.Builder getLinkBuilder​(java.lang.String relation)
        Specified by:
        getLinkBuilder in interface javax.ws.rs.container.ContainerResponseContext

      • hasEntity

        public boolean hasEntity()
        Specified by:
        hasEntity in interface javax.ws.rs.container.ContainerResponseContext

      • getEntity

        public java.lang.Object getEntity()
        Specified by:
        getEntity in interface javax.ws.rs.container.ContainerResponseContext

      • setEntity

        public void setEntity​(java.lang.Object entity)
        Set a new message message entity.
        Specified by:
        setEntity in interface javax.ws.rs.container.ContainerResponseContext
        Parameters:
        entity - entity object.
        See Also:
        MessageBodyWriter

      • setEntity

        public void setEntity​(java.lang.Object entity,
                      java.lang.annotation.Annotation[] annotations)
        Set a new message message entity.
        Parameters:
        entity - entity object.
        annotations - annotations attached to the entity.
        See Also:
        MessageBodyWriter

      • setEntity

        public void setEntity​(java.lang.Object entity,
                      java.lang.reflect.Type type,
                      java.lang.annotation.Annotation[] annotations)
        Set a new message message entity.
        Parameters:
        entity - entity object.
        type - declared entity class.
        annotations - annotations attached to the entity.
        See Also:
        MessageBodyWriter

      • setEntity

        public void setEntity​(java.lang.Object entity,
                      java.lang.annotation.Annotation[] annotations,
                      javax.ws.rs.core.MediaType mediaType)
        Specified by:
        setEntity in interface javax.ws.rs.container.ContainerResponseContext

      • setMediaType

        public void setMediaType​(javax.ws.rs.core.MediaType mediaType)
        Set the message content media type.
        Parameters:
        mediaType - message content media type.

      • getEntityClass

        public java.lang.Class<?> getEntityClass()
        Specified by:
        getEntityClass in interface javax.ws.rs.container.ContainerResponseContext

      • getEntityType

        public java.lang.reflect.Type getEntityType()
        Specified by:
        getEntityType in interface javax.ws.rs.container.ContainerResponseContext

      • setEntityType

        public void setEntityType​(java.lang.reflect.Type type)
        Set the message entity type information. This method overrides any computed or previously set entity type information.
        Parameters:
        type - overriding message entity type.

      • getEntityAnnotations

        public java.lang.annotation.Annotation[] getEntityAnnotations()
        Specified by:
        getEntityAnnotations in interface javax.ws.rs.container.ContainerResponseContext

      • setEntityAnnotations

        public void setEntityAnnotations​(java.lang.annotation.Annotation[] annotations)
        Set the annotations attached to the entity.
        Parameters:
        annotations - entity annotations.

      • getEntityStream

        public java.io.OutputStream getEntityStream()
        Specified by:
        getEntityStream in interface javax.ws.rs.container.ContainerResponseContext

      • setEntityStream

        public void setEntityStream​(java.io.OutputStream outputStream)
        Specified by:
        setEntityStream in interface javax.ws.rs.container.ContainerResponseContext

      • setStreamProvider

        public void setStreamProvider​(OutboundMessageContext.StreamProvider streamProvider)
        Set the output stream provider callback.

        This method must be called before first bytes are written to the entity stream.

        Parameters:
        streamProvider - non-null output stream provider.

      • enableBuffering

        public void enableBuffering​(javax.ws.rs.core.Configuration configuration)
        Enable a buffering of serialized entity. The buffering will be configured from configuration. 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.

        Parameters:
        configuration - runtime configuration.

      • commitStream

        public void commitStream()
                  throws java.io.IOException
        Commit the entity stream unless already committed.
        Throws:
        java.io.IOException - in case of the IO error.

      • isCommitted

        public boolean isCommitted()
        Returns true if the entity stream has been committed.
        Returns:
        true if the entity stream has been committed. Otherwise returns false.

      • close

        public void close()
        Closes the response. Flushes and closes the entity stream, frees up container resources associated with the corresponding request.

      • isChunked

        public boolean isChunked()
        Returns true if the response entity is a ChunkedOutput instance.
        Returns:
        true if the entity is a ChunkedOutput instance, false otherwise.