Class AbstractBuiltResponse

  • All Implemented Interfaces:
    Direct Known Subclasses:

    public abstract class AbstractBuiltResponse
    A response object not attached to a client or server invocation.
    $Revision: 1 $
    Bill Burke
    • Field Detail

      • entity

        protected Object entity
      • status

        protected int status
      • reason

        protected String reason
      • entityClass

        protected Class entityClass
      • genericType

        protected Type genericType
      • isClosed

        protected volatile boolean isClosed
      • bufferedEntity

        protected byte[] bufferedEntity
      • streamRead

        protected volatile boolean streamRead
      • streamFullyRead

        protected volatile boolean streamFullyRead
    • Constructor Detail

      • AbstractBuiltResponse

        public AbstractBuiltResponse()
    • Method Detail

      • getInputStream

        protected abstract InputStream getInputStream()
      • setInputStream

        protected abstract void setInputStream​(InputStream is)
      • getEntityStream

        protected abstract InputStream getEntityStream()
      • releaseConnection

        public abstract void releaseConnection()
                                        throws IOException
        Release underlying connection but do not close.
        IOException - if I/O error occurred
      • releaseConnection

        public abstract void releaseConnection​(boolean consumeInputStream)
                                        throws IOException
        Release underlying connection but do not close.
        consumeInputStream - boolean to indicate either the underlying input stream must be fully read before releasing the connection or not.

        For most HTTP connection implementations, consuming the underlying input stream before releasing the connection will help to ensure connection reusability with respect of Keep-Alive policy.

        IOException - if I/O error occured
      • getEntityClass

        public Class getEntityClass()
      • setEntityClass

        public void setEntityClass​(Class entityClass)
      • getEntity

        public Object getEntity()
        Specified by:
        getEntity in class
      • getStatus

        public int getStatus()
        Specified by:
        getStatus in class
      • getReasonPhrase

        public String getReasonPhrase()
      • getStatusInfo

        public getStatusInfo()
        Specified by:
        getStatusInfo in class
      • getMetadata

        public<String,​Object> getMetadata()
        Specified by:
        getMetadata in class
      • setEntity

        public void setEntity​(Object entity)
      • setStatus

        public void setStatus​(int status)
      • setReasonPhrase

        public void setReasonPhrase​(String reason)
      • setMetadata

        public void setMetadata​(<String,​Object> metadata)
      • getAnnotations

        public Annotation[] getAnnotations()
      • addMethodAnnotations

        public void addMethodAnnotations​(Annotation[] methodAnnotations)
      • setAnnotations

        public void setAnnotations​(Annotation[] annotations)
      • getGenericType

        public Type getGenericType()
      • setGenericType

        public void setGenericType​(Type genericType)
      • readEntity

        public <T> T readEntity​(Class<T> type,
                                Annotation[] annotations)
        Specified by:
        readEntity in class
      • readEntity

        public <T> T readEntity​(<T> entityType,
                                Annotation[] annotations)
        Specified by:
        readEntity in class
      • readEntity

        public <T> T readEntity​(Class<T> type)
        Specified by:
        readEntity in class
      • readEntity

        public <T> T readEntity​(<T> entityType)
        Specified by:
        readEntity in class
      • readEntity

        public abstract <T> T readEntity​(Class<T> type,
                                         Type genericType,
                                         Annotation[] anns)
      • resetEntity

        protected void resetEntity()
      • setStreamRead

        public void setStreamRead​(Boolean b)
      • setStreamFullyRead

        public void setStreamFullyRead​(Boolean b)
      • hasEntity

        public boolean hasEntity()
        Specified by:
        hasEntity in class
      • isClosed

        public boolean isClosed()
        isClosed in class
      • abortIfClosed

        public void abortIfClosed()
      • close

        public void close()
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in class
      • getLanguage

        public Locale getLanguage()
        Specified by:
        getLanguage in class
      • getLength

        public int getLength()
        Specified by:
        getLength in class
      • getMediaType

        public getMediaType()
        Specified by:
        getMediaType in class
      • getCookies

        public Map<String,​> getCookies()
        Specified by:
        getCookies in class
      • getEntityTag

        public getEntityTag()
        Specified by:
        getEntityTag in class
      • getDate

        public Date getDate()
        Specified by:
        getDate in class
      • getLastModified

        public Date getLastModified()
        Specified by:
        getLastModified in class
      • getAllowedMethods

        public Set<String> getAllowedMethods()
        Specified by:
        getAllowedMethods in class
      • toHeaderString

        protected String toHeaderString​(Object header)
      • getStringHeaders

        public<String,​String> getStringHeaders()
        Specified by:
        getStringHeaders in class
      • getHeaderString

        public String getHeaderString​(String name)
        Specified by:
        getHeaderString in class
      • getLocation

        public URI getLocation()
        Specified by:
        getLocation in class
      • getLinks

        public Set<> getLinks()
        Specified by:
        getLinks in class
      • hasLink

        public boolean hasLink​(String relation)
        Specified by:
        hasLink in class
      • getLink

        public getLink​(String relation)
        Specified by:
        getLink in class
      • getLinkBuilder

        public getLinkBuilder​(String relation)
        Specified by:
        getLinkBuilder in class