Package org.attribyte.api.http

Class ResponseBuilder

java.lang.Object
org.attribyte.api.http.ResponseBuilder
public class ResponseBuilder extends Object
Builds immutable HTTP responses.

  • Constructor Details

    • ResponseBuilder

      public ResponseBuilder()
      Creates a response builder.

    • ResponseBuilder

      public ResponseBuilder(int statusCode)
      Creates a response builder with a response code.
      Parameters:
      statusCode - The response code.

    • ResponseBuilder

      public ResponseBuilder(int statusCode, byte[] body)
      Creates a response builder with a response code and body as bytes.
      Parameters:
      statusCode - The response code.
      body - The response body.

    • ResponseBuilder

      public ResponseBuilder(int statusCode, String body)
      Creates a response builder with a response code and body as a string.
      Parameters:
      statusCode - The response code.
      body - The response body.

    • ResponseBuilder

      public ResponseBuilder(int statusCode, com.google.common.io.ByteSource bodySource)
      Creates a response builder with a response code and body as a ByteSource.
      Parameters:
      statusCode - The response code.
      bodySource - The response body source.

  • Method Details

    • setStatusCode

      public ResponseBuilder setStatusCode(int statusCode)
      Sets the response code.
      Parameters:
      statusCode - The response code.
      Returns:
      A self-reference.

    • setBody

      public ResponseBuilder setBody(byte[] body)
      Sets the response body bytes.
      Parameters:
      body - The body.
      Returns:
      A self-reference.

    • setBody

      public ResponseBuilder setBody(String body)
      Sets the response body as a UTF-8 string.
      Parameters:
      body - The body.
      Returns:
      A self-reference.

    • setBody

      public ResponseBuilder setBody(com.google.common.io.ByteSource body)
      Sets a ByteSource for the response body.
      Parameters:
      body - The body byte source.
      Returns:
      A self-reference.

    • create

      public Response create()
      Creates an immutable response.
      Returns:
      The response.

    • createStreamed

      public StreamedResponse createStreamed()
      Creates an immutable streamed response.
      Returns:
      The response.

    • addHeader

      public ResponseBuilder addHeader(String name, String value)
      Adds a header.
      Parameters:
      name - The header name.
      value - The header value.
      Returns:
      A self-reference.

    • putHeaders

      public ResponseBuilder putHeaders(Collection<Header> headers)
      Adds a collection of headers.
      Parameters:
      headers - The headers to add.
      Returns:
      A self-reference.

    • addHeaders

      public ResponseBuilder addHeaders(Map<?,?> headerMap)
      Adds a map of headers.
      Parameters:
      headerMap - The map of headers.
      Returns:
      A self-reference.

    • addAttribute

      public ResponseBuilder addAttribute(String name, Object object)
      Adds an attribute.
      Parameters:
      name - The attribute name.
      object - The attribute value.
      Returns:
      A self-reference.

    • addAttributes

      public ResponseBuilder addAttributes(Map<String,Object> attributes)
      Adds a map of attributes.
      Parameters:
      attributes - The map of attributes.
      Returns:
      A self-reference.

    • setStats

      public ResponseBuilder setStats(Stats stats)
      Sets request/response stats.
      Parameters:
      stats - The stats.
      Returns:
      A self-reference.

    • setCookies

      public ResponseBuilder setCookies(Collection<Cookie> cookies)
      Sets cookies.
      Parameters:
      cookies - A collection of cookies.
      Returns:
      A self-reference.