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) factory method.

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
RequestResult.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(Object object)
Optional<CorsPreflightResponse>	getCorsPreflightResponse()	The CORS preflight logical response, if applicable for the request.
MarshaledResponse	getMarshaledResponse()	The final representation of the response to be written over the wire.
Optional<ResourceMethod>	getResourceMethod()	The Resource Method that handled the request, if available.
Optional<Response>	getResponse()	The logical response, determined by the return value of the Resource Method (if available).
int	hashCode()
String	toString()
static RequestResult.Builder	withMarshaledResponse(MarshaledResponse marshaledResponse)	Acquires a builder for RequestResult instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withMarshaledResponse

@Nonnull
public static 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

copy

@Nonnull
public 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

@Nonnull
public MarshaledResponse getMarshaledResponse()

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

Returns:

the response to be written over the wire

getResponse

@Nonnull
public Optional<Response> getResponse()

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

Returns:

the logical response

getCorsPreflightResponse

@Nonnull
public Optional<CorsPreflightResponse> getCorsPreflightResponse()

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

Returns:

the CORS preflight logical response

getResourceMethod

@Nonnull
public Optional<ResourceMethod> getResourceMethod()

The Resource Method that handled the request, if available.

Returns:

the Resource Method that handled the request