ResponseBuilder (PingAccess Addon SDK)

```
public interface ResponseBuilder
```
Builder used for creating Responses.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ResponseBuilder.Factory
A factory creating ResponseBuilder instances.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ResponseBuilder.Factory` A factory creating ResponseBuilder instances.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ResponseBuilder`	`badRequest()` Creates a `ResponseBuilder` with a "400 Bad Request" status.
`static ResponseBuilder`	`badRequestJson(String json)` Creates a `ResponseBuilder` with a "400 Bad Request" status, a Content-Type of "application/json;charset=utf-8", and the provided body content.
`ResponseBuilder`	`body(byte[] body)` Sets the `Response` body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
`default ResponseBuilder`	`body(String msg)` Sets the `Response` body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
`ResponseBuilder`	`body(String msg, Charset charset)` Sets the `Response` body with the provided message, encoding as bytes using the provided `Charset` and updating the Content-Length header appropriately.
`Response`	`build()` Creates the `Response`.
`ResponseBuilder`	`contentType(MediaType type)` Sets the Content-Type header field on the `Response`.
`ResponseBuilder`	`contentType(String type)` Sets the Content-Type header field on the `Response`.
`static ResponseBuilder`	`forbidden()` Creates a `ResponseBuilder` with a "403 Forbidden" status.
`static ResponseBuilder`	`found(String url)` Creates a `ResponseBuilder` with a "302 Found" status.
`ResponseBuilder`	`header(HeaderField headerField)` Adds a `HeaderField` to the `Headers` of the `Response`.
`ResponseBuilder`	`header(String headerName, String headerValue)` Adds a `HeaderField` to the `Response`.
`ResponseBuilder`	`headers(Headers headers)` Sets the `Headers` object for the `Response`.
`static ResponseBuilder`	`internalServerError()` Creates a `ResponseBuilder` with a "500 Internal Server Error" status.
`static ResponseBuilder`	`newInstance(HttpStatus status)` Creates a ResponseBuilder.
`static ResponseBuilder`	`notFound()` Creates a `ResponseBuilder` with a "404 Not Found" status and a Content Type of "text/html;charset=UTF-8".
`static ResponseBuilder`	`notFoundJson()` Creates a `ResponseBuilder` with a "404 Not Found" status and a content type of "application/json;charset=UTF-8".
`static ResponseBuilder`	`ok()` Creates a `ResponseBuilder` with a "200 OK" status.
`static ResponseBuilder`	`ok(String msg)` Creates a `ResponseBuilder` with a "200 OK" status, a Content-Type of "text/html;charset=UTF-8", and the provided string message as the `Response` body
`static ResponseBuilder`	`serviceUnavailable()` Creates a `ResponseBuilder` with a "503 Service Unavailable" status.
`static ResponseBuilder`	`unauthorized()` Creates a `ResponseBuilder` with a "401 Unauthorized" status.
`static ResponseBuilder`	`unprocessableEntity()` Creates a `ResponseBuilder` with a "422 Unprocessable Entity" status.

- Method Detail
  - build
```
Response build()
```
    Creates the Response. Each invocation will create a new Response instance.
    
    Returns:
    
    the created Response
  - body
```
ResponseBuilder body(String msg,
                     Charset charset)
```
    Sets the Response body with the provided message, encoding as bytes using the provided Charset and updating the Content-Length header appropriately.
    
    Parameters:
    
    msg - the body content
    
    charset - character set to use.
    
    Returns:
    
    this ResponseBuilder instance
  - body
```
default ResponseBuilder body(String msg)
```
    Sets the Response body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
    
    Parameters:
    
    msg - the body content
    
    Returns:
    
    this ResponseBuilder instance
  - body
```
ResponseBuilder body(byte[] body)
```
    Sets the Response body with the provided message using UTF-8 encoding and updating the Content-Length header appropriately.
    
    Parameters:
    
    body - the body content. The specified array will be copied and not stored by this object.
    
    Returns:
    
    this ResponseBuilder instance
  - headers
```
ResponseBuilder headers(Headers headers)
```
    Sets the Headers object for the Response.
    
    Parameters:
    
    headers - the Headers object. The specified Headers object will be copied and not stored by this object.
    
    Returns:
    
    this ResponseBuilder instance.
    
    Throws:
    
    IllegalArgumentException - if the provided Headers object was not created by the provided HeadersFactory. See ServiceFactory.headersFactory().
  - header
```
ResponseBuilder header(HeaderField headerField)
```
    Adds a HeaderField to the Headers of the Response.
    
    Parameters:
    
    headerField - the HeaderField. The specified HeaderField will be coped and not stored by this object.
    
    Returns:
    
    this ResponseBuilder instance
  - header
```
ResponseBuilder header(String headerName,
                       String headerValue)
```
    Adds a HeaderField to the Response.
    
    Parameters:
    
    headerName - the header name
    
    headerValue - the header value
    
    Returns:
    
    this ResponseBuilder instance
  - contentType
```
ResponseBuilder contentType(String type)
```
    Sets the Content-Type header field on the Response.
    
    Parameters:
    
    type - the ContentType to add.
    
    Returns:
    
    this ResponseBuilder instance
    
    See Also:
    
    Headers.setContentType(String)
  - contentType
```
ResponseBuilder contentType(MediaType type)
```
    Sets the Content-Type header field on the Response.
    
    Parameters:
    
    type - the ContentType to add.
    
    Returns:
    
    this ResponseBuilder instance
    
    See Also:
    
    Headers.setContentType(MediaType)
  - newInstance
```
static ResponseBuilder newInstance(HttpStatus status)
```
    Creates a ResponseBuilder. The Date header field is set to the current time from the system clock and the Content-Length header field is set to 0.
    
    Parameters:
    
    status - the HttpStatus for the Response
    
    Returns:
    
    a new ResponseBuilder
  - ok
```
static ResponseBuilder ok(String msg)
```
    Creates a ResponseBuilder with a "200 OK" status, a Content-Type of "text/html;charset=UTF-8", and the provided string message as the Response body
    
    Parameters:
    
    msg - the body content
    
    Returns:
    
    a new ResponseBuilder
  - ok
```
static ResponseBuilder ok()
```
    Creates a ResponseBuilder with a "200 OK" status.
    
    Returns:
    
    a new ResponseBuilder
  - unprocessableEntity
```
static ResponseBuilder unprocessableEntity()
```
    Creates a ResponseBuilder with a "422 Unprocessable Entity" status.
    
    Returns:
    
    a new ResponseBuilder
  - badRequest
```
static ResponseBuilder badRequest()
```
    Creates a ResponseBuilder with a "400 Bad Request" status.
    
    Returns:
    
    a new ResponseBuilder
  - badRequestJson
```
static ResponseBuilder badRequestJson(String json)
```
    Creates a ResponseBuilder with a "400 Bad Request" status, a Content-Type of "application/json;charset=utf-8", and the provided body content.
    
    Parameters:
    
    json - The JSON body content.
    
    Returns:
    
    a new ResponseBuilder
  - serviceUnavailable
```
static ResponseBuilder serviceUnavailable()
```
    Creates a ResponseBuilder with a "503 Service Unavailable" status.
    
    Returns:
    
    a new ResponseBuilder
  - internalServerError
```
static ResponseBuilder internalServerError()
```
    Creates a ResponseBuilder with a "500 Internal Server Error" status.
    
    Returns:
    
    a new ResponseBuilder
  - forbidden
```
static ResponseBuilder forbidden()
```
    Creates a ResponseBuilder with a "403 Forbidden" status.
    
    Returns:
    
    a new ResponseBuilder
  - found
```
static ResponseBuilder found(String url)
```
    Creates a ResponseBuilder with a "302 Found" status.
    
    Parameters:
    
    url - URL to redirect to.
    
    Returns:
    
    a new ResponseBuilder
  - notFound
```
static ResponseBuilder notFound()
```
    Creates a ResponseBuilder with a "404 Not Found" status and a Content Type of "text/html;charset=UTF-8".
    
    Returns:
    
    a new ResponseBuilder
  - notFoundJson
```
static ResponseBuilder notFoundJson()
```
    Creates a ResponseBuilder with a "404 Not Found" status and a content type of "application/json;charset=UTF-8". The body is set to the JSON content:
    { "msg" : "not found" }
    
    Returns:
    
    a new ResponseBuilder
  - unauthorized
```
static ResponseBuilder unauthorized()
```
    Creates a ResponseBuilder with a "401 Unauthorized" status.
    
    Returns:
    
    a new ResponseBuilder

Interface ResponseBuilder

Nested Class Summary

Method Summary

Method Detail

build

body

body

body

headers

header

header

contentType

contentType

newInstance

ok

ok

unprocessableEntity

badRequest

badRequestJson

serviceUnavailable

internalServerError

forbidden

found

notFound

notFoundJson

unauthorized