org.springframework.boot.actuate.endpoint.web.annotation

Class WebAnnotationEndpointDiscoverer

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.AnnotationEndpointDiscoverer<OperationRequestPredicate,WebOperation>

org.springframework.boot.actuate.endpoint.web.annotation.WebAnnotationEndpointDiscoverer

All Implemented Interfaces:

EndpointDiscoverer<WebOperation>

Direct Known Subclasses:

CloudFoundryWebAnnotationEndpointDiscoverer

public class WebAnnotationEndpointDiscoverer
extends AnnotationEndpointDiscoverer<OperationRequestPredicate,WebOperation>

Discovers the endpoints in an ApplicationContext with web extensions applied to them.

Since:

2.0.0

Author:

Andy Wilkinson, Stephane Nicoll, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.actuate.endpoint.annotation.AnnotationEndpointDiscoverer

AnnotationEndpointDiscoverer.DiscoveredEndpoint, AnnotationEndpointDiscoverer.DiscoveredExtension, AnnotationEndpointDiscoverer.OperationKey

Constructor Summary

Constructors

Constructor and Description

WebAnnotationEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext, ParameterMapper parameterMapper, EndpointMediaTypes endpointMediaTypes, EndpointPathResolver endpointPathResolver, Collection<? extends OperationMethodInvokerAdvisor> invokerAdvisors, Collection<? extends EndpointFilter<WebOperation>> filters) Creates a new WebAnnotationEndpointDiscoverer that will discover endpoints and web extensions using the given ApplicationContext.

Method Summary

Modifier and Type	Method and Description
protected void	verify(Collection<AnnotationEndpointDiscoverer.DiscoveredEndpoint> exposedEndpoints) Allows subclasses to verify that the descriptors are correctly configured.

Methods inherited from class org.springframework.boot.actuate.endpoint.annotation.AnnotationEndpointDiscoverer

discoverEndpoints, getOperationType, isExtensionExposed

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAnnotationEndpointDiscoverer

public WebAnnotationEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext,
                                       ParameterMapper parameterMapper,
                                       EndpointMediaTypes endpointMediaTypes,
                                       EndpointPathResolver endpointPathResolver,
                                       Collection<? extends OperationMethodInvokerAdvisor> invokerAdvisors,
                                       Collection<? extends EndpointFilter<WebOperation>> filters)

Creates a new WebAnnotationEndpointDiscoverer that will discover endpoints and web extensions using the given ApplicationContext.

Parameters:

applicationContext - the application context

parameterMapper - the ParameterMapper used to convert arguments when an operation is invoked

endpointMediaTypes - the media types produced and consumed by web endpoint operations

endpointPathResolver - the EndpointPathResolver used to resolve endpoint paths

invokerAdvisors - advisors used to add additional invoker advise

filters - filters that must match for an endpoint to be exposed

Method Detail

verify

protected void verify(Collection<AnnotationEndpointDiscoverer.DiscoveredEndpoint> exposedEndpoints)

Description copied from class: AnnotationEndpointDiscoverer

Allows subclasses to verify that the descriptors are correctly configured.

Overrides:

verify in class AnnotationEndpointDiscoverer<OperationRequestPredicate,WebOperation>

Parameters:

exposedEndpoints - the discovered endpoints to verify before exposing