Class Response

java.lang.Object

com.soklet.Response

@ThreadSafe
public final class Response
extends Object

Represents a logical HTTP response returned by a Resource Method.

Your application's ResponseMarshaler is responsible for taking the Response returned by a Resource Method as input and creating a finalized binary representation (MarshaledResponse), suitable for sending to clients over the wire.

Instances can be acquired via these builder factory methods:

• withStatusCode(Integer) (builder primed with status code)
• withRedirect(RedirectType, String) (builder primed with redirect info)

Convenience instance factories are also available via fromStatusCode(Integer) and fromRedirect(RedirectType, String).

For performance, header collections are shallow-copied and not defensively deep-copied. Treat returned collections as immutable.

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	Response.Builder	Builder used to construct instances of Response via withStatusCode(Integer) or withRedirect(RedirectType, String).
static final class	Response.Copier	Builder used to copy instances of Response via copy().

Method Summary

Modifier and Type	Method	Description
@NonNull Response.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(@Nullable Object object)
static @NonNull Response	fromRedirect(@NonNull RedirectType redirectType, @NonNull String location)	Creates a redirect Response with no additional customization.
static @NonNull Response	fromStatusCode(@NonNull Integer statusCode)	Creates a Response with the given status code and no additional customization.
@NonNull Optional<Object>	getBody()	The "logical" body content to be written to the response, if present.
@NonNull Set<@NonNull ResponseCookie>	getCookies()	The cookies to be written to the client for this response.
@NonNull Map<@NonNull String, @NonNull Set<@NonNull String>>	getHeaders()	The headers to be written to the client for this response.
@NonNull Integer	getStatusCode()	The HTTP status code to be written to the client for this response.
int	hashCode()
String	toString()
static @NonNull Response.Builder	withRedirect(@NonNull RedirectType redirectType, @NonNull String location)	Acquires a builder for Response instances that are intended to redirect the client.
static @NonNull Response.Builder	withStatusCode(@NonNull Integer statusCode)	Acquires a builder for Response instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withStatusCode

public static @NonNull Response.Builder withStatusCode(@NonNull Integer statusCode)

Acquires a builder for Response instances.

Parameters:

statusCode - the HTTP status code for this request (200, 201, etc.)

Returns:

the builder

fromStatusCode

public static @NonNull Response fromStatusCode(@NonNull Integer statusCode)

Creates a Response with the given status code and no additional customization.

Parameters:

statusCode - the HTTP status code for this request (200, 201, etc.)

Returns:

a Response instance

withRedirect

public static @NonNull Response.Builder withRedirect(@NonNull RedirectType redirectType,
 @NonNull String location)

Acquires a builder for Response instances that are intended to redirect the client.

Parameters:

redirectType - the kind of redirect to perform, for example RedirectType.HTTP_307_TEMPORARY_REDIRECT

location - the URL to redirect to

Returns:

the builder

fromRedirect

public static @NonNull Response fromRedirect(@NonNull RedirectType redirectType,
 @NonNull String location)

Creates a redirect Response with no additional customization.

Parameters:

redirectType - the kind of redirect to perform, for example RedirectType.HTTP_307_TEMPORARY_REDIRECT

location - the URL to redirect to

Returns:

a Response instance

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public @NonNull Response.Copier copy()

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

Returns:

a copier for this instance

getStatusCode

public @NonNull Integer getStatusCode()

The HTTP status code to be written to the client for this response.

See StatusCode for an enumeration of all HTTP status codes.

Returns:

the HTTP status code to write to the response

getCookies

public @NonNull Set<@NonNull ResponseCookie> getCookies()

The cookies to be written to the client for this response.

It is possible to send multiple ResponseCookie values with the same name to the client.

Note that ResponseCookie values, like all response headers, have case-insensitive names per the HTTP spec.

Returns:

the cookies to write to the response

getHeaders

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

The headers to be written to the client for this response.

The keys are the header names and the values are header values. Soklet writes one header line per value. If order matters, provide either a SortedSet or LinkedHashSet to preserve the desired ordering; otherwise values are naturally sorted for consistency.

Note that response headers have case-insensitive names per the HTTP spec.

Returns:

the headers to write to the response

getBody

public @NonNull Optional<Object> getBody()

The "logical" body content to be written to the response, if present.

It is the responsibility of the ResponseMarshaler to take this object and convert it into bytes to send over the wire.

Returns:

the object representing the response body, or Optional.empty() if no response body should be written