Interface ResourceMethodResolver

public interface ResourceMethodResolver

Contract for matching incoming HTTP requests with appropriate Resource Methods (Java methods to invoke to handle requests).

A Resource Method is a Java Method with an HTTP method annotation applied, e.g. GET, POST, ServerSentEventSource, ...

Standard threadsafe implementations can be acquired via these factory methods:

• fromClasspathIntrospection() (examines an annotation-processor-generated lookup table of Java Method declarations with corresponding HTTP method annotations)
• fromClasses(Set) (examines methods within the hardcoded set of classes)
• fromMethods(Set) (examines the hardcoded set of methods)

It is likely that one or more of the above implementations is sufficient for your application and test suite.

However, should a custom implementation be necessary, documentation is available at https://www.soklet.com/docs/request-handling#resource-method-resolution.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
static @NonNull ResourceMethodResolver	fromClasses(@NonNull Set<@NonNull Class<?>> classes)	Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided classes.
static @NonNull ResourceMethodResolver	fromClasspathIntrospection()	Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining a lookup table of Java Method declarations that are annotated with GET, POST, ServerSentEventSource, etc.
static @NonNull ResourceMethodResolver	fromMethods(@NonNull Set<@NonNull Method> methods)	Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided methods.
@NonNull Set<@NonNull ResourceMethod>	getResourceMethods()	Vends the set of all Resource Methods registered in the system.
@NonNull Optional<ResourceMethod>	resourceMethodForRequest(@NonNull Request request, @NonNull ServerType serverType)	Given an HTTP request, provide a matching Resource Method to invoke.

Method Details

resourceMethodForRequest

@NonNull Optional<ResourceMethod> resourceMethodForRequest(@NonNull Request request,
 @NonNull ServerType serverType)

Given an HTTP request, provide a matching Resource Method to invoke.

An unmatched Resource Method generally indicates an HTTP 404.

Parameters:

request - the HTTP request

serverType - the type of server that's handling the request

Returns:

the matching Resource Method, or Optional.empty() if no match was found

getResourceMethods

@NonNull Set<@NonNull ResourceMethod> getResourceMethods()

Vends the set of all Resource Methods registered in the system.

Returns:

the set of all Resource Methods in the system

fromClasspathIntrospection

static @NonNull ResourceMethodResolver fromClasspathIntrospection()

Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining a lookup table of Java Method declarations that are annotated with GET, POST, ServerSentEventSource, etc.

This implementation requires that your application be compiled with the SokletProcessor annotation processor, as shown below:

javac -parameters -processor com.soklet.SokletProcessor ...[rest of javac command elided]

The returned instance is guaranteed to be a JVM-wide singleton.

Returns:

a ResourceMethodResolver which performs classpath introspection against the annotation processor's lookup table

fromClasses

static @NonNull ResourceMethodResolver fromClasses(@NonNull Set<@NonNull Class<?>> classes)

Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided classes.

This method is guaranteed to return a new instance.

Parameters:

classes - the classes to inspect for Resource Methods

Returns:

a ResourceMethodResolver backed by the given classes

fromMethods

static @NonNull ResourceMethodResolver fromMethods(@NonNull Set<@NonNull Method> methods)

Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided methods.

This method is guaranteed to return a new instance.

Parameters:

methods - the methods to inspect for Resource Method annotations

Returns:

a ResourceMethodResolver backed by the given methods