Interface ResourceMethodResolver

public interface ResourceMethodResolver

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

Standard implementations can be acquired via these factory methods:

• withDefaults()
• withResourceClasses(Set)
• withMethods(Set)

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

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
Set<ResourceMethod>	getResourceMethods()	Vends the set of all Resource Methods registered in the system.
Optional<ResourceMethod>	resourceMethodForRequest(Request request)	Given an HTTP request, provide a matching Resource Method to invoke.
static ResourceMethodResolver	withDefaults()
static ResourceMethodResolver	withMethods(Set<Method> methods)
static ResourceMethodResolver	withResourceClasses(Set<Class<?>> resourceClasses)

Method Details

resourceMethodForRequest

@Nonnull
Optional<ResourceMethod> resourceMethodForRequest(@Nonnull
 Request request)

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

Returns:

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

getResourceMethods

@Nonnull
Set<ResourceMethod> getResourceMethods()

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

Returns:

the set of all Resource Methods in the system

withDefaults

@Nonnull
static ResourceMethodResolver withDefaults()

withResourceClasses

@Nonnull
static ResourceMethodResolver withResourceClasses(@Nonnull
 Set<Class<?>> resourceClasses)

withMethods

@Nonnull
static ResourceMethodResolver withMethods(@Nonnull
 Set<Method> methods)