.. java:import:: io.netty.handler.codec.http DefaultFullHttpResponse

.. java:import:: io.netty.handler.codec.http FullHttpResponse

.. java:import:: io.netty.handler.codec.http HttpVersion

.. java:import:: io.netty.handler.codec.http HttpResponseStatus

.. java:import:: io.netty.buffer ByteBuf

.. java:import:: io.netty.buffer Unpooled

.. java:import:: io.netty.util CharsetUtil

HttpResponse
============

.. java:package:: io.aalam.common
   :noindex:

.. java:type:: public class HttpResponse extends DefaultFullHttpResponse

Constructors
------------
HttpResponse
^^^^^^^^^^^^

.. java:constructor:: public HttpResponse(HttpRequest req, HttpVersion version, HttpResponseStatus status, ByteBuf buf)
   :outertype: HttpResponse

   Initialize a new response object

   :param req: The HttpRequest object
   :param version: The HTTP version
   :param status: The status code and string for the response
   :param buf: The response data

   **See also:** :java:ref:`HttpResponseStatus`

HttpResponse
^^^^^^^^^^^^

.. java:constructor:: public HttpResponse(HttpRequest req, HttpVersion version, HttpResponseStatus status)
   :outertype: HttpResponse

   Initialize a new response object that has no data

   :param req: The HttpRequest object
   :param version: The HTTP version
   :param status: The status code and string for the response

   **See also:** :java:ref:`HttpResponseStatus`

Methods
-------
forbidden
^^^^^^^^^

.. java:method:: public static HttpResponse forbidden()
   :outertype: HttpResponse

   Returns a pre initialized response object with status code "403"

getHttpRequest
^^^^^^^^^^^^^^

.. java:method:: public HttpRequest getHttpRequest()
   :outertype: HttpResponse

   Get the request object for this response object.

   :return: HttpRequest object

   **See also:** :java:ref:`HttpRequest`

internalServerError
^^^^^^^^^^^^^^^^^^^

.. java:method:: public static HttpResponse internalServerError()
   :outertype: HttpResponse

   Returns a pre initialized response object with status code "500"

notFound
^^^^^^^^

.. java:method:: public static HttpResponse notFound()
   :outertype: HttpResponse

   Returns a pre initialized response object with status code "404"

setContent
^^^^^^^^^^

.. java:method:: public void setContent(byte[] data)
   :outertype: HttpResponse

   Set the data be sent in the response.

   :param data: The actual data to be sent.

setContent
^^^^^^^^^^

.. java:method:: public void setContent(ByteBuf data)
   :outertype: HttpResponse

setContentType
^^^^^^^^^^^^^^

.. java:method:: public void setContentType(String mimeType)
   :outertype: HttpResponse

   Set the content type of the response data

   :param mimeType: The mime for the response content

setHttpRequest
^^^^^^^^^^^^^^

.. java:method:: public void setHttpRequest(HttpRequest req)
   :outertype: HttpResponse

   Sets the request object for which this response is being sent

statusCode
^^^^^^^^^^

.. java:method:: public int statusCode()
   :outertype: HttpResponse

   Get the status code set on this response object

   :return: integer status code

unAuthorized
^^^^^^^^^^^^

.. java:method:: public static HttpResponse unAuthorized()
   :outertype: HttpResponse

   Returns a pre initialized response object with status code "401"