Class DefaultUrlRouteInfo<T,R>

java.lang.Object

io.micronaut.web.router.DefaultRouteInfo<R>

io.micronaut.web.router.DefaultRequestMatcher<T,R>

io.micronaut.web.router.DefaultUrlRouteInfo<T,R>

Type Parameters:

T - The target

R - The result

All Implemented Interfaces:

AnnotationMetadataProvider, AnnotationSource, UriMatcher, MethodBasedRouteInfo<T,R>, RequestMatcher, RouteInfo<R>, UriRouteInfo<T,R>, Comparable<UriRouteInfo<T,R>>

@Internal
public final class DefaultUrlRouteInfo<T,R>
extends DefaultRequestMatcher<T,R>
implements UriRouteInfo<T,R>

The default UriRouteInfo implementation.

Since:

4.0.0

Author:

Denis Stepanov

Field Summary

Fields inherited from class DefaultRouteInfo

annotationMetadata, consumesMediaTypes, consumesMediaTypesContainsAll, declaringType, definedStatus, isWebSocketRoute, producesMediaTypes, producesMediaTypesContainsAll, returnType

Fields inherited from interface AnnotationSource

EMPTY

Fields inherited from interface RouteInfo

DEFAULT_PRODUCES

Constructor Summary

Constructors

Constructor	Description
DefaultUrlRouteInfo(HttpMethod httpMethod, UriMatchTemplate uriMatchTemplate, Charset defaultCharset, MethodExecutionHandle<T,R> targetMethod, @Nullable String bodyArgumentName, @Nullable Argument<?> bodyArgument, List<MediaType> consumesMediaTypes, List<MediaType> producesMediaTypes, List<Predicate<HttpRequest<?>>> predicates, @Nullable Integer port, ConversionService conversionService, ExecutorSelector executorSelector, MessageBodyHandlerRegistry messageBodyHandlerRegistry)
DefaultUrlRouteInfo(HttpMethod httpMethod, UriMatchTemplate uriMatchTemplate, Charset defaultCharset, MethodExecutionHandle<T,R> targetMethod, @Nullable String bodyArgumentName, @Nullable Argument<?> bodyArgument, List<MediaType> consumesMediaTypes, List<MediaType> producesMediaTypes, List<Predicate<HttpRequest<?>>> predicates, @Nullable Integer port, ConversionService conversionService, ExecutorSelector executorSelector, MessageBodyHandlerRegistry messageBodyHandlerRegistry, boolean implicitHead)
DefaultUrlRouteInfo(HttpMethod httpMethod, String httpMethodName, UriMatchTemplate uriMatchTemplate, Charset defaultCharset, MethodExecutionHandle<T,R> targetMethod, @Nullable String bodyArgumentName, @Nullable Argument<?> bodyArgument, List<MediaType> consumesMediaTypes, List<MediaType> producesMediaTypes, List<Predicate<HttpRequest<?>>> predicates, @Nullable Integer port, ConversionService conversionService, ExecutorSelector executorSelector, MessageBodyHandlerRegistry messageBodyHandlerRegistry, boolean implicitHead)

Method Summary

Modifier and Type	Method	Description
int	compareTo(UriRouteInfo o)
String[]	getArgumentNames()
@Nullable ExecutorService	getExecutor(@Nullable ThreadSelection threadSelection)
Executor	getExecutor(ThreadSelectionConfiguration configuration)
Optional<Argument<?>>	getFullRequestBodyType()	Like RouteInfo.getRequestBodyType(), but excludes body arguments that may match only a part of the body (i.e.
HttpMethod	getHttpMethod()
String	getHttpMethodName()
final @Nullable MessageBodyReader<?>	getMessageBodyReader()
@Nullable Integer	getPort()
Optional<Argument<?>>	getRequestBodyType()
MethodExecutionHandle<T,R>	getTargetMethod()
UriMatchTemplate	getUriMatchTemplate()
boolean	isImplicitHead()	Whether this route is an implicit HEAD route; that is, a HEAD route that was derived automatically from a Get mapping rather than declared by the user with Head.
boolean	isVoid()
Optional<UriRouteMatch<T,R>>	match(String uri)	Match this route within the given URI and produce a RouteMatch if a match is found.
boolean	needsRequestBody()
RequestArgumentBinder<Object>[]	resolveArgumentBinders(RequestBinderRegistry requestBinderRegistry)
String	toString()
@Nullable UriRouteMatch<T,R>	tryMatch(String uri)	Match this route within the given URI and produce a RouteMatch if a match is found.

Methods inherited from class DefaultRequestMatcher

matching

Methods inherited from class DefaultRouteInfo

consumesAll, doesConsume, doesProduce, doesProduce, explicitlyConsumes, explicitlyProduces, findStatus, getAnnotationMetadata, getConsumes, getDeclaringType, getMessageBodyWriter, getProduces, getResponseBodyType, getReturnType, isAsync, isAsyncOrReactive, isCompletable, isErrorRoute, isImperative, isPermitsRequestBody, isReactive, isSingleResult, isSpecifiedSingle, isSuspended, isWebSocketRoute, producesAll

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AnnotationMetadataProvider

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface AnnotationSource

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Methods inherited from interface MethodBasedRouteInfo

getArgumentNames, getTargetMethod, resolveArgumentBinders

Methods inherited from interface RequestMatcher

matching

Methods inherited from interface RouteInfo

consumesAll, doesConsume, doesProduce, doesProduce, explicitlyConsumes, explicitlyProduces, findStatus, getBodyArgument, getBodyType, getConsumes, getDeclaringType, getFullRequestBodyType, getMessageBodyReader, getMessageBodyWriter, getProduces, getRequestBodyType, getResponseBodyType, getReturnType, isAsync, isAsyncOrReactive, isCompletable, isErrorRoute, isImperative, isPermitsRequestBody, isReactive, isResponseBodyJsonFormattable, isSingleResult, isSpecifiedSingle, isSuspended, isVoid, isWebSocketRoute, needsRequestBody, producesAll

Methods inherited from interface UriRouteInfo

match, tryMatch

Constructor Details

DefaultUrlRouteInfo

public DefaultUrlRouteInfo(HttpMethod httpMethod,
 UriMatchTemplate uriMatchTemplate,
 Charset defaultCharset,
 MethodExecutionHandle<T,R> targetMethod,
 @Nullable String bodyArgumentName,
 @Nullable Argument<?> bodyArgument,
 List<MediaType> consumesMediaTypes,
 List<MediaType> producesMediaTypes,
 List<Predicate<HttpRequest<?>>> predicates,
 @Nullable Integer port,
 ConversionService conversionService,
 ExecutorSelector executorSelector,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry)

DefaultUrlRouteInfo

public DefaultUrlRouteInfo(HttpMethod httpMethod,
 UriMatchTemplate uriMatchTemplate,
 Charset defaultCharset,
 MethodExecutionHandle<T,R> targetMethod,
 @Nullable String bodyArgumentName,
 @Nullable Argument<?> bodyArgument,
 List<MediaType> consumesMediaTypes,
 List<MediaType> producesMediaTypes,
 List<Predicate<HttpRequest<?>>> predicates,
 @Nullable Integer port,
 ConversionService conversionService,
 ExecutorSelector executorSelector,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry,
 boolean implicitHead)

DefaultUrlRouteInfo

public DefaultUrlRouteInfo(HttpMethod httpMethod,
 String httpMethodName,
 UriMatchTemplate uriMatchTemplate,
 Charset defaultCharset,
 MethodExecutionHandle<T,R> targetMethod,
 @Nullable String bodyArgumentName,
 @Nullable Argument<?> bodyArgument,
 List<MediaType> consumesMediaTypes,
 List<MediaType> producesMediaTypes,
 List<Predicate<HttpRequest<?>>> predicates,
 @Nullable Integer port,
 ConversionService conversionService,
 ExecutorSelector executorSelector,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry,
 boolean implicitHead)

Parameters:

httpMethod - The HTTP method

httpMethodName - The actual name of the method - may differ from Enum.name() for non-standard http methods

uriMatchTemplate - The URI match template

defaultCharset - The default charset

targetMethod - The target method

bodyArgumentName - The body argument name

bodyArgument - The body argument

consumesMediaTypes - The consumed media types

producesMediaTypes - The produced media types

predicates - The predicates

port - The port

conversionService - The conversion service

executorSelector - The executor selector

messageBodyHandlerRegistry - The message body handler registry

implicitHead - Whether this is an implicit HEAD route

Since:

5.2.3

Method Details

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface UriRouteInfo<T,R>

Returns:

The HTTP method for this route

getHttpMethodName

public String getHttpMethodName()

Specified by:

getHttpMethodName in interface UriRouteInfo<T,R>

Returns:

The http method. Is equal to UriRouteInfo.getHttpMethod() value for standard http methods.

getUriMatchTemplate

public UriMatchTemplate getUriMatchTemplate()

Specified by:

getUriMatchTemplate in interface UriRouteInfo<T,R>

Returns:

The UriMatchTemplate used to match URIs

match

public Optional<UriRouteMatch<T,R>> match(String uri)

Description copied from interface: UriRouteInfo

Match this route within the given URI and produce a RouteMatch if a match is found.

Specified by:

match in interface UriMatcher

Specified by:

match in interface UriRouteInfo<T,R>

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

tryMatch

public @Nullable UriRouteMatch<T,R> tryMatch(String uri)

Description copied from interface: UriRouteInfo

Match this route within the given URI and produce a RouteMatch if a match is found.

Specified by:

tryMatch in interface UriRouteInfo<T,R>

Parameters:

uri - The URI

Returns:

A null or a RouteMatch

getPort

public @Nullable Integer getPort()

Specified by:

getPort in interface UriRouteInfo<T,R>

Returns:

The port the route listens to, or null if the default port

isImplicitHead

public boolean isImplicitHead()

Description copied from interface: UriRouteInfo

Whether this route is an implicit HEAD route; that is, a HEAD route that was derived automatically from a Get mapping rather than declared by the user with Head.

Implicit routes are fully-fledged routes and participate in matching and content negotiation exactly like any other route. The distinction is only used as a last-resort tie-break: if a request cannot be resolved to a single route and the remaining candidates contain both implicit and explicitly declared routes, the explicitly declared ones win instead of the request being rejected as ambiguous.

Specified by:

isImplicitHead in interface UriRouteInfo<T,R>

Returns:

true if this route was derived from a @Get mapping rather than declared

compareTo

public int compareTo(UriRouteInfo o)

Specified by:

compareTo in interface Comparable<T>

toString

public String toString()

Overrides:

toString in class Object

getExecutor

public @Nullable ExecutorService getExecutor(@Nullable ThreadSelection threadSelection)

Specified by:

getExecutor in interface RouteInfo<T>

Overrides:

getExecutor in class DefaultRouteInfo<R>

Parameters:

threadSelection - The thread selection

Returns:

The route executor

getExecutor

public Executor getExecutor(ThreadSelectionConfiguration configuration)

Specified by:

getExecutor in interface RouteInfo<T>

Overrides:

getExecutor in class DefaultRouteInfo<R>

getMessageBodyReader

public final @Nullable MessageBodyReader<?> getMessageBodyReader()

Specified by:

getMessageBodyReader in interface RouteInfo<T>

Returns:

The message body reader. if any.

resolveArgumentBinders

public RequestArgumentBinder<Object>[] resolveArgumentBinders(RequestBinderRegistry requestBinderRegistry)

Specified by:

resolveArgumentBinders in interface MethodBasedRouteInfo<T,R>

isVoid

public boolean isVoid()

Specified by:

isVoid in interface RouteInfo<T>

Overrides:

isVoid in class DefaultRouteInfo<R>

Returns:

Does the route return void

getTargetMethod

public MethodExecutionHandle<T,R> getTargetMethod()

Specified by:

getTargetMethod in interface MethodBasedRouteInfo<T,R>

Returns:

The MethodExecutionHandle

getRequestBodyType

public Optional<Argument<?>> getRequestBodyType()

Specified by:

getRequestBodyType in interface RouteInfo<T>

Overrides:

getRequestBodyType in class DefaultRouteInfo<R>

Returns:

The argument that represents the body of the request

getFullRequestBodyType

public Optional<Argument<?>> getFullRequestBodyType()

Description copied from interface: RouteInfo

Like RouteInfo.getRequestBodyType(), but excludes body arguments that may match only a part of the body (i.e. that have no @Body annotation, or where the @Body has a value set).

Specified by:

getFullRequestBodyType in interface RouteInfo<T>

Returns:

The argument that represents the body

getArgumentNames

public String[] getArgumentNames()

Specified by:

getArgumentNames in interface MethodBasedRouteInfo<T,R>

needsRequestBody

public boolean needsRequestBody()

Specified by:

needsRequestBody in interface RouteInfo<T>

Overrides:

needsRequestBody in class DefaultRouteInfo<R>

Returns:

true if the route needs request body to be read