Class DefaultStatusRouteInfo<T,R>

java.lang.Object

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

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

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

Type Parameters:

T - The target

R - The result

All Implemented Interfaces:

AnnotationMetadataProvider, AnnotationSource, MethodBasedRouteInfo<T,R>, RequestMatcher, RouteInfo<R>, StatusRouteInfo<T,R>

@Internal
public final class DefaultStatusRouteInfo<T,R>
extends DefaultRequestMatcher<T,R>
implements StatusRouteInfo<T,R>

The default StatusRouteInfo 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
DefaultStatusRouteInfo(@Nullable Class<?> originatingType, int statusCode, MethodExecutionHandle<T,R> targetMethod, @Nullable String bodyArgumentName, @Nullable Argument<?> bodyArgument, List<MediaType> consumesMediaTypes, List<MediaType> producesMediaTypes, List<Predicate<HttpRequest<?>>> predicates, ConversionService conversionService, MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HttpStatus	findStatus(@Nullable HttpStatus defaultStatus)	Finds predefined route http status or uses default.
String[]	getArgumentNames()
Optional<Argument<?>>	getFullRequestBodyType()	Like RouteInfo.getRequestBodyType(), but excludes body arguments that may match only a part of the body (i.e.
final @Nullable MessageBodyReader<?>	getMessageBodyReader()
Optional<Argument<?>>	getRequestBodyType()
MethodExecutionHandle<T,R>	getTargetMethod()
int	hashCode()
boolean	isVoid()
Optional<RouteMatch<R>>	match(int statusCode)	Match the given HTTP status.
Optional<RouteMatch<R>>	match(HttpStatus status)	Match the given HTTP status.
Optional<RouteMatch<R>>	match(@Nullable Class<?> originatingClass, int statusCode)	Match the given HTTP status.
Optional<RouteMatch<R>>	match(@Nullable Class<?> originatingClass, HttpStatus status)	Match the given HTTP status.
boolean	needsRequestBody()
@Nullable Class<?>	originatingType()
RequestArgumentBinder<Object>[]	resolveArgumentBinders(RequestBinderRegistry requestBinderRegistry)
HttpStatus	status()
int	statusCode()
String	toString()

Methods inherited from class DefaultRequestMatcher

matching

Methods inherited from class DefaultRouteInfo

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

Methods inherited from class Object

clone, finalize, getClass, 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, getBodyArgument, getBodyType, getConsumes, getDeclaringType, getExecutor, getFullRequestBodyType, getMessageBodyReader, getMessageBodyWriter, getProduces, getRequestBodyType, getResponseBodyType, getReturnType, isAsync, isAsyncOrReactive, isCompletable, isErrorRoute, isImperative, isPermitsRequestBody, isReactive, isResponseBodyJsonFormattable, isSingleResult, isSpecifiedSingle, isSuspended, isVoid, isWebSocketRoute, needsRequestBody, producesAll

Constructor Details

DefaultStatusRouteInfo

public DefaultStatusRouteInfo(@Nullable Class<?> originatingType,
 int statusCode,
 MethodExecutionHandle<T,R> targetMethod,
 @Nullable String bodyArgumentName,
 @Nullable Argument<?> bodyArgument,
 List<MediaType> consumesMediaTypes,
 List<MediaType> producesMediaTypes,
 List<Predicate<HttpRequest<?>>> predicates,
 ConversionService conversionService,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Method Details

originatingType

public @Nullable Class<?> originatingType()

Specified by:

originatingType in interface StatusRouteInfo<T,R>

Returns:

The type the exception originates from. Null if the error route is global.

status

public HttpStatus status()

Specified by:

status in interface StatusRouteInfo<T,R>

Returns:

The status

statusCode

public int statusCode()

Specified by:

statusCode in interface StatusRouteInfo<T,R>

Returns:

The status

findStatus

public HttpStatus findStatus(@Nullable HttpStatus defaultStatus)

Description copied from interface: RouteInfo

Finds predefined route http status or uses default.

Specified by:

findStatus in interface RouteInfo<T>

Overrides:

findStatus in class DefaultRouteInfo<R>

Parameters:

defaultStatus - The default status

Returns:

The status

match

public Optional<RouteMatch<R>> match(@Nullable Class<?> originatingClass,
 HttpStatus status)

Description copied from interface: StatusRouteInfo

Match the given HTTP status.

Specified by:

match in interface StatusRouteInfo<T,R>

Parameters:

originatingClass - The class where the error originates from

status - The status to match

Returns:

The route match

match

public Optional<RouteMatch<R>> match(HttpStatus status)

Description copied from interface: StatusRouteInfo

Match the given HTTP status.

Specified by:

match in interface StatusRouteInfo<T,R>

Parameters:

status - The status to match

Returns:

The route match

match

public Optional<RouteMatch<R>> match(int statusCode)

Description copied from interface: StatusRouteInfo

Match the given HTTP status.

Specified by:

match in interface StatusRouteInfo<T,R>

Parameters:

statusCode - The status to match

Returns:

The route match

match

public Optional<RouteMatch<R>> match(@Nullable Class<?> originatingClass,
 int statusCode)

Description copied from interface: StatusRouteInfo

Match the given HTTP status.

Specified by:

match in interface StatusRouteInfo<T,R>

Parameters:

originatingClass - The class where the error originates from

statusCode - The status to match

Returns:

The route match

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

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