Package org.springframework.boot.actuate.endpoint.annotation

Class EndpointDiscoverer<E extends ExposableEndpoint<O>,O extends Operation>

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer<E,O>

Type Parameters:

E - the endpoint type

O - the operation type

All Implemented Interfaces:

EndpointsSupplier<E>

Direct Known Subclasses:

ControllerEndpointDiscoverer, JmxEndpointDiscoverer, ServletEndpointDiscoverer, WebEndpointDiscoverer

public abstract class EndpointDiscoverer<E extends ExposableEndpoint<O>,O extends Operation>
extends Object
implements EndpointsSupplier<E>

A Base for EndpointsSupplier implementations that discover @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	Description
protected static final class	EndpointDiscoverer.OperationKey	A key generated for an Operation based on specific criteria from the actual operation implementation.

Constructor Summary

Constructors

Constructor	Description
EndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<E>> endpointFilters)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 3.6.0 in favor of EndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection, Collection, Collection)
EndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<E>> endpointFilters, Collection<OperationFilter<O>> operationFilters)	Create a new EndpointDiscoverer instance.

Method Summary

Modifier and Type	Method	Description
protected E	createEndpoint(Object endpointBean, EndpointId id, boolean enabledByDefault, Collection<O> operations)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 3.6.0 in favor of createEndpoint(Object, EndpointId, Access, Collection)
protected abstract E	createEndpoint(Object endpointBean, EndpointId id, Access defaultAccess, Collection<O> operations)	Factory method called to create the endpoint.
protected abstract O	createOperation(EndpointId endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker)	Factory method to create an endpoint operation.
protected abstract EndpointDiscoverer.OperationKey	createOperationKey(O operation)	Create an EndpointDiscoverer.OperationKey for the given operation.
final Collection<E>	getEndpoints()	Return the provided endpoints.
protected Class<? extends E>	getEndpointType()
protected boolean	isEndpointTypeExposed(Class<?> beanType)	Determine if an endpoint bean should be exposed.
protected boolean	isExtensionTypeExposed(Class<?> extensionBeanType)	Determine if an extension bean should be exposed.
protected boolean	isInvocable(E endpoint)	Returns whether the endpoint is invocable and should be included in the discovered endpoints.

Methods inherited from class java.lang.Object

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

Constructor Details

EndpointDiscoverer

@Deprecated(since="3.4.0",
            forRemoval=true)
public EndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<E>> endpointFilters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 3.6.0 in favor of EndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection, Collection, Collection)

Create a new EndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

invokerAdvisors - invoker advisors to apply

endpointFilters - endpoint filters to apply

EndpointDiscoverer

public EndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<E>> endpointFilters,
 Collection<OperationFilter<O>> operationFilters)

Create a new EndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

invokerAdvisors - invoker advisors to apply

endpointFilters - endpoint filters to apply

operationFilters - operation filters to apply

Since:

3.4.0

Method Details

getEndpoints

public final Collection<E> getEndpoints()

Description copied from interface: EndpointsSupplier

Return the provided endpoints.

Specified by:

getEndpoints in interface EndpointsSupplier<E extends ExposableEndpoint<O>>

Returns:

the endpoints

isInvocable

protected boolean isInvocable(E endpoint)

Returns whether the endpoint is invocable and should be included in the discovered endpoints. The default implementation returns true if the endpoint has any operations, otherwise false.

Parameters:

endpoint - the endpoint to assess

Returns:

true if the endpoint is invocable, otherwise false.

Since:

3.4.0

isExtensionTypeExposed

protected boolean isExtensionTypeExposed(Class<?> extensionBeanType)

Determine if an extension bean should be exposed. Subclasses can override this method to provide additional logic.

Parameters:

extensionBeanType - the extension bean type

Returns:

true if the extension is exposed

isEndpointTypeExposed

protected boolean isEndpointTypeExposed(Class<?> beanType)

Determine if an endpoint bean should be exposed. Subclasses can override this method to provide additional logic.

Parameters:

beanType - the endpoint bean type

Returns:

true if the endpoint is exposed

getEndpointType

protected Class<? extends E> getEndpointType()

createEndpoint

@Deprecated(since="3.4.0",
            forRemoval=true)
protected E createEndpoint(Object endpointBean,
 EndpointId id,
 boolean enabledByDefault,
 Collection<O> operations)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 3.6.0 in favor of createEndpoint(Object, EndpointId, Access, Collection)

Factory method called to create the endpoint.

Parameters:

endpointBean - the source endpoint bean

id - the ID of the endpoint

enabledByDefault - if the endpoint is enabled by default

operations - the endpoint operations

Returns:

a created endpoint (a DiscoveredEndpoint is recommended)

createEndpoint

protected abstract E createEndpoint(Object endpointBean,
 EndpointId id,
 Access defaultAccess,
 Collection<O> operations)

Factory method called to create the endpoint.

Parameters:

endpointBean - the source endpoint bean

id - the ID of the endpoint

defaultAccess - access to the endpoint that is permitted by default

operations - the endpoint operations

Returns:

a created endpoint (a DiscoveredEndpoint is recommended)

createOperation

protected abstract O createOperation(EndpointId endpointId,
 DiscoveredOperationMethod operationMethod,
 OperationInvoker invoker)

Factory method to create an endpoint operation.

Parameters:

endpointId - the endpoint id

operationMethod - the operation method

invoker - the invoker to use

Returns:

a created operation

createOperationKey

protected abstract EndpointDiscoverer.OperationKey createOperationKey(O operation)

Create an EndpointDiscoverer.OperationKey for the given operation.

Parameters:

operation - the source operation

Returns:

the operation key