org.springframework.boot.actuate.endpoint.web.reactive

Class AbstractWebFluxEndpointHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.reactive.handler.AbstractHandlerMapping

org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping<RequestMappingInfo>

org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping

org.springframework.boot.actuate.endpoint.web.reactive.AbstractWebFluxEndpointHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, HandlerMapping

Direct Known Subclasses:

WebFluxEndpointHandlerMapping

public abstract class AbstractWebFluxEndpointHandlerMapping
extends RequestMappingInfoHandlerMapping

A custom HandlerMapping that makes web endpoints available over HTTP using Spring WebFlux.

Since:

2.0.0

Author:

Andy Wilkinson, Madhura Bhave, Phillip Webb, Brian Clozel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractWebFluxEndpointHandlerMapping.ElasticSchedulerInvoker An OperationInvoker that performs the invocation of a blocking operation on a separate thread using Reactor's bounded elastic scheduler.
protected static interface	AbstractWebFluxEndpointHandlerMapping.LinksHandler Reactive handler providing actuator links at the root endpoint.
protected static interface	AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation A reactive web operation that can be handled by WebFlux.

Field Summary

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.reactive.HandlerMapping

BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractWebFluxEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<ExposableWebEndpoint> endpoints, EndpointMediaTypes endpointMediaTypes, CorsConfiguration corsConfiguration, boolean shouldRegisterLinksMapping) Creates a new AbstractWebFluxEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.

Method Summary

Modifier and Type	Method and Description
protected HandlerMethod	createHandlerMethod(Object handler, Method method)
Collection<ExposableWebEndpoint>	getEndpoints() Return the web endpoints being mapped.
protected abstract AbstractWebFluxEndpointHandlerMapping.LinksHandler	getLinksHandler() Return the Handler providing actuator links at the root endpoint.
protected RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)
protected boolean	hasCorsConfigurationSource(Object handler)
protected CorsConfiguration	initCorsConfiguration(Object handler, Method method, RequestMappingInfo mapping)
protected void	initHandlerMethods()
protected boolean	isHandler(Class<?> beanType)
protected AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation	wrapReactiveWebOperation(ExposableWebEndpoint endpoint, WebOperation operation, AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation reactiveWebOperation) Hook point that allows subclasses to wrap the AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation before it's called.

Methods inherited from class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping

afterPropertiesSet, detectHandlerMethods, getCorsConfiguration, getHandlerMethods, handlerMethodsInitialized, lookupHandlerMethod, registerHandlerMethod, registerMapping, unregisterMapping

Methods inherited from class org.springframework.web.reactive.handler.AbstractHandlerMapping

formatMappingName, getCorsProcessor, getHandler, getOrder, getPathPatternParser, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setOrder, setUseCaseSensitiveMatch, setUseTrailingSlashMatch

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebFluxEndpointHandlerMapping

public AbstractWebFluxEndpointHandlerMapping(EndpointMapping endpointMapping,
                                             Collection<ExposableWebEndpoint> endpoints,
                                             EndpointMediaTypes endpointMediaTypes,
                                             CorsConfiguration corsConfiguration,
                                             boolean shouldRegisterLinksMapping)

Creates a new AbstractWebFluxEndpointHandlerMapping that provides mappings for the operations of the given webEndpoints.

Parameters:

endpointMapping - the base mapping for all endpoints

endpoints - the web endpoints

endpointMediaTypes - media types consumed and produced by the endpoints

corsConfiguration - the CORS configuration for the endpoints

shouldRegisterLinksMapping - whether the links endpoint should be registered

Method Detail

initHandlerMethods

protected void initHandlerMethods()

Overrides:

initHandlerMethods in class AbstractHandlerMethodMapping<RequestMappingInfo>

createHandlerMethod

protected HandlerMethod createHandlerMethod(Object handler,
                                            Method method)

Overrides:

createHandlerMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

wrapReactiveWebOperation

protected AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation wrapReactiveWebOperation(ExposableWebEndpoint endpoint,
                                                                                              WebOperation operation,
                                                                                              AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation reactiveWebOperation)

Hook point that allows subclasses to wrap the AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation before it's called. Allows additional features, such as security, to be added.

Parameters:

endpoint - the source endpoint

operation - the source operation

reactiveWebOperation - the reactive web operation to wrap

Returns:

a wrapped reactive web operation

hasCorsConfigurationSource

protected boolean hasCorsConfigurationSource(Object handler)

Overrides:

hasCorsConfigurationSource in class AbstractHandlerMethodMapping<RequestMappingInfo>

initCorsConfiguration

protected CorsConfiguration initCorsConfiguration(Object handler,
                                                  Method method,
                                                  RequestMappingInfo mapping)

Overrides:

initCorsConfiguration in class AbstractHandlerMethodMapping<RequestMappingInfo>

isHandler

protected boolean isHandler(Class<?> beanType)

Specified by:

isHandler in class AbstractHandlerMethodMapping<RequestMappingInfo>

getMappingForMethod

protected RequestMappingInfo getMappingForMethod(Method method,
                                                 Class<?> handlerType)

Specified by:

getMappingForMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

getLinksHandler

protected abstract AbstractWebFluxEndpointHandlerMapping.LinksHandler getLinksHandler()

Return the Handler providing actuator links at the root endpoint.

Returns:

the links handler

getEndpoints

public Collection<ExposableWebEndpoint> getEndpoints()

Return the web endpoints being mapped.

Returns:

the endpoints