Class WebFluxEndpointHandlerMapping

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.webflux.actuate.endpoint.web.AbstractWebFluxEndpointHandlerMapping

org.springframework.boot.webflux.actuate.endpoint.web.WebFluxEndpointHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, HandlerMapping

@ImportRuntimeHints(org.springframework.boot.webflux.actuate.endpoint.web.WebFluxEndpointHandlerMapping.WebFluxEndpointHandlerMappingRuntimeHints.class)
public class WebFluxEndpointHandlerMapping
extends AbstractWebFluxEndpointHandlerMapping
implements InitializingBean

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

Since:

4.0.0

Author:

Andy Wilkinson, Phillip Webb, Brian Clozel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractWebFluxEndpointHandlerMapping

AbstractWebFluxEndpointHandlerMapping.ElasticSchedulerInvoker, AbstractWebFluxEndpointHandlerMapping.ExceptionCapturingInvoker, AbstractWebFluxEndpointHandlerMapping.LinksHandler, AbstractWebFluxEndpointHandlerMapping.ReactiveWebOperation

Field Summary

Fields inherited from class AbstractHandlerMapping

mappingsLogger

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface HandlerMapping

API_VERSION_ATTRIBUTE, 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 Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
WebFluxEndpointHandlerMapping(EndpointMapping endpointMapping, Collection<ExposableWebEndpoint> endpoints, EndpointMediaTypes endpointMediaTypes, @Nullable CorsConfiguration corsConfiguration, EndpointLinksResolver linksResolver, boolean shouldRegisterLinksMapping)	Creates a new WebFluxEndpointHandlerMapping instance that provides mappings for the given endpoints.

Method Summary

Modifier and Type	Method	Description
protected AbstractWebFluxEndpointHandlerMapping.LinksHandler	getLinksHandler()	Return the Handler providing actuator links at the root endpoint.

Methods inherited from class AbstractWebFluxEndpointHandlerMapping

createHandlerMethod, getCorsConfiguration, getEndpoints, getMappingForMethod, hasCorsConfigurationSource, initCorsConfiguration, initHandlerMethods, isHandler, registerReadMapping, wrapReactiveWebOperation

Methods inherited from class RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class AbstractHandlerMethodMapping

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

Methods inherited from class AbstractHandlerMapping

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

Methods inherited from class ApplicationObjectSupport

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

Methods inherited from class Object

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

Methods inherited from interface InitializingBean

afterPropertiesSet

Constructor Details

WebFluxEndpointHandlerMapping

public WebFluxEndpointHandlerMapping(EndpointMapping endpointMapping,
 Collection<ExposableWebEndpoint> endpoints,
 EndpointMediaTypes endpointMediaTypes,
 @Nullable CorsConfiguration corsConfiguration,
 EndpointLinksResolver linksResolver,
 boolean shouldRegisterLinksMapping)

Creates a new WebFluxEndpointHandlerMapping instance that provides mappings for the given endpoints.

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 or null

linksResolver - resolver for determining links to available endpoints

shouldRegisterLinksMapping - whether the links endpoint should be registered

Method Details

getLinksHandler

protected AbstractWebFluxEndpointHandlerMapping.LinksHandler getLinksHandler()

Description copied from class: AbstractWebFluxEndpointHandlerMapping

Return the Handler providing actuator links at the root endpoint.

Specified by:

getLinksHandler in class AbstractWebFluxEndpointHandlerMapping

Returns:

the links handler