Class ResponseBuilder

java.lang.Object

com.djrapitops.plan.delivery.web.resolver.ResponseBuilder

public class ResponseBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponseBuilder.InvalidResponseException	Thrown when ResponseBuilder is missing some parameters.

Method Summary

Modifier and Type	Method	Description
Response	build()	Finish building.
ResponseBuilder	redirectTo(String url)	Utility method for building redirects.
protected ResponseBuilder	removeHeader(String header)
ResponseBuilder	setContent(byte[] bytes)
ResponseBuilder	setContent(WebResource resource)
ResponseBuilder	setContent(String utf8String)
ResponseBuilder	setContent(String content, Charset charset)
ResponseBuilder	setContent(CompletableFuture<byte[]> bytesFuture)
ResponseBuilder	setContent(CompletableFuture<String> stringFuture, Charset charset)
ResponseBuilder	setHeader(String header, Object value)	Set HTTP Response header.
ResponseBuilder	setJSONContent(Object objectToSerialize)	Set content as serialized JSON object.
ResponseBuilder	setJSONContent(String json)
ResponseBuilder	setJSONContent(CompletableFuture<String> jsonFuture)
ResponseBuilder	setMimeType(String mimeType)	Set MIME Type of the Response.
ResponseBuilder	setStatus(int code)	Set HTTP Status code.

Methods inherited from class Object

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

Method Details

setStatus

public ResponseBuilder setStatus(int code)

Set HTTP Status code.

Default status code is 200 (OK) if not set.

Parameters:

code - 1xx, 2xx, 3xx, 4xx, 5xx, Documentation

Returns:

this builder.

setHeader

public ResponseBuilder setHeader(String header,
 Object value)

Set HTTP Response header.

Parameters:

header - Key of the header. Documentation

value - Value for the header.

Returns:

this builder.

removeHeader

protected ResponseBuilder removeHeader(String header)

redirectTo

public ResponseBuilder redirectTo(String url)

Utility method for building redirects.

Parameters:

url - URL to redirect the client to with 302 Found.

Returns:

Documentation

setContent

public ResponseBuilder setContent(WebResource resource)

setContent

public ResponseBuilder setContent(byte[] bytes)

setContent

public ResponseBuilder setContent(CompletableFuture<byte[]> bytesFuture)

setContent

public ResponseBuilder setContent(String utf8String)

setContent

public ResponseBuilder setContent(String content,
 Charset charset)

setContent

public ResponseBuilder setContent(CompletableFuture<String> stringFuture,
 Charset charset)

setJSONContent

public ResponseBuilder setJSONContent(Object objectToSerialize)

Set content as serialized JSON object.

Parameters:

objectToSerialize - Object to serialize into JSON with Gson. If the object is a String it is assumed to be valid JSON.

Returns:

this builder.

setJSONContent

public ResponseBuilder setJSONContent(String json)

setJSONContent

public ResponseBuilder setJSONContent(CompletableFuture<String> jsonFuture)

build

public Response build()

Finish building.

Returns:

Response.

Throws:

ResponseBuilder.InvalidResponseException - if content was not defined (not even empty byte array).

ResponseBuilder.InvalidResponseException - if content has bytes, but MIME-type is not defined.

ResponseBuilder.InvalidResponseException - if status code is outside range 100-599.

See Also:

• to set MIME-type.

setMimeType

public ResponseBuilder setMimeType(String mimeType)

Set MIME Type of the Response.

Parameters:

mimeType - MIME type of the Response Documentation

Returns:

this builder.

See Also:

• for common MIME types.