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 and Description
protected static class	EndpointDiscoverer.OperationKey A key generated for an Operation based on specific criteria from the actual operation implementation.

Constructor Summary

Constructors

Constructor and Description
EndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<E>> filters) Create a new EndpointDiscoverer instance.

Method Summary

Modifier and Type	Method and Description
protected E	createEndpoint(Object endpointBean, EndpointId id, boolean enabledByDefault, Collection<O> operations) Factory method called to create the endpoint.
protected abstract E	createEndpoint(Object endpointBean, String id, boolean enabledByDefault, Collection<O> operations) Deprecated. Since 2.0.6 in favor of createEndpoint(Object, EndpointId, boolean, Collection)
protected O	createOperation(EndpointId endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker) Factory method to create an endpoint operation.
protected abstract O	createOperation(String endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker) Deprecated. since 2.0.6 in favor of createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker)
protected abstract EndpointDiscoverer.OperationKey	createOperationKey(O operation) Create an EndpointDiscoverer.OperationKey for the given operation.
Collection<E>	getEndpoints() Return the provided endpoints.
protected Class<? extends E>	getEndpointType()
protected boolean	isEndpointExposed(Object endpointBean) Determine if an endpoint bean should be exposed.
protected boolean	isExtensionExposed(Object extensionBean) Determine if an extension bean should be exposed.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointDiscoverer

public EndpointDiscoverer(ApplicationContext applicationContext,
                          ParameterValueMapper parameterValueMapper,
                          Collection<OperationInvokerAdvisor> invokerAdvisors,
                          Collection<EndpointFilter<E>> filters)

Create a new EndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

invokerAdvisors - invoker advisors to apply

filters - filters to apply

Method Detail

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

isExtensionExposed

protected boolean isExtensionExposed(Object extensionBean)

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

Parameters:

extensionBean - the extension bean

Returns:

true if the extension is exposed

isEndpointExposed

protected boolean isEndpointExposed(Object endpointBean)

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

Parameters:

endpointBean - the endpoint bean

Returns:

true if the endpoint is exposed

getEndpointType

protected Class<? extends E> getEndpointType()

createEndpoint

protected E createEndpoint(Object endpointBean,
                           EndpointId id,
                           boolean enabledByDefault,
                           Collection<O> operations)

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)

Since:

2.0.6

createEndpoint

@Deprecated
protected abstract E createEndpoint(Object endpointBean,
                                                String id,
                                                boolean enabledByDefault,
                                                Collection<O> operations)

Deprecated. Since 2.0.6 in favor of createEndpoint(Object, EndpointId, boolean, 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)

createOperation

protected 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

Since:

2.0.6

createOperation

@Deprecated
protected abstract O createOperation(String endpointId,
                                                 DiscoveredOperationMethod operationMethod,
                                                 OperationInvoker invoker)

Deprecated. since 2.0.6 in favor of createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker)

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