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 java.lang.Object
implements EndpointsSupplier<E>

A Base for EndpointsSupplier implementations that discover @Endpoint beans and @EndpointExtension beans in an application context.

Since:

2.0.0

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(org.springframework.context.ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, java.util.Collection<OperationInvokerAdvisor> invokerAdvisors, java.util.Collection<EndpointFilter<E>> filters) Create a new EndpointDiscoverer instance.

Method Summary

Modifier and Type	Method and Description
protected abstract E	createEndpoint(java.lang.Object endpointBean, EndpointId id, boolean enabledByDefault, java.util.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.
java.util.Collection<E>	getEndpoints() Return the provided endpoints.
protected java.lang.Class<? extends E>	getEndpointType()
protected boolean	isEndpointExposed(java.lang.Object endpointBean) Deprecated.
protected boolean	isEndpointTypeExposed(java.lang.Class<?> beanType) Determine if an endpoint bean should be exposed.
protected boolean	isExtensionExposed(java.lang.Object extensionBean) Deprecated.
protected boolean	isExtensionTypeExposed(java.lang.Class<?> extensionBeanType) 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(org.springframework.context.ApplicationContext applicationContext,
                          ParameterValueMapper parameterValueMapper,
                          java.util.Collection<OperationInvokerAdvisor> invokerAdvisors,
                          java.util.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 java.util.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

@Deprecated
protected boolean isExtensionExposed(java.lang.Object extensionBean)

Deprecated.

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

isExtensionTypeExposed

protected boolean isExtensionTypeExposed(java.lang.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

isEndpointExposed

@Deprecated
protected boolean isEndpointExposed(java.lang.Object endpointBean)

Deprecated.

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

isEndpointTypeExposed

protected boolean isEndpointTypeExposed(java.lang.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 java.lang.Class<? extends E> getEndpointType()

createEndpoint

protected abstract E createEndpoint(java.lang.Object endpointBean,
                                    EndpointId id,
                                    boolean enabledByDefault,
                                    java.util.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)

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