Class HttpRequestResult

java.lang.Object

com.soklet.HttpRequestResult

@ThreadSafe
public final class HttpRequestResult
extends Object

Encapsulates the results of a request that would normally be handled by your HttpServer (both logical response and bytes to be sent over the wire), used for integration testing via Simulator.performHttpRequest(Request).

Instances can be acquired via the withMarshaledResponse(MarshaledResponse) builder factory method. A convenience instance factory is also available via fromMarshaledResponse(MarshaledResponse).

The Server-Sent Event equivalent of this type is SseRequestResult, which is used for integration testing via Simulator.performSseRequest(Request).

See https://www.soklet.com/docs/testing#integration-testing for detailed documentation.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpRequestResult.Builder	Builder used to construct instances of HttpRequestResult via withMarshaledResponse(MarshaledResponse).
static final class	HttpRequestResult.Copier	Builder used to copy instances of HttpRequestResult via copy().

Method Summary

Modifier and Type	Method	Description
@NonNull HttpRequestResult.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(@Nullable Object object)
static @NonNull HttpRequestResult	fromMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Creates a HttpRequestResult from a marshaled response without additional customization.
@NonNull Optional<CorsPreflightResponse>	getCorsPreflightResponse()	The CORS preflight logical response, if applicable for the request.
@NonNull MarshaledResponse	getMarshaledResponse()	The final representation of the response to be written over the wire.
@NonNull Optional<ResourceMethod>	getResourceMethod()	The Resource Method that handled the request, if available.
@NonNull Optional<Response>	getResponse()	The logical response, determined by the return value of the Resource Method (if available).
int	hashCode()
String	toString()
static @NonNull HttpRequestResult.Builder	withMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Acquires a builder for HttpRequestResult instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withMarshaledResponse

public static @NonNull HttpRequestResult.Builder withMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)

Acquires a builder for HttpRequestResult instances.

Parameters:

marshaledResponse - the bytes that will ultimately be written over the wire

Returns:

the builder

fromMarshaledResponse

public static @NonNull HttpRequestResult fromMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)

Creates a HttpRequestResult from a marshaled response without additional customization.

Parameters:

marshaledResponse - the bytes that will ultimately be written over the wire

Returns:

a HttpRequestResult instance

copy

public @NonNull HttpRequestResult.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

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMarshaledResponse

public @NonNull MarshaledResponse getMarshaledResponse()

The final representation of the response to be written over the wire.

Returns:

the response to be written over the wire

getResponse

public @NonNull Optional<Response> getResponse()

The logical response, determined by the return value of the Resource Method (if available).

Returns:

the logical response

getCorsPreflightResponse

public @NonNull Optional<CorsPreflightResponse> getCorsPreflightResponse()

The CORS preflight logical response, if applicable for the request.

Returns:

the CORS preflight logical response

getResourceMethod

public @NonNull Optional<ResourceMethod> getResourceMethod()

The Resource Method that handled the request, if available.

Returns:

the Resource Method that handled the request