Class RequestResult

java.lang.Object

com.soklet.RequestResult

@ThreadSafe
public final class RequestResult
extends Object

Encapsulates the results of a request that would normally be handled by your Server (both logical response and bytes to be sent over the wire), used for integration testing via Simulator.performRequest(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 ServerSentEventRequestResult, which is used for integration testing via Simulator.performServerSentEventRequest(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	RequestResult.Builder	Builder used to construct instances of RequestResult via withMarshaledResponse(MarshaledResponse).
static final class	RequestResult.Copier	Builder used to copy instances of RequestResult via copy().

Method Summary

Modifier and Type	Method	Description
@NonNull RequestResult.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(@Nullable Object object)
static @NonNull RequestResult	fromMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Creates a RequestResult 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 RequestResult.Builder	withMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Acquires a builder for RequestResult instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withMarshaledResponse

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

Acquires a builder for RequestResult instances.

Parameters:

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

Returns:

the builder

fromMarshaledResponse

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

Creates a RequestResult from a marshaled response without additional customization.

Parameters:

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

Returns:

a RequestResult instance

copy

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