Package io.micronaut.web.router

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:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.http.uri.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

Field Summary

Fields inherited from class io.micronaut.web.router.DefaultRouteInfo

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

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Fields inherited from interface io.micronaut.web.router.RouteInfo

DEFAULT_PRODUCES

Constructor Summary

Constructors

Constructor

Description

DefaultUrlRouteInfo(io.micronaut.http.HttpMethod httpMethod, io.micronaut.http.uri.UriMatchTemplate uriMatchTemplate, Charset defaultCharset, io.micronaut.inject.MethodExecutionHandle<T,R> targetMethod, @Nullable String bodyArgumentName, @Nullable io.micronaut.core.type.Argument<?> bodyArgument, List<io.micronaut.http.MediaType> consumesMediaTypes, List<io.micronaut.http.MediaType> producesMediaTypes, List<Predicate<io.micronaut.http.HttpRequest<?>>> predicates, Integer port, io.micronaut.core.convert.ConversionService conversionService, io.micronaut.scheduling.executor.ExecutorSelector executorSelector, io.micronaut.http.body.MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NonNull UriRouteInfo o)
String[]	getArgumentNames()
ExecutorService	getExecutor(io.micronaut.scheduling.executor.ThreadSelection threadSelection)
Optional<io.micronaut.core.type.Argument<?>>	getFullRequestBodyType()	Like RouteInfo.getRequestBodyType(), but excludes body arguments that may match only a part of the body (i.e.
io.micronaut.http.HttpMethod	getHttpMethod()
final io.micronaut.http.body.MessageBodyReader<?>	getMessageBodyReader()
Integer	getPort()
Optional<io.micronaut.core.type.Argument<?>>	getRequestBodyType()
io.micronaut.inject.MethodExecutionHandle<T,R>	getTargetMethod()
io.micronaut.http.uri.UriMatchTemplate	getUriMatchTemplate()
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()
io.micronaut.http.bind.binders.RequestArgumentBinder<Object>[]	resolveArgumentBinders(io.micronaut.http.bind.RequestBinderRegistry requestBinderRegistry)
String	toString()
UriRouteMatch<T,R>	tryMatch(@NonNull String uri)	Match this route within the given URI and produce a RouteMatch if a match is found.

Methods inherited from class io.micronaut.web.router.DefaultRequestMatcher

matching

Methods inherited from class io.micronaut.web.router.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 java.lang.Object

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

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

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

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

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

Methods inherited from interface io.micronaut.web.router.MethodBasedRouteInfo

getArgumentNames, getTargetMethod, resolveArgumentBinders

Methods inherited from interface io.micronaut.web.router.RequestMatcher

matching

Methods inherited from interface io.micronaut.web.router.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 io.micronaut.web.router.UriRouteInfo

getHttpMethodName, match, tryMatch

Constructor Details

DefaultUrlRouteInfo

public DefaultUrlRouteInfo(io.micronaut.http.HttpMethod httpMethod,
 io.micronaut.http.uri.UriMatchTemplate uriMatchTemplate,
 Charset defaultCharset,
 io.micronaut.inject.MethodExecutionHandle<T,R> targetMethod,
 @Nullable
 @Nullable String bodyArgumentName,
 @Nullable
 @Nullable io.micronaut.core.type.Argument<?> bodyArgument,
 List<io.micronaut.http.MediaType> consumesMediaTypes,
 List<io.micronaut.http.MediaType> producesMediaTypes,
 List<Predicate<io.micronaut.http.HttpRequest<?>>> predicates,
 Integer port,
 io.micronaut.core.convert.ConversionService conversionService,
 io.micronaut.scheduling.executor.ExecutorSelector executorSelector,
 io.micronaut.http.body.MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Method Details

getHttpMethod

public io.micronaut.http.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface UriRouteInfo<T,R>

Returns:

The HTTP method for this route

getUriMatchTemplate

public io.micronaut.http.uri.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 io.micronaut.http.uri.UriMatcher

Specified by:

match in interface UriRouteInfo<T,R>

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

tryMatch

public UriRouteMatch<T,R> tryMatch(@NonNull
 @NonNull 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 Integer getPort()

Specified by:

getPort in interface UriRouteInfo<T,R>

Returns:

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

compareTo

public int compareTo(@NonNull
 @NonNull UriRouteInfo o)

Specified by:

compareTo in interface Comparable<T>

toString

public String toString()

Overrides:

toString in class Object

getExecutor

public ExecutorService getExecutor(io.micronaut.scheduling.executor.ThreadSelection threadSelection)

Specified by:

getExecutor in interface RouteInfo<T>

Overrides:

getExecutor in class DefaultRouteInfo<R>

Parameters:

threadSelection - The thread selection

Returns:

The route executor

getMessageBodyReader

public final io.micronaut.http.body.MessageBodyReader<?> getMessageBodyReader()

Specified by:

getMessageBodyReader in interface RouteInfo<T>

Returns:

The message body reader. if any.

resolveArgumentBinders

public io.micronaut.http.bind.binders.RequestArgumentBinder<Object>[] resolveArgumentBinders(io.micronaut.http.bind.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 io.micronaut.inject.MethodExecutionHandle<T,R> getTargetMethod()

Specified by:

getTargetMethod in interface MethodBasedRouteInfo<T,R>

Returns:

The MethodExecutionHandle

getRequestBodyType

public Optional<io.micronaut.core.type.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<io.micronaut.core.type.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