Package com.aspectran.web.adapter

Class HttpServletResponseAdapter

java.lang.Object
com.aspectran.core.adapter.AbstractResponseAdapter
com.aspectran.web.adapter.HttpServletResponseAdapter
All Implemented Interfaces:
ResponseAdapter
public class HttpServletResponseAdapter extends AbstractResponseAdapter
Adapt HttpServletResponse to Core ResponseAdapter.
Since:
2011. 3. 13.

  • Field Details

  • Constructor Details

    • HttpServletResponseAdapter

      public HttpServletResponseAdapter(jakarta.servlet.http.HttpServletResponse response, Activity activity)
      Instantiates a new HttpServletResponseAdapter.
      Parameters:
      response - the HTTP response
      activity - the activity

  • Method Details

    • getHeader

      public String getHeader(String name)
      Description copied from interface: ResponseAdapter
      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 Collection<String> getHeaders(String name)
      Description copied from interface: ResponseAdapter
      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 Collection<String> getHeaderNames()
      Description copied from interface: ResponseAdapter
      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(String name)
      Description copied from interface: ResponseAdapter
      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(String name, String value)
      Description copied from interface: ResponseAdapter
      Set the given single header value under the given header name. If the header had already been set, the new value overwrites the previous one.
      Parameters:
      name - the header name
      value - the header value to set

    • addHeader

      public void addHeader(String name, String value)
      Description copied from interface: ResponseAdapter
      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

    • getEncoding

      public 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(String encoding) throws UnsupportedEncodingException
      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)
      Throws:
      UnsupportedEncodingException - if character encoding is not supported

    • getContentType

      public 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(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 OutputStream getOutputStream() throws IOException
      Description copied from interface: ResponseAdapter
      Returns a OutputStream suitable for writing binary data in the response.
      Returns:
      a OutputStream for writing binary data
      Throws:
      IOException - if an input or output exception occurs

    • getWriter

      public Writer getWriter() throws IOException
      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
      Throws:
      IOException - if an input or output exception occurs

    • flush

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

    • redirect

      public void redirect(String location) throws IOException
      Description copied from interface: ResponseAdapter
      Sends a temporary redirect response to the client using the specified redirect location.
      Parameters:
      location - the redirect location
      Throws:
      IOException - if an input or output exception occurs

    • redirect

      public String redirect(RedirectRule redirectRule) throws IOException
      Description copied from interface: ResponseAdapter
      Redirects a client to a new URL.
      Parameters:
      redirectRule - the redirect rule
      Returns:
      the redirect path
      Throws:
      IOException - if an input or output exception occurs

    • getStatus

      public int getStatus()
      Description copied from interface: ResponseAdapter
      Returns the status code.
      Returns:
      the status

    • setStatus

      public void setStatus(int status)
      Description copied from interface: ResponseAdapter
      Sets the status code.
      Parameters:
      status - the status code

    • makeRedirectPath

      @NonNull public static String makeRedirectPath(RedirectRule redirectRule, Activity activity) throws IOException
      Throws:
      IOException