Class MarshaledResponse

java.lang.Object

com.soklet.MarshaledResponse

@ThreadSafe
public final class MarshaledResponse
extends Object

A finalized representation of a Response, suitable for sending to clients over the wire.

Your application's ResponseMarshaler is responsible for taking the Response returned by a Resource Method as input and converting its Response.getBody() to a byte[].

For example, if a Response were to specify a body of List.of("one", "two"), a ResponseMarshaler might convert it to the JSON string ["one", "two"] and provide as output a corresponding MarshaledResponse with a body of UTF-8 bytes that represent ["one", "two"].

Alternatively, your Resource Method might want to directly serve bytes to clients (e.g. an image or PDF) and skip the ResponseMarshaler entirely. To accomplish this, just have your Resource Method return a MarshaledResponse instance: this tells Soklet "I already know exactly what bytes I want to send; don't go through the normal marshaling process".

Instances can be acquired via the withResponse(Response) or withStatusCode(Integer) builder factory methods.

Full documentation is available at https://www.soklet.com/docs/response-writing.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MarshaledResponse.Builder	Builder used to construct instances of MarshaledResponse via withResponse(Response) or withStatusCode(Integer).
static final class	MarshaledResponse.Copier	Builder used to copy instances of MarshaledResponse via copy().

Method Summary

Modifier and Type	Method	Description
MarshaledResponse.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
Optional<byte[]>	getBody()	The HTTP response body to write, if available.
Set<ResponseCookie>	getCookies()	The HTTP cookies to write for this response.
Map<String, Set<String>>	getHeaders()	The HTTP headers to write for this response.
Integer	getStatusCode()	The HTTP status code for this response.
String	toString()
static MarshaledResponse.Builder	withResponse(Response response)	Acquires a builder for MarshaledResponse instances.
static MarshaledResponse.Builder	withStatusCode(Integer statusCode)	Acquires a builder for MarshaledResponse instances.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

withResponse

@Nonnull
public static MarshaledResponse.Builder withResponse(@Nonnull
 Response response)

Acquires a builder for MarshaledResponse instances.

Parameters:

response - the logical response whose values are used to prime this builder

Returns:

the builder

withStatusCode

@Nonnull
public static MarshaledResponse.Builder withStatusCode(@Nonnull
 Integer statusCode)

Acquires a builder for MarshaledResponse instances.

Parameters:

statusCode - the HTTP status code for this response

Returns:

the builder

copy

@Nonnull
public MarshaledResponse.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance

toString

public String toString()

Overrides:

toString in class Object

getStatusCode

@Nonnull
public Integer getStatusCode()

The HTTP status code for this response.

Returns:

the status code

getHeaders

@Nonnull
public Map<String, Set<String>> getHeaders()

The HTTP headers to write for this response.

Returns:

the headers to write

getCookies

@Nonnull
public Set<ResponseCookie> getCookies()

The HTTP cookies to write for this response.

Returns:

the cookies to write

getBody

@Nonnull
public Optional<byte[]> getBody()

The HTTP response body to write, if available.

Returns:

the response body to write, or Optional.empty()) if no body should be written