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
@NonNull Request	Request.PathBuilder.build()
@NonNull Request	Request.RawBuilder.build()
@NonNull Request	Request.Copier.finish()
static @NonNull Request	Request.fromPath(@NonNull HttpMethod httpMethod, @NonNull String path)	Creates a Request from a path without additional customization.
static @NonNull Request	Request.fromRawUrl(@NonNull HttpMethod httpMethod, @NonNull String rawUrl)	Creates a Request from a raw request target without additional customization.
@NonNull Request	ServerSentEventConnection.getRequest()	The request made by the client to the Event Source Method which accepted the SSE handshake and established the connection.

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

Modifier and Type	Method	Description
@NonNull 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
@NonNull Optional<CorsResponse>	CorsAuthorizer.authorize(@NonNull Request request, @NonNull Cors cors)	Authorizes a non-preflight CORS request.
@NonNull Optional<CorsPreflightResponse>	CorsAuthorizer.authorizePreflight(@NonNull Request request, @NonNull CorsPreflight corsPreflight, @NonNull Map<@NonNull HttpMethod, @NonNull ResourceMethod> availableResourceMethodsByHttpMethod)	Authorizes a CORS preflight request.
default void	LifecycleObserver.didFailToEstablishServerSentEventConnection(@NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull ServerSentEventConnection.HandshakeFailureReason reason, @Nullable Throwable throwable)	Called if an SSE connection fails to establish.
default void	MetricsCollector.didFailToEstablishServerSentEventConnection(@NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull ServerSentEventConnection.HandshakeFailureReason reason, @Nullable Throwable throwable)	Called if an SSE connection fails to establish.
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.didStartRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod)	Called as soon as a request is received and a Resource Method has been resolved to handle it.
default void	MetricsCollector.didStartRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod)	Called as soon as a request is received and a Resource Method has been resolved to handle it.
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 Map<@NonNull String, @NonNull Set<@NonNull MultipartField>>	MultipartParser.extractMultipartFields(@NonNull Request request)	Given a request, detect all HTML form fields with multipart/form-data encoding and parse their values.
@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.
@NonNull T	IdGenerator.generateId(@NonNull Request request)	Generates an identifier for the given Request.
@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.
void	Server.RequestHandler.handleRequest(@NonNull Request request, @NonNull 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(@NonNull Request request, @NonNull 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	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.
@NonNull Optional<Object>	RequestBodyMarshaler.marshalRequestBody(@NonNull Request request, @NonNull ResourceMethod resourceMethod, @NonNull Parameter parameter, @NonNull 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.
@NonNull List<@Nullable Object>	ResourceMethodParameterProvider.parameterValuesForResourceMethod(@NonNull Request request, @NonNull 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().
@NonNull RequestResult	Simulator.performRequest(@NonNull 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.
@NonNull ServerSentEventRequestResult	Simulator.performServerSentEventRequest(@NonNull 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);
@NonNull LogEvent.Builder	LogEvent.Builder.request(@Nullable Request request)
@NonNull LogEvent.Copier	LogEvent.Copier.request(@Nullable Request request)
@NonNull Optional<ResourceMethod>	ResourceMethodResolver.resourceMethodForRequest(@NonNull Request request, @NonNull ServerType serverType)	Given an HTTP request, provide a matching Resource Method to invoke.
default void	LifecycleObserver.willEstablishServerSentEventConnection(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Called before an SSE connection is established.
default void	MetricsCollector.willEstablishServerSentEventConnection(@NonNull Request request, @Nullable ResourceMethod resourceMethod)	Called before an SSE connection is established.
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 Utilities.EffectiveOriginResolver	Utilities.EffectiveOriginResolver.withRequest(@NonNull Request request, @NonNull Utilities.EffectiveOriginResolver.TrustPolicy trustPolicy)	Acquires a builder seeded with a Request and a trust policy.
default void	RequestInterceptor.wrapRequest(@NonNull ServerType serverType, @NonNull Request request, @NonNull Consumer<Request> requestProcessor)	Called before Soklet begins request processing, allowing the request to be wrapped or replaced.

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

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.wrapRequest(@NonNull ServerType serverType, @NonNull Request request, @NonNull Consumer<Request> requestProcessor)	Called before Soklet begins request processing, allowing the request to be wrapped or replaced.