org.mule.runtime.http.api.utils

Interface RequestMatcherRegistry<T>

Type Parameters:

T - the type of object associated to the registry

public interface RequestMatcherRegistry<T>

Generic registry of PathAndMethodRequestMatchers that can handle collision validation and searching through wildcard paths for a matching entry. Additionally, entries can be managed to be temporarily disabled or removed entirely.

Since:

4.1.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RequestMatcherRegistry.RequestMatcherRegistryBuilder<T> Builder of RequestMatcherRegistry.
static interface	RequestMatcherRegistry.RequestMatcherRegistryEntry Entry of a RequestMatcherRegistry which allows managing it's visibility.

Method Summary

Modifier and Type	Method and Description
RequestMatcherRegistry.RequestMatcherRegistryEntry	add(PathAndMethodRequestMatcher matcher, T item) Includes a new matcher to return the desired item.
T	find(HttpRequest request) Searches this registry for the most specific match for the given HttpRequest considering all registered PathAndMethodRequestMatchers.
default T	find(String method, String path) Searches this registry for the most specific match for the given HttpRequest considering all registered PathAndMethodRequestMatchers.

Method Detail

add

RequestMatcherRegistry.RequestMatcherRegistryEntry add(PathAndMethodRequestMatcher matcher,
                                                       T item)

Includes a new matcher to return the desired item. The matcher's path and method will be analysed to determine whether any collisions exists with the already registered objects.

Parameters:

matcher - the PathAndMethodRequestMatcher to associate with the item

item - the object to register under the matcher

Throws:

MatcherCollisionException - if a collision is found

find

T find(HttpRequest request)

Searches this registry for the most specific match for the given HttpRequest considering all registered PathAndMethodRequestMatchers.

Parameters:

request - the HttpRequest to match against

Returns:

the matching registered object

find

default T find(String method,
               String path)

Searches this registry for the most specific match for the given HttpRequest considering all registered PathAndMethodRequestMatchers.

Parameters:

method - the HTTP method to match against

path - the full path to match against (must not contain wildcard or parametrization)

Returns:

the matching registered object