Package com.aspectran.core.adapter

Class BasicResponseAdapter

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicResponseAdapter​(java.lang.Object adaptee)
      Instantiates a new Basic response adapter.
      BasicResponseAdapter​(java.lang.Object adaptee, java.io.Writer writer)
      Instantiates a new Basic response adapter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addHeader​(java.lang.String name, java.lang.String value)
      Add the given single header value to the current list of values for the given header.
      boolean containsHeader​(java.lang.String name)
      Returns a boolean indicating whether the named response header has already been set.
      void flush()
      Forces any content in the buffer to be written to the client.
      MultiValueMap<java.lang.String,​java.lang.String> getAllHeaders()
      Returns a map of the request headers that can be modified.
      java.lang.String getContentType()
      Returns the content type used for the MIME body sent in this response.
      java.lang.String getEncoding()
      Returns the name of the character encoding (MIME charset) used for the body sent in this response.
      java.lang.String getHeader​(java.lang.String name)
      Returns the value of the response header with the given name.
      java.util.Set<java.lang.String> getHeaderNames()
      Returns the names of the headers of this response.
      java.util.List<java.lang.String> getHeaders​(java.lang.String name)
      Returns the values of the response header with the given name.
      java.io.OutputStream getOutputStream()
      Returns a OutputStream suitable for writing binary data in the response.
      int getStatus()
      Returns the status code.
      java.io.Writer getWriter()
      Returns a Writer object that can send character text to the client.
      java.lang.String redirect​(RedirectRule redirectRule)
      Redirects a client to a new URL.
      void redirect​(java.lang.String path)
      Redirects a client to a new URL.
      void setContentType​(java.lang.String contentType)
      Sets the content type of the response being sent to the client, if the response has not been committed yet.
      void setEncoding​(java.lang.String encoding)
      Sets the character encoding of the response being sent to the client.
      void setHeader​(java.lang.String name, java.lang.String value)
      Set the given single header value under the given header name.
      protected void setOutputStream​(java.io.OutputStream outputStream)  
      void setStatus​(int status)
      Sets the status code.
      protected void setWriter​(java.io.Writer writer)  
      MultiValueMap<java.lang.String,​java.lang.String> touchHeaders()
      Returns a map of the response headers that can be modified.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BasicResponseAdapter

        public BasicResponseAdapter​(java.lang.Object adaptee)
        Instantiates a new Basic response adapter.
        Parameters:
        adaptee - the adaptee object

      • BasicResponseAdapter

        public BasicResponseAdapter​(java.lang.Object adaptee,
                            java.io.Writer writer)
        Instantiates a new Basic response adapter.
        Parameters:
        adaptee - the adaptee object
        writer - the writer to output

    • Method Detail

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Returns the value of the response header with the given name.

        If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

        Parameters:
        name - the name of the response header whose value to return
        Returns:
        the value of the response header with the given name, or null if no header with the given name has been set on this response

      • getHeaders

        public java.util.List<java.lang.String> getHeaders​(java.lang.String name)
        Returns the values of the response header with the given name.
        Parameters:
        name - the name of the response header whose values to return
        Returns:
        a (possibly empty) Collection of the values of the response header with the given name

      • getHeaderNames

        public java.util.Set<java.lang.String> getHeaderNames()
        Returns the names of the headers of this response.
        Returns:
        a (possibly empty) Collection of the names of the headers of this response

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Returns a boolean indicating whether the named response header has already been set.
        Parameters:
        name - the header name
        Returns:
        true if the named response header has already been set; false otherwise

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.lang.String value)
        Set the given single header value under the given header name.
        Parameters:
        name - the header name
        value - the header value to set

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
        Add the given single header value to the current list of values for the given header.
        Parameters:
        name - the header name
        value - the header value to be added

      • getAllHeaders

        public MultiValueMap<java.lang.String,​java.lang.String> getAllHeaders()
        Returns a map of the request headers that can be modified.
        Returns:
        an MultiValueMap object, may be null

      • touchHeaders

        public MultiValueMap<java.lang.String,​java.lang.String> touchHeaders()
        Returns a map of the response headers that can be modified. If not yet instantiated then create a new one.
        Returns:
        an MultiValueMap object, may not be null

      • getEncoding

        public java.lang.String getEncoding()
        Description copied from interface: ResponseAdapter
        Returns the name of the character encoding (MIME charset) used for the body sent in this response.
        Returns:
        a String specifying the name of the character encoding, for example, UTF-8

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Description copied from interface: ResponseAdapter
        Sets the character encoding of the response being sent to the client.
        Parameters:
        encoding - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: ResponseAdapter
        Returns the content type used for the MIME body sent in this response.
        Returns:
        a String specifying the content type, for example, text/html, or null

      • setContentType

        public void setContentType​(java.lang.String contentType)
        Description copied from interface: ResponseAdapter
        Sets the content type of the response being sent to the client, if the response has not been committed yet.
        Parameters:
        contentType - a String specifying the MIME type of the content

      • getOutputStream

        public java.io.OutputStream getOutputStream()
        Description copied from interface: ResponseAdapter
        Returns a OutputStream suitable for writing binary data in the response.
        Returns:
        a OutputStream for writing binary data

      • setOutputStream

        protected void setOutputStream​(java.io.OutputStream outputStream)

      • getWriter

        public java.io.Writer getWriter()
        Description copied from interface: ResponseAdapter
        Returns a Writer object that can send character text to the client.
        Returns:
        a Writer object that can return character data to the client

      • setWriter

        protected void setWriter​(java.io.Writer writer)

      • flush

        public void flush()
           throws java.io.IOException
        Description copied from interface: ResponseAdapter
        Forces any content in the buffer to be written to the client.
        Throws:
        java.io.IOException - if an input or output exception occurs

      • redirect

        public void redirect​(java.lang.String path)
        Description copied from interface: ResponseAdapter
        Redirects a client to a new URL.
        Parameters:
        path - the redirect path

      • redirect

        public java.lang.String redirect​(RedirectRule redirectRule)
        Description copied from interface: ResponseAdapter
        Redirects a client to a new URL.
        Parameters:
        redirectRule - the redirect rule
        Returns:
        the redirect path

      • getStatus

        public int getStatus()
        Returns the status code.
        Returns:
        the status

      • setStatus

        public void setStatus​(int status)
        Sets the status code.
        Parameters:
        status - the status code