Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addFilter(String, BeanLocator, BeanDefinition<? extends HttpFilter>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- addFilter(String, BeanLocator, BeanDefinition<? extends HttpFilter>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Add a filter.
- AnnotatedFilterRouteBuilder - Class in io.micronaut.web.router
-
An
ExecutableMethodProcessorfor theFilterannotation. - AnnotatedFilterRouteBuilder(ExecutionHandleLocator, RouteBuilder.UriNamingStrategy, ConversionService, ServerContextPathProvider) - Constructor for class io.micronaut.web.router.AnnotatedFilterRouteBuilder
-
Constructor.
- AnnotatedMethodRouteBuilder - Class in io.micronaut.web.router
-
Responsible for building
Routeinstances for the annotations found in theio.micronaut.http.annotationpackage. - AnnotatedMethodRouteBuilder(ExecutionHandleLocator, RouteBuilder.UriNamingStrategy, ConversionService) - Constructor for class io.micronaut.web.router.AnnotatedMethodRouteBuilder
- annotationMetadata - Variable in class io.micronaut.web.router.DefaultRouteInfo
- applyDefaultPorts(List<Integer>) - Method in class io.micronaut.web.router.DefaultRouter
- applyDefaultPorts(List<Integer>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- applyDefaultPorts(List<Integer>) - Method in interface io.micronaut.web.router.Router
-
Sets the ports the application will listen to by default.
B
- body(Argument<?>) - Method in interface io.micronaut.web.router.Route
-
The name of the argument to the route that is the request body.
- body(String) - Method in interface io.micronaut.web.router.Route
-
The name of the argument to the route that is the request body.
- body(String) - Method in interface io.micronaut.web.router.UriRoute
- build(List<StaticResourceConfiguration>) - Method in class io.micronaut.web.router.resource.StaticResourceResolverFactory
-
Builds the
StaticResourceResolverinstance. - buildBeanRoute(String, HttpMethod, String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
-
A special case that is required for non-standard http methods.
- buildRoute(HttpMethod, String, MethodExecutionHandle<Object, Object>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
-
Build a route.
- buildRoute(HttpMethod, String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
-
Build a route.
C
- call() - Method in interface io.micronaut.web.router.RouteMatch
-
Same as
RouteMatch.execute(). - CAMEL_CASE_NAMING_STRATEGY - Static variable in class io.micronaut.web.router.DefaultRouteBuilder
-
A
RouteBuilder.UriNamingStrategywhereby camel case conventions are used. - compareTo(UriRouteInfo) - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- ConfigurableUriNamingStrategy - Class in io.micronaut.web.router.naming
-
The configurable
RouteBuilder.UriNamingStrategyif property "micronaut.server.context-path" has been set. - ConfigurableUriNamingStrategy(String) - Constructor for class io.micronaut.web.router.naming.ConfigurableUriNamingStrategy
-
Constructs a new uri naming strategy for the given property.
- ConfigurationDefaultVersionProvider - Class in io.micronaut.web.router.version
-
Implementation of
DefaultVersionProviderwhich uses configuration. - ConfigurationDefaultVersionProvider(RoutesVersioningConfiguration) - Constructor for class io.micronaut.web.router.version.ConfigurationDefaultVersionProvider
- consumes(MediaType...) - Method in interface io.micronaut.web.router.ErrorRoute
- consumes(MediaType...) - Method in interface io.micronaut.web.router.ResourceRoute
-
Accept the given media type.
- consumes(MediaType...) - Method in interface io.micronaut.web.router.Route
-
Applies the given accepted media type the route.
- consumes(MediaType...) - Method in interface io.micronaut.web.router.StatusRoute
- consumes(MediaType...) - Method in interface io.micronaut.web.router.UriRoute
- consumesAll() - Method in interface io.micronaut.web.router.Route
-
Accept all
MediaTypereferences. - consumesAll() - Method in interface io.micronaut.web.router.UriRoute
- ConsumesMediaTypeQualifier<T> - Class in io.micronaut.web.router.qualifier
-
A
BeanQualifierthat qualifies based on the value of the media type defined in theConsumesannotation. - ConsumesMediaTypeQualifier(MediaType) - Constructor for class io.micronaut.web.router.qualifier.ConsumesMediaTypeQualifier
- consumesMediaTypes - Variable in class io.micronaut.web.router.DefaultRouteInfo
- consumesMediaTypesContainsAll - Variable in class io.micronaut.web.router.DefaultRouteInfo
- conversionService - Variable in class io.micronaut.web.router.DefaultRouteBuilder
- create(Argument<?>) - Static method in exception io.micronaut.web.router.exceptions.UnsatisfiedRouteException
-
Creates a specialized UnsatisfiedRouteException given the provided argument.
D
- declaringType - Variable in class io.micronaut.web.router.DefaultRouteInfo
- DEFAULT_ENABLED - Static variable in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
The default enable value.
- DEFAULT_HEADER_NAME - Static variable in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
- DEFAULT_MAPPING - Static variable in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
The default mapping value.
- DEFAULT_PARAMETER_NAME - Static variable in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
- DEFAULT_PRODUCES - Static variable in interface io.micronaut.web.router.Route
-
The default media type produced by routes.
- DEFAULT_PRODUCES - Static variable in interface io.micronaut.web.router.RouteInfo
-
The default media type produced by routes.
- defaultCharset - Variable in class io.micronaut.web.router.DefaultRouteBuilder
- DefaultErrorRouteInfo<T,
R> - Class in io.micronaut.web.router -
The default error route info implementation.
- DefaultErrorRouteInfo(Class<?>, Class<? extends Throwable>, MethodExecutionHandle<T, R>, String, Argument<?>, List<MediaType>, List<MediaType>, List<Predicate<HttpRequest<?>>>, ConversionService, MessageBodyHandlerRegistry) - Constructor for class io.micronaut.web.router.DefaultErrorRouteInfo
- DefaultRequestMatcher<T,
R> - Class in io.micronaut.web.router -
The default
RequestMatcherimplementation. - DefaultRequestMatcher(MethodExecutionHandle<T, R>, Argument<?>, String, List<MediaType>, List<MediaType>, boolean, boolean, List<Predicate<HttpRequest<?>>>, MessageBodyHandlerRegistry) - Constructor for class io.micronaut.web.router.DefaultRequestMatcher
- DefaultRouteBuilder - Class in io.micronaut.web.router
-
A DefaultRouteBuilder implementation for building roots.
- DefaultRouteBuilder(ExecutionHandleLocator) - Constructor for class io.micronaut.web.router.DefaultRouteBuilder
- DefaultRouteBuilder(ExecutionHandleLocator, RouteBuilder.UriNamingStrategy) - Constructor for class io.micronaut.web.router.DefaultRouteBuilder
- DefaultRouteBuilder(ExecutionHandleLocator, RouteBuilder.UriNamingStrategy, ConversionService) - Constructor for class io.micronaut.web.router.DefaultRouteBuilder
- DefaultRouteInfo<R> - Class in io.micronaut.web.router
-
The default route info implementation.
- DefaultRouteInfo(AnnotationMetadata, ReturnType<? extends R>, List<MediaType>, List<MediaType>, Class<?>, boolean, boolean, MessageBodyHandlerRegistry) - Constructor for class io.micronaut.web.router.DefaultRouteInfo
- DefaultRouteInfo(ReturnType<? extends R>, Class<?>, boolean, boolean) - Constructor for class io.micronaut.web.router.DefaultRouteInfo
- DefaultRouter - Class in io.micronaut.web.router
-
The default
Routerimplementation. - DefaultRouter(RouteBuilder...) - Constructor for class io.micronaut.web.router.DefaultRouter
-
Construct a new router for the given route builders.
- DefaultRouter(Collection<RouteBuilder>) - Constructor for class io.micronaut.web.router.DefaultRouter
-
Construct a new router for the given route builders.
- DefaultStatusRouteInfo<T,
R> - Class in io.micronaut.web.router -
The default
StatusRouteInfoimplementation. - DefaultStatusRouteInfo(Class<?>, HttpStatus, MethodExecutionHandle<T, R>, String, Argument<?>, List<MediaType>, List<MediaType>, List<Predicate<HttpRequest<?>>>, ConversionService, MessageBodyHandlerRegistry) - Constructor for class io.micronaut.web.router.DefaultStatusRouteInfo
- DefaultUrlRouteInfo<T,
R> - Class in io.micronaut.web.router -
The default
UriRouteInfoimplementation. - DefaultUrlRouteInfo(HttpMethod, UriMatchTemplate, Charset, MethodExecutionHandle<T, R>, String, Argument<?>, List<MediaType>, List<MediaType>, List<Predicate<HttpRequest<?>>>, Integer, ConversionService, ExecutorSelector, MessageBodyHandlerRegistry) - Constructor for class io.micronaut.web.router.DefaultUrlRouteInfo
- DefaultVersionProvider - Interface in io.micronaut.web.router.version
-
Defines a provider of a default Version.
- definedStatus - Variable in class io.micronaut.web.router.DefaultRouteInfo
- DELETE(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- DELETE(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.DELETEmethod and the given URI. - DELETE(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- DELETE(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- DELETE(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- DELETE(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- DELETE(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- DELETE(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- DELETE(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- DELETE(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- DELETE(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- DELETE(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP DELETE.
- DELETE(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- DELETE(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- doesConsume(MediaType) - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the specified content type is an accepted type.
- doesConsume(MediaType) - Method in class io.micronaut.web.router.DefaultRouteInfo
- doesProduce(MediaType) - Method in class io.micronaut.web.router.DefaultRouteInfo
- doesProduce(MediaType) - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the route does produce any of the given types.
- doesProduce(Collection<MediaType>) - Method in class io.micronaut.web.router.DefaultRouteInfo
- doesProduce(Collection<MediaType>) - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the route does produce any of the given types.
- DuplicateRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when multiple routes match a given URI.
- DuplicateRouteException(String, List<UriRouteMatch<Object, Object>>) - Constructor for exception io.micronaut.web.router.exceptions.DuplicateRouteException
E
- EMPTY - Static variable in class io.micronaut.web.router.resource.StaticResourceResolver
-
An empty resolver to use as a constant.
- equals(Object) - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- equals(Object) - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- equals(Object) - Method in class io.micronaut.web.router.qualifier.ConsumesMediaTypeQualifier
- equals(Object) - Method in class io.micronaut.web.router.qualifier.ProducesMediaTypeQualifier
- error(Class<?>, Class<? extends Throwable>, Class<?>, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- error(Class<?>, Class<? extends Throwable>, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- error(Class<? extends Throwable>, Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- error(Class<? extends Throwable>, Class<?>, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- error(Class<? extends Throwable>, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- error(Class<? extends Throwable>, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- error(Class<? extends Throwable>, Object, String) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- error(Class<? extends Throwable>, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the error.
- ErrorRoute - Interface in io.micronaut.web.router
-
Represents a
Routethat matches an exception. - ErrorRouteInfo<T,
R> - Interface in io.micronaut.web.router -
Represents a
Routethat matches an exception. - exceptionType() - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- exceptionType() - Method in interface io.micronaut.web.router.ErrorRoute
- exceptionType() - Method in interface io.micronaut.web.router.ErrorRouteInfo
- exclude(HttpMethod...) - Method in interface io.micronaut.web.router.ResourceRoute
-
Exclude a particular HTTP method from this resource route.
- execute() - Method in interface io.micronaut.web.router.RouteMatch
-
Execute the route with the given values.
- executionHandleLocator - Variable in class io.micronaut.web.router.DefaultRouteBuilder
- explicitlyConsumes(MediaType) - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the specified content type is explicitly an accepted type.
- explicitlyConsumes(MediaType) - Method in class io.micronaut.web.router.DefaultRouteInfo
- explicitlyProduces(MediaType) - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the specified content type is explicitly a producing type.
- explicitlyProduces(MediaType) - Method in class io.micronaut.web.router.DefaultRouteInfo
- exposedPort(int) - Method in interface io.micronaut.web.router.UriRoute
-
The exposed port that the route applies to.
F
- filter(HttpRequest<?>) - Method in interface io.micronaut.web.router.filter.RouteMatchFilter
-
A method responsible for filtering route matches based on request.
- filter(HttpRequest<?>) - Method in class io.micronaut.web.router.version.RouteVersionFilter
-
Filters route matches by specified version.
- FilteredRouter - Class in io.micronaut.web.router.filter
-
Allows decorating an existing
Routerwith filtering capabilities. - FilteredRouter(Router, RouteMatchFilter) - Constructor for class io.micronaut.web.router.filter.FilteredRouter
-
Creates a decorated router for an existing router and
RouteMatchFilter. - FilterRoute - Interface in io.micronaut.web.router
-
A filter route is a route that matches an
HttpFilter. - find(HttpMethod, CharSequence, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- find(HttpMethod, CharSequence, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- find(HttpMethod, CharSequence, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Finds all possible routes for the given HTTP method and URI.
- find(HttpMethod, URI, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Finds all possible routes for the given HTTP method and URI.
- find(HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- find(HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- find(HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Finds all possible routes for the given HTTP request.
- find(HttpRequest<?>, CharSequence) - Method in class io.micronaut.web.router.DefaultRouter
- find(HttpRequest<?>, CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- find(HttpRequest<?>, CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find method, that should be used for non-standard http methods.
- findAllClosest(HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findAllClosest(HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findAllClosest(HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Finds the closest match for the given request.
- findAny(HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Find any
RouteMatchregardless of HTTP method. - findAny(CharSequence, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findAny(CharSequence, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findAny(CharSequence, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Find any
RouteMatchregardless of HTTP method. - findAny(HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findAny(HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findClosest(HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Finds the closest match for the given request or null if none is found.
- findErrorRoute(Class<?>, Throwable, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findErrorRoute(Class<?>, Throwable, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findErrorRoute(Class<?>, Throwable, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Match a route to an error.
- findErrorRoute(Throwable, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findErrorRoute(Throwable, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findErrorRoute(Throwable, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Match a route to an error.
- findFilters(HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findFilters(HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findFilters(HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Build a filtered
Publisherfor an action. - findRouteMatch(HttpRequest<?>) - Static method in class io.micronaut.web.router.RouteMatchUtils
- findStatus(HttpStatus) - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- findStatus(HttpStatus) - Method in class io.micronaut.web.router.DefaultRouteInfo
- findStatus(HttpStatus) - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- findStatus(HttpStatus) - Method in interface io.micronaut.web.router.RouteInfo
-
Finds predefined route http status or uses default.
- findStatusRoute(HttpStatus, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findStatusRoute(HttpStatus, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findStatusRoute(HttpStatus, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Found a
RouteMatchfor the givenHttpStatuscode. - findStatusRoute(Class<?>, HttpStatus, HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRouter
- findStatusRoute(Class<?>, HttpStatus, HttpRequest<?>) - Method in class io.micronaut.web.router.filter.FilteredRouter
- findStatusRoute(Class<?>, HttpStatus, HttpRequest<?>) - Method in interface io.micronaut.web.router.Router
-
Found a
RouteMatchfor the givenHttpStatuscode. - fulfill(Map<String, Object>) - Method in interface io.micronaut.web.router.RouteMatch
-
Fulfill argument values.
- fulfillAfterFilters(RequestBinderRegistry, HttpRequest<?>) - Method in interface io.micronaut.web.router.RouteMatch
-
Attempt to satisfy the arguments of the given route with the data from the given request.
- fulfillBeforeFilters(RequestBinderRegistry, HttpRequest<?>) - Method in interface io.micronaut.web.router.RouteMatch
-
Attempt to satisfy the arguments of the given route with the data from the given request.
G
- GET(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- GET(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.GETmethod and the given URI. - GET(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- GET(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- GET(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- GET(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- GET(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- GET(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- GET(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- GET(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- GET(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- GET(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP GET.
- GET(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- GET(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- getAnnotationMetadata() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getArgument() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedRouteException
- getArgumentNames() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- getArgumentNames() - Method in interface io.micronaut.web.router.MethodBasedRouteInfo
- getBodyArgument() - Method in interface io.micronaut.web.router.RouteInfo
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getBodyType() - Method in interface io.micronaut.web.router.RouteInfo
-
Deprecated, for removal: This API element is subject to removal in a future version.Use
RouteInfo.getResponseBodyType()instead - getBodyVariableName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedBodyRouteException
- getConsumes() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getConsumes() - Method in interface io.micronaut.web.router.Route
-
The media types able to produced by this route.
- getConsumes() - Method in interface io.micronaut.web.router.RouteInfo
-
The media types able to produced by this route.
- getCookieName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedCookieValueRouteException
- getDeclaringType() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getDeclaringType() - Method in interface io.micronaut.web.router.RouteInfo
- getDefaultVersion() - Method in class io.micronaut.web.router.version.RoutesVersioningConfiguration
- getErrorRoutes() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getErrorRoutes() - Method in interface io.micronaut.web.router.RouteBuilder
- getExecutor(ThreadSelection) - Method in interface io.micronaut.web.router.RouteInfo
- getExecutor(ThreadSelection) - Method in class io.micronaut.web.router.DefaultRouteInfo
- getExecutor(ThreadSelection) - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- getExposedPorts() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getExposedPorts() - Method in class io.micronaut.web.router.DefaultRouter
- getExposedPorts() - Method in class io.micronaut.web.router.filter.FilteredRouter
- getExposedPorts() - Method in interface io.micronaut.web.router.RouteBuilder
- getExposedPorts() - Method in interface io.micronaut.web.router.Router
- getFilter() - Method in interface io.micronaut.web.router.FilterRoute
- getFilterRoutes() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getFilterRoutes() - Method in interface io.micronaut.web.router.RouteBuilder
- getFullRequestBodyType() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- getFullRequestBodyType() - Method in interface io.micronaut.web.router.RouteInfo
-
Like
RouteInfo.getRequestBodyType(), but excludes body arguments that may match only a part of the body (i.e. - getHeaderName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedHeaderRouteException
- getHttpMethod() - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- getHttpMethod() - Method in interface io.micronaut.web.router.UriRoute
- getHttpMethod() - Method in interface io.micronaut.web.router.UriRouteInfo
- getHttpMethod() - Method in interface io.micronaut.web.router.UriRouteMatch
- getHttpMethodName() - Method in interface io.micronaut.web.router.UriRoute
- getHttpMethodName() - Method in interface io.micronaut.web.router.UriRouteInfo
- getMapping() - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
The static resource mapping.
- getMessageBodyReader() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- getMessageBodyReader() - Method in interface io.micronaut.web.router.RouteInfo
- getMessageBodyWriter() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getMessageBodyWriter() - Method in interface io.micronaut.web.router.RouteInfo
- getNames() - Method in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
- getNames() - Method in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
- getPartName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedPartRouteException
- getPathVariableName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedPathVariableRouteException
- getPort() - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- getPort() - Method in interface io.micronaut.web.router.UriRoute
- getPort() - Method in interface io.micronaut.web.router.UriRouteInfo
- getProduces() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getProduces() - Method in interface io.micronaut.web.router.Route
-
The media types able to produced by this route.
- getProduces() - Method in interface io.micronaut.web.router.RouteInfo
-
The media types able to produced by this route.
- getQueryParameterName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedQueryValueRouteException
- getRequestAttributeName() - Method in exception io.micronaut.web.router.exceptions.UnsatisfiedRequestAttributeRouteException
- getRequestBodyType() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- getRequestBodyType() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getRequestBodyType() - Method in interface io.micronaut.web.router.RouteInfo
- getRequiredArguments() - Method in interface io.micronaut.web.router.MethodBasedRouteMatch
-
Returns the required arguments for this RouteMatch.
- getRequiredArguments() - Method in interface io.micronaut.web.router.RouteMatch
-
Returns the required arguments for this RouteMatch.
- getRequiredArguments() - Method in interface io.micronaut.web.router.UriRouteMatch
-
Returns the required arguments for this RouteMatch.
- getRequiredInput(String) - Method in interface io.micronaut.web.router.RouteMatch
-
Return whether the given named input is required by this route.
- getResourceLoaders() - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
- getResponseBodyType() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getResponseBodyType() - Method in interface io.micronaut.web.router.RouteInfo
- getReturnType() - Method in class io.micronaut.web.router.DefaultRouteInfo
- getReturnType() - Method in interface io.micronaut.web.router.RouteInfo
- getRouteInfo() - Method in interface io.micronaut.web.router.RouteMatch
- getRouteInfo() - Method in interface io.micronaut.web.router.UriRouteMatch
- getStatusRoutes() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getStatusRoutes() - Method in interface io.micronaut.web.router.RouteBuilder
- getTargetMethod() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- getTargetMethod() - Method in interface io.micronaut.web.router.MethodBasedRouteInfo
- getUri() - Method in exception io.micronaut.web.router.exceptions.DuplicateRouteException
- getUriMatchTemplate() - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- getUriMatchTemplate() - Method in interface io.micronaut.web.router.UriRoute
- getUriMatchTemplate() - Method in interface io.micronaut.web.router.UriRouteInfo
- getUriNamingStrategy() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getUriNamingStrategy() - Method in interface io.micronaut.web.router.RouteBuilder
- getUriRoutes() - Method in class io.micronaut.web.router.DefaultRouteBuilder
- getUriRoutes() - Method in exception io.micronaut.web.router.exceptions.DuplicateRouteException
- getUriRoutes() - Method in interface io.micronaut.web.router.RouteBuilder
- getVariableValues() - Method in interface io.micronaut.web.router.RouteMatch
- getVersion(UriRouteMatch<T, R>) - Method in class io.micronaut.web.router.version.RouteVersionFilter
H
- hashCode() - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- hashCode() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- hashCode() - Method in class io.micronaut.web.router.qualifier.ConsumesMediaTypeQualifier
- hashCode() - Method in class io.micronaut.web.router.qualifier.ProducesMediaTypeQualifier
- HEAD(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- HEAD(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.HEADmethod and the given URI. - HEAD(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- HEAD(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- HEAD(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- HEAD(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- HEAD(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- HEAD(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- HEAD(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- HEAD(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- HEAD(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- HEAD(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP GET.
- HEAD(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- HEAD(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- HeaderVersionResolver - Class in io.micronaut.web.router.version.resolution
-
A
RequestVersionResolverresponsible for extracting version fromHttpHeaders. - HeaderVersionResolver(HeaderVersionResolverConfiguration) - Constructor for class io.micronaut.web.router.version.resolution.HeaderVersionResolver
-
Creates a
RequestVersionResolverto extract version from request header. - HeaderVersionResolverConfiguration - Class in io.micronaut.web.router.version.resolution
-
Configuration for version resolution via headers.
- HeaderVersionResolverConfiguration() - Constructor for class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
- HyphenatedUriNamingStrategy - Class in io.micronaut.web.router.naming
-
The default
RouteBuilder.UriNamingStrategyif none is provided by the application. - HyphenatedUriNamingStrategy() - Constructor for class io.micronaut.web.router.naming.HyphenatedUriNamingStrategy
I
- ID - Static variable in interface io.micronaut.web.router.RouteBuilder
-
Used to signify to the route that the ID of the resource is used.
- io.micronaut.web.router - package io.micronaut.web.router
-
Route based method matching classes derived from URIs.
- io.micronaut.web.router.exceptions - package io.micronaut.web.router.exceptions
-
Route exceptions.
- io.micronaut.web.router.filter - package io.micronaut.web.router.filter
- io.micronaut.web.router.naming - package io.micronaut.web.router.naming
-
Route based naming strategies.
- io.micronaut.web.router.qualifier - package io.micronaut.web.router.qualifier
-
Qualifiers based on type.
- io.micronaut.web.router.resource - package io.micronaut.web.router.resource
-
Route resource and configuration.
- io.micronaut.web.router.version - package io.micronaut.web.router.version
-
Stores classes related to versioning routes.
- io.micronaut.web.router.version.resolution - package io.micronaut.web.router.version.resolution
-
Classes related to routes' versioning resolution.
- isAsync() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isAsync() - Method in interface io.micronaut.web.router.RouteInfo
- isAsyncOrReactive() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isAsyncOrReactive() - Method in interface io.micronaut.web.router.RouteInfo
- isCompletable() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isCompletable() - Method in interface io.micronaut.web.router.RouteInfo
- isEnabled() - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
- isEnabled() - Method in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
- isEnabled() - Method in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
- isEnabled() - Method in class io.micronaut.web.router.version.RoutesVersioningConfiguration
- isErrorRoute() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isErrorRoute() - Method in interface io.micronaut.web.router.RouteInfo
- isFulfilled() - Method in interface io.micronaut.web.router.RouteMatch
- isPermitsRequestBody() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isPermitsRequestBody() - Method in interface io.micronaut.web.router.RouteInfo
-
Whether the route permits a request body.
- isReactive() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isReactive() - Method in interface io.micronaut.web.router.RouteInfo
- isResponseBodyJsonFormattable() - Method in interface io.micronaut.web.router.RouteInfo
-
Is the response body json formattable.
- isSatisfied(String) - Method in interface io.micronaut.web.router.RouteMatch
-
Is the given input satisfied.
- isSingleResult() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isSingleResult() - Method in interface io.micronaut.web.router.RouteInfo
- isSpecifiedSingle() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isSpecifiedSingle() - Method in interface io.micronaut.web.router.RouteInfo
- isSuspended() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isSuspended() - Method in interface io.micronaut.web.router.RouteInfo
- isVoid() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- isVoid() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isVoid() - Method in interface io.micronaut.web.router.RouteInfo
- isWebSocketRoute - Variable in class io.micronaut.web.router.DefaultRouteInfo
- isWebSocketRoute() - Method in class io.micronaut.web.router.DefaultRouteInfo
- isWebSocketRoute() - Method in interface io.micronaut.web.router.RouteInfo
-
Checks if route is for web socket.
L
- LOG - Static variable in class io.micronaut.web.router.DefaultRouteBuilder
M
- match(HttpMethod, URI) - Method in interface io.micronaut.web.router.FilterRoute
-
Matches the given path to this filter route.
- match(HttpStatus) - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- match(HttpStatus) - Method in interface io.micronaut.web.router.StatusRouteInfo
-
Match the given HTTP status.
- match(Class<?>, HttpStatus) - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- match(Class<?>, HttpStatus) - Method in interface io.micronaut.web.router.StatusRouteInfo
-
Match the given HTTP status.
- match(Class<?>, Throwable) - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- match(Class<?>, Throwable) - Method in interface io.micronaut.web.router.ErrorRouteInfo
-
Match the given exception.
- match(String) - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- match(String) - Method in interface io.micronaut.web.router.UriRouteInfo
-
Match this route within the given URI and produce a
RouteMatchif a match is found. - match(Throwable) - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- match(Throwable) - Method in interface io.micronaut.web.router.ErrorRouteInfo
-
Match the given exception.
- match(URI) - Method in interface io.micronaut.web.router.UriRouteInfo
-
Match this route within the given URI and produce a
RouteMatchif a match is found. - matchIfRouteIsNotVersioned(HttpRequest<?>, String) - Method in class io.micronaut.web.router.version.RouteVersionFilter
- matchIfRouteIsVersioned(HttpRequest<?>, String, String) - Method in class io.micronaut.web.router.version.RouteVersionFilter
- matching(HttpRequest<?>) - Method in class io.micronaut.web.router.DefaultRequestMatcher
- matching(HttpRequest<?>) - Method in interface io.micronaut.web.router.RequestMatcher
-
Match the given request.
- MethodBasedRouteInfo<T,
R> - Interface in io.micronaut.web.router -
Represents a route that is backed by a method.
- MethodBasedRouteMatch<T,
R> - Interface in io.micronaut.web.router -
Match a route based on a method.
- methods(HttpMethod...) - Method in interface io.micronaut.web.router.FilterRoute
-
Restrict the methods this filter route matches.
N
- needsRequestBody() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- needsRequestBody() - Method in class io.micronaut.web.router.DefaultRouteInfo
- needsRequestBody() - Method in interface io.micronaut.web.router.RouteInfo
- nest(Runnable) - Method in interface io.micronaut.web.router.ErrorRoute
- nest(Runnable) - Method in interface io.micronaut.web.router.ResourceRoute
-
Nest more routes within this
ResourceRoute. - nest(Runnable) - Method in interface io.micronaut.web.router.Route
-
Defines routes nested within this route.
- nest(Runnable) - Method in interface io.micronaut.web.router.StatusRoute
- nest(Runnable) - Method in interface io.micronaut.web.router.UriRoute
-
Defines routes nested within this route.
- normalizeUri(String) - Method in interface io.micronaut.web.router.RouteBuilder.UriNamingStrategy
-
Normalizes a URI.
O
- onCreated(BeanCreatedEvent<Router>) - Method in class io.micronaut.web.router.version.VersionAwareRouterListener
-
Returns a wrapped
RoutertoFilteredRouter. - OPTIONS(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- OPTIONS(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.OPTIONSmethod and the given URI. - OPTIONS(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- OPTIONS(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- OPTIONS(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- OPTIONS(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- OPTIONS(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- OPTIONS(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- OPTIONS(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- OPTIONS(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- OPTIONS(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- OPTIONS(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP OPTIONS.
- OPTIONS(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- OPTIONS(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- originatingType() - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- originatingType() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- originatingType() - Method in interface io.micronaut.web.router.ErrorRoute
- originatingType() - Method in interface io.micronaut.web.router.ErrorRouteInfo
- originatingType() - Method in interface io.micronaut.web.router.StatusRoute
- originatingType() - Method in interface io.micronaut.web.router.StatusRouteInfo
P
- ParameterVersionResolver - Class in io.micronaut.web.router.version.resolution
-
A
RequestVersionResolverresponsible for extracting version fromHttpParameters. - ParameterVersionResolver(ParameterVersionResolverConfiguration) - Constructor for class io.micronaut.web.router.version.resolution.ParameterVersionResolver
-
Creates a
RequestVersionResolverto extract version from request parameter. - ParameterVersionResolverConfiguration - Class in io.micronaut.web.router.version.resolution
-
Configuration for version resolution via request parameters.
- ParameterVersionResolverConfiguration() - Constructor for class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
- PATCH(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- PATCH(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.PATCHmethod and the given URI. - PATCH(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- PATCH(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- PATCH(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- PATCH(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- PATCH(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PATCH(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PATCH(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PATCH(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PATCH(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PATCH(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP PATCH.
- PATCH(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PATCH(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- pattern(String) - Method in interface io.micronaut.web.router.FilterRoute
-
Add an addition pattern to this filter route.
- patternStyle(FilterPatternStyle) - Method in interface io.micronaut.web.router.FilterRoute
-
Sets the pattern style that this filter route matches.
- POST(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- POST(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.POSTmethod and the given URI. - POST(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- POST(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- POST(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- POST(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- POST(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- POST(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- POST(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- POST(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- POST(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- POST(String, Object, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP POST.
- POST(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- POST(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PREFIX - Static variable in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
The prefix for static resources configuration.
- PREFIX - Static variable in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
- PREFIX - Static variable in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
- PREFIX - Static variable in class io.micronaut.web.router.version.RoutesVersioningConfiguration
-
The configuration property.
- process(BeanDefinition<?>, BeanContext) - Method in class io.micronaut.web.router.AnnotatedFilterRouteBuilder
- process(BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.AnnotatedMethodRouteBuilder
- process(BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.ServerFilterRouteBuilder
- produces(MediaType...) - Method in interface io.micronaut.web.router.ErrorRoute
- produces(MediaType...) - Method in interface io.micronaut.web.router.ResourceRoute
- produces(MediaType...) - Method in interface io.micronaut.web.router.Route
-
Applies the given accepted media type the route.
- produces(MediaType...) - Method in interface io.micronaut.web.router.UriRoute
- ProducesMediaTypeQualifier<T> - Class in io.micronaut.web.router.qualifier
-
A
BeanQualifierthat qualifies based on the value of the media type defined in theProducesannotation. - ProducesMediaTypeQualifier(MediaType) - Constructor for class io.micronaut.web.router.qualifier.ProducesMediaTypeQualifier
- producesMediaTypes - Variable in class io.micronaut.web.router.DefaultRouteInfo
- producesMediaTypesContainsAll - Variable in class io.micronaut.web.router.DefaultRouteInfo
- PUT(CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- PUT(CharSequence) - Method in interface io.micronaut.web.router.Router
-
Find the first
RouteMatchroute for anHttpMethod.PUTmethod and the given URI. - PUT(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- PUT(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- PUT(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- PUT(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- PUT(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PUT(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PUT(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PUT(String, Class<?>, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PUT(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- PUT(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP PUT.
- PUT(String, Object, String, Class<?>...) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- PUT(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
R
- readOnly(boolean) - Method in interface io.micronaut.web.router.ResourceRoute
-
Whether the route is read-only.
- reduce(Class<T>, Stream<BT>) - Method in class io.micronaut.web.router.qualifier.ConsumesMediaTypeQualifier
- reduce(Class<T>, Stream<BT>) - Method in class io.micronaut.web.router.qualifier.ProducesMediaTypeQualifier
- RequestMatcher - Interface in io.micronaut.web.router
-
Route with a request predicate.
- RequestVersionResolver - Interface in io.micronaut.web.router.version.resolution
-
Interface responsible for extracting request version from
HttpRequest. - resolve(HttpRequest<?>) - Method in class io.micronaut.web.router.version.resolution.HeaderVersionResolver
- resolve(HttpRequest<?>) - Method in class io.micronaut.web.router.version.resolution.ParameterVersionResolver
- resolve(String) - Method in class io.micronaut.web.router.resource.StaticResourceResolver
-
Resolves a path to a URL.
- resolve(T) - Method in interface io.micronaut.web.router.version.resolution.VersionResolver
-
Resolves a version from a given object.
- resolveArgumentBinders(RequestBinderRegistry) - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- resolveArgumentBinders(RequestBinderRegistry) - Method in interface io.micronaut.web.router.MethodBasedRouteInfo
- resolveDefaultVersion() - Method in class io.micronaut.web.router.version.ConfigurationDefaultVersionProvider
- resolveDefaultVersion() - Method in interface io.micronaut.web.router.version.DefaultVersionProvider
- resolveFilterEntries(RouteMatch<?>) - Method in class io.micronaut.web.router.DefaultRouter
- resolveFilters(HttpRequest<?>, List<HttpFilterResolver.FilterEntry>) - Method in class io.micronaut.web.router.DefaultRouter
- resolveUri(BeanDefinition<?>) - Method in class io.micronaut.web.router.naming.ConfigurableUriNamingStrategy
- resolveUri(BeanDefinition<?>) - Method in class io.micronaut.web.router.naming.HyphenatedUriNamingStrategy
- resolveUri(BeanDefinition<?>) - Method in interface io.micronaut.web.router.RouteBuilder.UriNamingStrategy
-
Resolve the URI to use for the given type.
- resolveUri(Class) - Method in class io.micronaut.web.router.naming.ConfigurableUriNamingStrategy
- resolveUri(Class) - Method in class io.micronaut.web.router.naming.HyphenatedUriNamingStrategy
- resolveUri(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder.UriNamingStrategy
-
Resolve the URI to use for the given type.
- resolveUri(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder.UriNamingStrategy
-
Resolve the URI to use for the given type and route id.
- resolveUri(Class, PropertyConvention) - Method in class io.micronaut.web.router.naming.ConfigurableUriNamingStrategy
- resolveUri(String) - Method in class io.micronaut.web.router.naming.ConfigurableUriNamingStrategy
- resolveUri(String) - Method in class io.micronaut.web.router.naming.HyphenatedUriNamingStrategy
- resolveUri(String) - Method in interface io.micronaut.web.router.RouteBuilder.UriNamingStrategy
-
Resolve the URI to use for the given type.
- resolveVersion(HttpRequest<?>) - Method in class io.micronaut.web.router.version.RouteVersionFilter
- ResourceRoute - Interface in io.micronaut.web.router
-
A resource route is a composite route to a REST endpoint.
- resources(Class<?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- resources(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Builds the necessary mappings to treat the given class as a REST endpoint.
- resources(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Builds the necessary mappings to treat the given instance as a REST endpoint.
- returnType - Variable in class io.micronaut.web.router.DefaultRouteInfo
- route(HttpMethod, CharSequence) - Method in class io.micronaut.web.router.DefaultRouter
- route(HttpMethod, CharSequence) - Method in class io.micronaut.web.router.filter.FilteredRouter
- route(HttpMethod, CharSequence) - Method in interface io.micronaut.web.router.Router
-
Finds the first possible route for the given HTTP method and URI.
- route(HttpStatus) - Method in class io.micronaut.web.router.DefaultRouter
- route(HttpStatus) - Method in class io.micronaut.web.router.filter.FilteredRouter
- route(HttpStatus) - Method in interface io.micronaut.web.router.Router
-
Found a
RouteMatchfor the givenHttpStatuscode. - route(Class<?>, HttpStatus) - Method in class io.micronaut.web.router.DefaultRouter
- route(Class<?>, HttpStatus) - Method in class io.micronaut.web.router.filter.FilteredRouter
- route(Class<?>, HttpStatus) - Method in interface io.micronaut.web.router.Router
-
Found a
RouteMatchfor the givenHttpStatuscode. - route(Class<?>, Throwable) - Method in class io.micronaut.web.router.DefaultRouter
- route(Class<?>, Throwable) - Method in class io.micronaut.web.router.filter.FilteredRouter
- route(Class<?>, Throwable) - Method in interface io.micronaut.web.router.Router
-
Match a route to an error.
- route(Throwable) - Method in class io.micronaut.web.router.DefaultRouter
- route(Throwable) - Method in class io.micronaut.web.router.filter.FilteredRouter
- route(Throwable) - Method in interface io.micronaut.web.router.Router
-
Match a route to an error.
- Route - Interface in io.micronaut.web.router
-
Represents a Route definition constructed by a
RouteBuilder. - RouteBuilder - Interface in io.micronaut.web.router
-
An interface for classes capable of building HTTP routing information.
- RouteBuilder.UriNamingStrategy - Interface in io.micronaut.web.router
-
A URI naming strategy is used to dictate the default name to use when building a URI for a class.
- RouteInfo<R> - Interface in io.micronaut.web.router
-
Common information shared between route and route match.
- RouteMatch<R> - Interface in io.micronaut.web.router
-
A
Routethat is executable. - RouteMatchFilter - Interface in io.micronaut.web.router.filter
-
A filter responsible for filtering route matches.
- RouteMatchUtils - Class in io.micronaut.web.router
- RouteMatchUtils() - Constructor for class io.micronaut.web.router.RouteMatchUtils
- Router - Interface in io.micronaut.web.router
-
Core Router interface that allows discovery of a route given an HTTP method and URI.
- RoutesVersioningConfiguration - Class in io.micronaut.web.router.version
-
Routes versioning configuration.
- RoutesVersioningConfiguration() - Constructor for class io.micronaut.web.router.version.RoutesVersioningConfiguration
- RouteVersionFilter - Class in io.micronaut.web.router.version
-
Implementation of
RouteMatchFilterresponsible for filtering route matches onVersion. - RouteVersionFilter(List<RequestVersionResolver>, DefaultVersionProvider) - Constructor for class io.micronaut.web.router.version.RouteVersionFilter
- RouteVersionFilter(List<RequestVersionResolver>, DefaultVersionProvider, RoutesVersioningConfiguration, HeaderVersionResolverConfiguration) - Constructor for class io.micronaut.web.router.version.RouteVersionFilter
-
Creates a
RouteVersionFilterwith a collection ofRequestVersionResolver. - RoutingException - Exception in io.micronaut.web.router.exceptions
-
An exception that occurs when building routes.
- RoutingException(String) - Constructor for exception io.micronaut.web.router.exceptions.RoutingException
- RoutingException(String, Throwable) - Constructor for exception io.micronaut.web.router.exceptions.RoutingException
S
- ServerFilterRouteBuilder - Class in io.micronaut.web.router
-
RouteBuilderforServerFilters. - ServerFilterRouteBuilder(ExecutionHandleLocator, RouteBuilder.UriNamingStrategy, ConversionService, BeanContext, ServerContextPathProvider) - Constructor for class io.micronaut.web.router.ServerFilterRouteBuilder
- setDefaultVersion(String) - Method in class io.micronaut.web.router.version.RoutesVersioningConfiguration
-
Sets the version to use if the version cannot be resolved.
- setEnabled(boolean) - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
Sets whether this specific mapping is enabled.
- setEnabled(boolean) - Method in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
-
Sets whether headers should be searched for a version.
- setEnabled(boolean) - Method in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
-
Sets whether parameter should be searched for a version.
- setEnabled(boolean) - Method in class io.micronaut.web.router.version.RoutesVersioningConfiguration
- setMapping(String) - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
The path resources should be served from.
- setNames(List<String>) - Method in class io.micronaut.web.router.version.resolution.HeaderVersionResolverConfiguration
-
Sets which headers should be searched for a version.
- setNames(List<String>) - Method in class io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration
-
Sets which parameter should be searched for a version.
- setPaths(List<String>) - Method in class io.micronaut.web.router.resource.StaticResourceConfiguration
-
A list of paths either starting with `classpath:` or `file:`.
- single(Class<?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- single(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Builds the necessary mappings to treat the given class as a singular REST endpoint.
- single(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Builds the necessary mappings to treat the given instance as a singular REST endpoint.
- StaticResourceConfiguration - Class in io.micronaut.web.router.resource
-
Stores configuration for the loading of static resources.
- StaticResourceConfiguration(ResourceResolver, ServerContextPathProvider) - Constructor for class io.micronaut.web.router.resource.StaticResourceConfiguration
- StaticResourceResolver - Class in io.micronaut.web.router.resource
-
Resolves resources from a set of resource loaders.
- StaticResourceResolverFactory - Class in io.micronaut.web.router.resource
-
A factory for creating the default
StaticResourceResolver. - StaticResourceResolverFactory() - Constructor for class io.micronaut.web.router.resource.StaticResourceResolverFactory
- status() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- status() - Method in interface io.micronaut.web.router.StatusRoute
- status() - Method in interface io.micronaut.web.router.StatusRouteInfo
- status(HttpStatus, Class<?>, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- status(HttpStatus, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the returned status code.
- status(HttpStatus, Object, String) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the returned status code.
- status(Class<?>, HttpStatus, Class<?>, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- status(Class<?>, HttpStatus, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Register a route to handle the returned status code.
- StatusRoute - Interface in io.micronaut.web.router
-
Represents a
Routethat matches a status. - StatusRouteInfo<T,
R> - Interface in io.micronaut.web.router -
Represents a
RouteInfothat matches a status.
T
- toRouteInfo() - Method in interface io.micronaut.web.router.ErrorRoute
- toRouteInfo() - Method in interface io.micronaut.web.router.Route
- toRouteInfo() - Method in interface io.micronaut.web.router.StatusRoute
- toRouteInfo() - Method in interface io.micronaut.web.router.UriRoute
- toString() - Method in class io.micronaut.web.router.DefaultErrorRouteInfo
- toString() - Method in class io.micronaut.web.router.DefaultStatusRouteInfo
- toString() - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
- toString() - Method in class io.micronaut.web.router.qualifier.ConsumesMediaTypeQualifier
- toString() - Method in class io.micronaut.web.router.qualifier.ProducesMediaTypeQualifier
- TRACE(Class<?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class.
- TRACE(Class<?>, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified class and ID.
- TRACE(Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object.
- TRACE(Object, PropertyConvention) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route to the specified object and ID.
- TRACE(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- TRACE(String, BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- TRACE(String, ExecutableMethod<?, ?>) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- TRACE(String, Class<?>, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- TRACE(String, Class<?>, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- TRACE(String, Object) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI to the specified target for an HTTP GET.
- TRACE(String, Object, String, Class<?>[]) - Method in class io.micronaut.web.router.DefaultRouteBuilder
- TRACE(String, Object, String, Class<?>...) - Method in interface io.micronaut.web.router.RouteBuilder
-
Route the specified URI template to the specified target.
- tryMatch(String) - Method in interface io.micronaut.web.router.UriRouteInfo
-
Match this route within the given URI and produce a
RouteMatchif a match is found. - tryMatch(URI) - Method in interface io.micronaut.web.router.UriRouteInfo
-
Match this route within the given URI and produce a
RouteMatchif a match is found. - tryMatch(String) - Method in class io.micronaut.web.router.DefaultUrlRouteInfo
U
- UnsatisfiedBodyRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
Bodyto aRoutecannot be satisfied. - UnsatisfiedBodyRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedBodyRouteException
- UnsatisfiedCookieValueRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
CookieValueto aRoutecannot be satisfied. - UnsatisfiedCookieValueRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedCookieValueRouteException
- UnsatisfiedHeaderRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
Headerto aRoutecannot be satisfied. - UnsatisfiedHeaderRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedHeaderRouteException
- UnsatisfiedPartRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
Partto aRoutecannot be satisfied. - UnsatisfiedPartRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedPartRouteException
- UnsatisfiedPathVariableRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
PathVariableto aRoutecannot be satisfied. - UnsatisfiedPathVariableRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedPathVariableRouteException
- UnsatisfiedQueryValueRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
QueryValueto aRoutecannot be satisfied. - UnsatisfiedQueryValueRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedQueryValueRouteException
- UnsatisfiedRequestAttributeRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
RequestAttributeto aRoutecannot be satisfied. - UnsatisfiedRequestAttributeRouteException(String, Argument<?>) - Constructor for exception io.micronaut.web.router.exceptions.UnsatisfiedRequestAttributeRouteException
- UnsatisfiedRouteException - Exception in io.micronaut.web.router.exceptions
-
An exception thrown when the an
Argumentto aRoutecannot be satisfied. - uriNamingStrategy - Variable in class io.micronaut.web.router.DefaultRouteBuilder
- UriRoute - Interface in io.micronaut.web.router
- UriRouteInfo<T,
R> - Interface in io.micronaut.web.router - UriRouteMatch<T,
R> - Interface in io.micronaut.web.router -
A
RouteMatchthat matches a URI andHttpMethod. - uriRoutes() - Method in class io.micronaut.web.router.DefaultRouter
- uriRoutes() - Method in class io.micronaut.web.router.filter.FilteredRouter
- uriRoutes() - Method in interface io.micronaut.web.router.Router
-
Returns all UriRoutes.
V
- VersionAwareRouterListener - Class in io.micronaut.web.router.version
-
Configuration to decorate
Routerwith version matching logic. - VersionAwareRouterListener(VersionRouteMatchFilter) - Constructor for class io.micronaut.web.router.version.VersionAwareRouterListener
-
Creates a configuration to decorate existing
Routerbeans with aFilteredRouter. - VersionResolver<T,
R> - Interface in io.micronaut.web.router.version.resolution -
Resolves a version from a given object.
- VersionRouteMatchFilter - Interface in io.micronaut.web.router.version
-
A marker for
RouteMatchFilters related with Versioning.
W
- where(Predicate<HttpRequest<?>>) - Method in interface io.micronaut.web.router.ErrorRoute
- where(Predicate<HttpRequest<?>>) - Method in interface io.micronaut.web.router.ResourceRoute
- where(Predicate<HttpRequest<?>>) - Method in interface io.micronaut.web.router.Route
-
Match this
Routeonly if the given predicate is true. - where(Predicate<HttpRequest<?>>) - Method in interface io.micronaut.web.router.StatusRoute
- where(Predicate<HttpRequest<?>>) - Method in interface io.micronaut.web.router.UriRoute
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
RouteInfo.getRequestBodyType()instead