Uses of Class
com.soklet.MarshaledResponse

Packages that use MarshaledResponse

Package	Description
com.soklet	Core Soklet contracts and functionality.

Uses of MarshaledResponse in com.soklet

Methods in com.soklet that return MarshaledResponse

Modifier and Type	Method	Description
@NonNull MarshaledResponse	MarshaledResponse.Builder.build()
@NonNull MarshaledResponse	MarshaledResponse.Copier.finish()
@NonNull MarshaledResponse	ResponseMarshaler.forContentTooLarge(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Prepares a response for a request that triggers an HTTP 413 Content Too Large.
@NonNull MarshaledResponse	ResponseMarshaler.forCorsAllowed(@NonNull Request request, @NonNull Cors cors, @NonNull CorsResponse corsResponse, @NonNull MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
@NonNull MarshaledResponse	ResponseMarshaler.forCorsPreflightAllowed(@NonNull Request request, @NonNull CorsPreflight corsPreflight, @NonNull CorsPreflightResponse corsPreflightResponse)	Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
@NonNull MarshaledResponse	ResponseMarshaler.forCorsPreflightRejected(@NonNull Request request, @NonNull CorsPreflight corsPreflight)	Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
@NonNull MarshaledResponse	ResponseMarshaler.forHead(@NonNull Request request, @NonNull MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
@NonNull MarshaledResponse	ResponseMarshaler.forMethodNotAllowed(@NonNull Request request, @NonNull Set<@NonNull HttpMethod> allowedHttpMethods)	Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.
@NonNull MarshaledResponse	ResponseMarshaler.forNotFound(@NonNull Request request)	Prepares a response for a request that does not have a matching Resource Method, which triggers an HTTP 404 Not Found.
@NonNull MarshaledResponse	ResponseMarshaler.forOptions(@NonNull Request request, @NonNull Set<@NonNull HttpMethod> allowedHttpMethods)	Prepares a response for an HTTP OPTIONS request.
@NonNull MarshaledResponse	ResponseMarshaler.forOptionsSplat(@NonNull Request request)	Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
@NonNull MarshaledResponse	ResponseMarshaler.forResourceMethod(@NonNull Request request, @NonNull Response response, @NonNull ResourceMethod resourceMethod)	Prepares a response for a request that was matched to a Resource Method and returned normally (i.e., without throwing an exception).
@NonNull MarshaledResponse	ResponseMarshaler.forServiceUnavailable(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Prepares a response for a request that is rejected because the server is overloaded (e.g. connection limit reached), triggering an HTTP 503 Service Unavailable.
@NonNull MarshaledResponse	ResponseMarshaler.forThrowable(@NonNull Request request, @NonNull Throwable throwable, @Nullable ResourceMethod resourceMethod)	Prepares a response for scenarios in which an uncaught exception is encountered.
static @NonNull MarshaledResponse	MarshaledResponse.fromResponse(@NonNull Response response)	Creates a MarshaledResponse from a logical Response without additional customization.
static @NonNull MarshaledResponse	MarshaledResponse.fromStatusCode(@NonNull Integer statusCode)	Creates a MarshaledResponse with the given status code and no additional customization.
@NonNull MarshaledResponse	RequestResult.getMarshaledResponse()	The final representation of the response to be written over the wire.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.ContentTooLargeHandler.handle(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Prepares a response for a request that triggers an HTTP 413 Content Too Large.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.CorsAllowedHandler.handle(@NonNull Request request, @NonNull Cors cors, @NonNull CorsResponse corsResponse, @NonNull MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.CorsPreflightAllowedHandler.handle(@NonNull Request request, @NonNull CorsPreflight corsPreflight, @NonNull CorsPreflightResponse corsPreflightResponse)	Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.CorsPreflightRejectedHandler.handle(@NonNull Request request, @NonNull CorsPreflight corsPreflight)	Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.HeadHandler.handle(@NonNull Request request, @NonNull MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.MethodNotAllowedHandler.handle(@NonNull Request request, @NonNull Set<@NonNull HttpMethod> allowedHttpMethods)	Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.NotFoundHandler.handle(@NonNull Request request)	Prepares a response for a request that triggers an HTTP 404 Not Found.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.OptionsHandler.handle(@NonNull Request request, @NonNull Set<@NonNull HttpMethod> allowedHttpMethods)	Prepares a response for an HTTP OPTIONS request.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.OptionsSplatHandler.handle(@NonNull Request request)	Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.ResourceMethodHandler.handle(@NonNull Request request, @NonNull Response response, @NonNull ResourceMethod resourceMethod)	Prepares a response for the scenario in which the request was matched to a Resource Method and executed non-exceptionally.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.ServiceUnavailableHandler.handle(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Prepares a response for a request that triggers an HTTP 503 Service Unavailable.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.ThrowableHandler.handle(@NonNull Request request, @NonNull Throwable throwable, @Nullable ResourceMethod resourceMethod)	Prepares a response for scenarios in which an uncaught exception is encountered.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.PostProcessor.postProcess(@NonNull MarshaledResponse marshaledResponse)	Applies an optional "post-process" hook for any final customization or processing before data goes over the wire.

Methods in com.soklet that return types with arguments of type MarshaledResponse

Modifier and Type	Method	Description
@NonNull Optional<MarshaledResponse>	LogEvent.getMarshaledResponse()	The response associated with this log event, if available.

Methods in com.soklet with parameters of type MarshaledResponse

Modifier and Type	Method	Description
default void	LifecycleObserver.didFailToWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration, @NonNull Throwable throwable)	Called after response data fails to write.
default void	MetricsCollector.didFailToWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration, @NonNull Throwable throwable)	Called after response data fails to write.
default void	LifecycleObserver.didFinishRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration duration, @NonNull List<@NonNull Throwable> throwables)	Called after a request finishes processing.
default void	MetricsCollector.didFinishRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration duration, @NonNull List<@NonNull Throwable> throwables)	Called after a request finishes processing.
default void	LifecycleObserver.didWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration)	Called after response data is written.
default void	MetricsCollector.didWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration)	Called after response data is written.
@NonNull MarshaledResponse	ResponseMarshaler.forCorsAllowed(@NonNull Request request, @NonNull Cors cors, @NonNull CorsResponse corsResponse, @NonNull MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
@NonNull MarshaledResponse	ResponseMarshaler.forHead(@NonNull Request request, @NonNull MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
static @NonNull RequestResult	RequestResult.fromMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Creates a RequestResult from a marshaled response without additional customization.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.CorsAllowedHandler.handle(@NonNull Request request, @NonNull Cors cors, @NonNull CorsResponse corsResponse, @NonNull MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
@NonNull MarshaledResponse	ResponseMarshaler.Builder.HeadHandler.handle(@NonNull Request request, @NonNull MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
@NonNull LogEvent.Builder	LogEvent.Builder.marshaledResponse(@Nullable MarshaledResponse marshaledResponse)
@NonNull LogEvent.Copier	LogEvent.Copier.marshaledResponse(@Nullable MarshaledResponse marshaledResponse)
@NonNull RequestResult.Builder	RequestResult.Builder.marshaledResponse(@NonNull MarshaledResponse marshaledResponse)
@NonNull RequestResult.Copier	RequestResult.Copier.marshaledResponse(@NonNull MarshaledResponse marshaledResponse)
@NonNull MarshaledResponse	ResponseMarshaler.Builder.PostProcessor.postProcess(@NonNull MarshaledResponse marshaledResponse)	Applies an optional "post-process" hook for any final customization or processing before data goes over the wire.
default void	LifecycleObserver.willWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse)	Called before response data is written.
default void	MetricsCollector.willWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse)	Called before response data is written.
static @NonNull RequestResult.Builder	RequestResult.withMarshaledResponse(@NonNull MarshaledResponse marshaledResponse)	Acquires a builder for RequestResult instances.

Method parameters in com.soklet with type arguments of type MarshaledResponse

Modifier and Type	Method	Description
default void	RequestInterceptor.interceptRequest(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull Function<Request, MarshaledResponse> responseGenerator, @NonNull Consumer<MarshaledResponse> responseWriter)	Intercepts request processing, allowing the request to be replaced and/or the response to be transformed.
default void	RequestInterceptor.interceptRequest(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull Function<Request, MarshaledResponse> responseGenerator, @NonNull Consumer<MarshaledResponse> responseWriter)	Intercepts request processing, allowing the request to be replaced and/or the response to be transformed.