Uses of Class
com.soklet.ResourceMethod

Packages that use ResourceMethod

Package	Description
com.soklet	Core Soklet contracts and functionality.

Uses of ResourceMethod in com.soklet

Methods in com.soklet that return ResourceMethod

Modifier and Type	Method	Description
static @NonNull ResourceMethod	ResourceMethod.fromComponents(@NonNull HttpMethod httpMethod, @NonNull ResourcePathDeclaration resourcePathDeclaration, @NonNull Method method, @NonNull Boolean serverSentEventSource)	Vends a Resource Method given its unique components.
@NonNull ResourceMethod	ServerSentEventConnection.getResourceMethod()	Returns the Event Source Method that provided the accepted handshake for this connection.

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

Modifier and Type	Method	Description
@NonNull Optional<ResourceMethod>	LogEvent.getResourceMethod()	The Resource Method associated with this log event, if available.
@NonNull Optional<ResourceMethod>	RequestResult.getResourceMethod()	The Resource Method that handled the request, if available.
@NonNull Set<@NonNull ResourceMethod>	ResourceMethodResolver.getResourceMethods()	Vends the set of all Resource Methods registered in the system.
@NonNull Optional<ResourceMethod>	ResourceMethodResolver.resourceMethodForRequest(@NonNull Request request, @NonNull ServerType serverType)	Given an HTTP request, provide a matching Resource Method to invoke.

Methods in com.soklet with parameters of type ResourceMethod

Modifier and Type	Method	Description
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 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.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 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.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.
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 LogEvent.Builder	LogEvent.Builder.resourceMethod(@Nullable ResourceMethod resourceMethod)
@NonNull LogEvent.Copier	LogEvent.Copier.resourceMethod(@Nullable ResourceMethod resourceMethod)
@NonNull RequestResult.Builder	RequestResult.Builder.resourceMethod(@Nullable ResourceMethod resourceMethod)
@NonNull RequestResult.Copier	RequestResult.Copier.resourceMethod(@Nullable ResourceMethod resourceMethod)
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.

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

Modifier and Type	Method	Description
@NonNull Optional<CorsPreflightResponse>	CorsAuthorizer.authorizePreflight(@NonNull Request request, @NonNull CorsPreflight corsPreflight, @NonNull Map<@NonNull HttpMethod, @NonNull ResourceMethod> availableResourceMethodsByHttpMethod)	Authorizes a CORS preflight request.