org.springframework.boot.actuate.endpoint.annotation

Class AnnotationEndpointDiscoverer<K,T extends Operation>

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.AnnotationEndpointDiscoverer<K,T>

Type Parameters:

K - the type of the operation key

T - the type of the operation

All Implemented Interfaces:

EndpointDiscoverer<T>

Direct Known Subclasses:

JmxAnnotationEndpointDiscoverer, WebAnnotationEndpointDiscoverer

public abstract class AnnotationEndpointDiscoverer<K,T extends Operation>
extends Object
implements EndpointDiscoverer<T>

A base EndpointDiscoverer implementation that discovers @Endpoint beans and @EndpointExtension beans in an application context.

Since:

2.0.0

Author:

Andy Wilkinson, Stephane Nicoll, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AnnotationEndpointDiscoverer.DiscoveredEndpoint A discovered endpoint (which may not be valid and might not ultimately be exposed).
protected class	AnnotationEndpointDiscoverer.DiscoveredExtension A discovered extension.
protected class	AnnotationEndpointDiscoverer.OperationKey Define the key of an operation in the context of an operation's implementation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext, OperationFactory<T> operationFactory, Function<T,K> operationKeyFactory, ParameterMapper parameterMapper, Collection<? extends OperationMethodInvokerAdvisor> invokerAdvisors, Collection<? extends EndpointFilter<T>> filters) Create a new AnnotationEndpointDiscoverer instance.

Method Summary

Modifier and Type	Method and Description
Collection<EndpointInfo<T>>	discoverEndpoints() Perform endpoint discovery.
protected Class<T>	getOperationType() Return the operation type being discovered.
protected boolean	isExtensionExposed(Class<?> endpointType, Class<?> extensionType, EndpointInfo<T> endpointInfo) Determines if an extension is exposed.
protected void	verify(Collection<AnnotationEndpointDiscoverer.DiscoveredEndpoint> exposedEndpoints) Allows subclasses to verify that the descriptors are correctly configured.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationEndpointDiscoverer

protected AnnotationEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext,
                                       OperationFactory<T> operationFactory,
                                       Function<T,K> operationKeyFactory,
                                       ParameterMapper parameterMapper,
                                       Collection<? extends OperationMethodInvokerAdvisor> invokerAdvisors,
                                       Collection<? extends EndpointFilter<T>> filters)

Create a new AnnotationEndpointDiscoverer instance.

Parameters:

applicationContext - the application context

operationFactory - a factory used to create operations

operationKeyFactory - a factory used to create a key for an operation

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

invokerAdvisors - advisors used to add additional invoker advise

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

Method Detail

discoverEndpoints

public final Collection<EndpointInfo<T>> discoverEndpoints()

Description copied from interface: EndpointDiscoverer

Perform endpoint discovery.

Specified by:

discoverEndpoints in interface EndpointDiscoverer<T extends Operation>

Returns:

the discovered endpoints

getOperationType

protected Class<T> getOperationType()

Return the operation type being discovered. By default this method will resolve the class generic "<T>".

Returns:

the operation type

isExtensionExposed

protected boolean isExtensionExposed(Class<?> endpointType,
                                     Class<?> extensionType,
                                     EndpointInfo<T> endpointInfo)

Determines if an extension is exposed.

Parameters:

endpointType - the endpoint type

extensionType - the extension type

endpointInfo - the endpoint info

Returns:

if the extension is exposed

verify

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

Allows subclasses to verify that the descriptors are correctly configured.

Parameters:

exposedEndpoints - the discovered endpoints to verify before exposing