Uses of Class
com.soklet.Request

Packages that use Request

Package	Description
com.soklet	Core Soklet contracts and functionality.

Uses of Request in com.soklet

Methods in com.soklet that return Request

Modifier and Type	Method	Description
Request	Request.PathBuilder.build()
Request	Request.RawBuilder.build()
Request	Request.Copier.finish()

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

Modifier and Type	Method	Description
Optional<Request>	LogEvent.getRequest()	The request associated with this log event, if available.

Methods in com.soklet with parameters of type Request

Modifier and Type	Method	Description
Optional<CorsResponse>	CorsAuthorizer.authorize(Request request, Cors cors)	Authorizes a non-preflight CORS request.
Optional<CorsPreflightResponse>	CorsAuthorizer.authorizePreflight(Request request, CorsPreflight corsPreflight, Map<HttpMethod, ResourceMethod> availableResourceMethodsByHttpMethod)	Authorizes a CORS preflight request.
default void	LifecycleInterceptor.didEstablishServerSentEventConnection(Request request, ResourceMethod resourceMethod)	Called immediately after a Server-Sent Event connection of indefinite duration to the client is opened.
default void	LifecycleInterceptor.didFinishRequestHandling(Request request, ResourceMethod resourceMethod, MarshaledResponse marshaledResponse, Duration processingDuration, List<Throwable> throwables)	Called after a request has fully completed processing and a response has been sent to the client.
default void	LifecycleInterceptor.didFinishResponseWriting(Request request, ResourceMethod resourceMethod, MarshaledResponse marshaledResponse, Duration responseWriteDuration, Throwable throwable)	Called after the response is sent to the client.
default void	LifecycleInterceptor.didFinishServerSentEventWriting(Request request, ResourceMethod resourceMethod, ServerSentEvent serverSentEvent, Duration writeDuration, Throwable throwable)	Called after a Server-Sent Event is sent to the client.
default void	LifecycleInterceptor.didStartRequestHandling(Request request, ResourceMethod resourceMethod)	Called as soon as a request is received and a Resource Method has been resolved to handle it.
default void	LifecycleInterceptor.didTerminateServerSentEventConnection(Request request, ResourceMethod resourceMethod, Duration connectionDuration, Throwable throwable)	Called immediately after a Server-Sent Event connection to the client is terminated.
Map<String, Set<MultipartField>>	MultipartParser.extractMultipartFields(Request request)	Given a request, detect all HTML form fields with multipart/form-data encoding and parse their values.
MarshaledResponse	ResponseMarshaler.forContentTooLarge(Request request, ResourceMethod resourceMethod)	Prepares a response for a request that triggers an HTTP 413 Content Too Large.
MarshaledResponse	ResponseMarshaler.forCorsAllowed(Request request, Cors cors, CorsResponse corsResponse, MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
MarshaledResponse	ResponseMarshaler.forCorsPreflightAllowed(Request request, CorsPreflight corsPreflight, CorsPreflightResponse corsPreflightResponse)	Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
MarshaledResponse	ResponseMarshaler.forCorsPreflightRejected(Request request, CorsPreflight corsPreflight)	Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
MarshaledResponse	ResponseMarshaler.forHead(Request request, MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
MarshaledResponse	ResponseMarshaler.forMethodNotAllowed(Request request, Set<HttpMethod> allowedHttpMethods)	Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.
MarshaledResponse	ResponseMarshaler.forNotFound(Request request)	Prepares a response for a request that does not have a matching Resource Method, which triggers an HTTP 404 Not Found.
MarshaledResponse	ResponseMarshaler.forOptions(Request request, Set<HttpMethod> allowedHttpMethods)	Prepares a response for an HTTP OPTIONS request.
MarshaledResponse	ResponseMarshaler.forOptionsSplat(Request request)	Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
MarshaledResponse	ResponseMarshaler.forResourceMethod(Request request, Response response, ResourceMethod resourceMethod)	Prepares a response for a request that was matched to a Resource Method and returned normally (i.e., without throwing an exception).
MarshaledResponse	ResponseMarshaler.forThrowable(Request request, Throwable throwable, ResourceMethod resourceMethod)	Prepares a response for scenarios in which an uncaught exception is encountered.
MarshaledResponse	ResponseMarshaler.Builder.ContentTooLargeHandler.handle(Request request, ResourceMethod resourceMethod)	Prepares a response for a request that triggers an HTTP 413 Content Too Large.
MarshaledResponse	ResponseMarshaler.Builder.CorsAllowedHandler.handle(Request request, Cors cors, CorsResponse corsResponse, MarshaledResponse marshaledResponse)	Applies "CORS is permitted for this request" data to a response.
MarshaledResponse	ResponseMarshaler.Builder.CorsPreflightAllowedHandler.handle(Request request, CorsPreflight corsPreflight, CorsPreflightResponse corsPreflightResponse)	Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
MarshaledResponse	ResponseMarshaler.Builder.CorsPreflightRejectedHandler.handle(Request request, CorsPreflight corsPreflight)	Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
MarshaledResponse	ResponseMarshaler.Builder.HeadHandler.handle(Request request, MarshaledResponse getMethodMarshaledResponse)	Prepares a response for an HTTP HEAD request.
MarshaledResponse	ResponseMarshaler.Builder.MethodNotAllowedHandler.handle(Request request, Set<HttpMethod> allowedHttpMethods)	Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.
MarshaledResponse	ResponseMarshaler.Builder.NotFoundHandler.handle(Request request)	Prepares a response for a request that triggers an HTTP 404 Not Found.
MarshaledResponse	ResponseMarshaler.Builder.OptionsHandler.handle(Request request, Set<HttpMethod> allowedHttpMethods)	Prepares a response for an HTTP OPTIONS request.
MarshaledResponse	ResponseMarshaler.Builder.OptionsSplatHandler.handle(Request request)	Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
MarshaledResponse	ResponseMarshaler.Builder.ResourceMethodHandler.handle(Request request, Response response, ResourceMethod resourceMethod)	Prepares a response for the scenario in which the request was matched to a Resource Method and executed non-exceptionally.
MarshaledResponse	ResponseMarshaler.Builder.ThrowableHandler.handle(Request request, Throwable throwable, ResourceMethod resourceMethod)	Prepares a response for scenarios in which an uncaught exception is encountered.
void	Server.RequestHandler.handleRequest(Request request, Consumer<RequestResult> requestResultConsumer)	Callback to be invoked by a Server implementation after it has received an HTTP request but prior to writing an HTTP response.
void	ServerSentEventServer.RequestHandler.handleRequest(Request request, Consumer<RequestResult> requestResultConsumer)	Callback to be invoked by a ServerSentEventServer implementation after it has received a Server-Sent Event Source HTTP request but prior to writing initial data to the HTTP response.
default void	LifecycleInterceptor.interceptRequest(Request request, ResourceMethod resourceMethod, Function<Request, MarshaledResponse> responseProducer, Consumer<MarshaledResponse> responseWriter)	Supports alteration of the request processing flow by enabling programmatic control over its two key phases: acquiring a response and writing the response to the client.
Optional<Object>	RequestBodyMarshaler.marshalRequestBody(Request request, ResourceMethod resourceMethod, Parameter parameter, Type requestBodyType)	Given a request, the Resource Method that will handle it, and a RequestBody-annotated parameter + its type, convert the request body bytes into an instance of type requestBodyType.
List<Object>	ResourceMethodParameterProvider.parameterValuesForResourceMethod(Request request, ResourceMethod resourceMethod)	For the given request and resourceMethod, vends the list of parameters to use when invoking the underlying Java method located at ResourceMethod.getMethod().
RequestResult	Simulator.performRequest(Request request)	Given a request that would normally be handled by your standard Server, process it and return response data (both logical Response, if present, and the MarshaledResponse bytes to be sent over the wire) as well as the matching Resource Method, if available.
ServerSentEventRequestResult	Simulator.performServerSentEventRequest(Request request)	Given a request that would normally be handled by your ServerSentEventServer (that is, for a Resource Method decorated with the ServerSentEventSource annotation), process it and return response data (ServerSentEventRequestResult.HandshakeAccepted, ServerSentEventRequestResult.HandshakeRejected, or ServerSentEventRequestResult.RequestFailed);
LogEvent.Builder	LogEvent.Builder.request(Request request)
LogEvent.Copier	LogEvent.Copier.request(Request request)
Optional<ResourceMethod>	ResourceMethodResolver.resourceMethodForRequest(Request request, ServerType serverType)	Given an HTTP request, provide a matching Resource Method to invoke.
default void	LifecycleInterceptor.willEstablishServerSentEventConnection(Request request, ResourceMethod resourceMethod)	Called immediately before a Server-Sent Event connection of indefinite duration to the client is opened.
default void	LifecycleInterceptor.willStartResponseWriting(Request request, ResourceMethod resourceMethod, MarshaledResponse marshaledResponse)	Called before the response is sent to the client.
default void	LifecycleInterceptor.willStartServerSentEventWriting(Request request, ResourceMethod resourceMethod, ServerSentEvent serverSentEvent)	Called before a Server-Sent Event is sent to the client.
default void	LifecycleInterceptor.willTerminateServerSentEventConnection(Request request, ResourceMethod resourceMethod, Throwable throwable)	Called immediately before a Server-Sent Event connection to the client is terminated.
default void	LifecycleInterceptor.wrapRequest(Request request, ResourceMethod resourceMethod, Consumer<Request> requestProcessor)	Wraps around the whole "outside" of the entire request-handling flow.

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

Modifier and Type	Method	Description
default void	LifecycleInterceptor.interceptRequest(Request request, ResourceMethod resourceMethod, Function<Request, MarshaledResponse> responseProducer, Consumer<MarshaledResponse> responseWriter)	Supports alteration of the request processing flow by enabling programmatic control over its two key phases: acquiring a response and writing the response to the client.
default void	LifecycleInterceptor.wrapRequest(Request request, ResourceMethod resourceMethod, Consumer<Request> requestProcessor)	Wraps around the whole "outside" of the entire request-handling flow.