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

Class ServletEndpointDiscoverer

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer<ExposableServletEndpoint,Operation>

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

All Implemented Interfaces:

EndpointsSupplier<ExposableServletEndpoint>, ServletEndpointsSupplier

public class ServletEndpointDiscoverer
extends EndpointDiscoverer<ExposableServletEndpoint,Operation>
implements ServletEndpointsSupplier

EndpointDiscoverer for servlet endpoints.

Since:

2.0.0

Author:

Phillip Webb

Nested Class Summary

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

EndpointDiscoverer.OperationKey

Constructor Summary

Constructors

Constructor and Description
ServletEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext, PathMapper endpointPathMapper, Collection<EndpointFilter<ExposableServletEndpoint>> filters) Create a new ServletEndpointDiscoverer instance.

Method Summary

Modifier and Type	Method and Description
protected ExposableServletEndpoint	createEndpoint(Object endpointBean, String id, boolean enabledByDefault, Collection<Operation> operations) Factory method called to create the endpoint.
protected Operation	createOperation(String endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker) Factory method to create an endpoint operation.
protected EndpointDiscoverer.OperationKey	createOperationKey(Operation operation) Create a EndpointDiscoverer.OperationKey for the given operation.
protected boolean	isEndpointExposed(Object endpointBean) Determine if an endpoint bean should be exposed.

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

doIt, getEndpoints, getEndpointType, isExtensionExposed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.endpoint.EndpointsSupplier

getEndpoints

Constructor Detail

ServletEndpointDiscoverer

public ServletEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext,
                                 PathMapper endpointPathMapper,
                                 Collection<EndpointFilter<ExposableServletEndpoint>> filters)

Create a new ServletEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

endpointPathMapper - the endpoint path mapper

filters - filters to apply

Method Detail

isEndpointExposed

protected boolean isEndpointExposed(Object endpointBean)

Description copied from class: EndpointDiscoverer

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

Overrides:

isEndpointExposed in class EndpointDiscoverer<ExposableServletEndpoint,Operation>

Parameters:

endpointBean - the endpoint bean

Returns:

true if the endpoint is exposed

createEndpoint

protected ExposableServletEndpoint createEndpoint(Object endpointBean,
                                                  String id,
                                                  boolean enabledByDefault,
                                                  Collection<Operation> operations)

Description copied from class: EndpointDiscoverer

Factory method called to create the endpoint.

Specified by:

createEndpoint in class EndpointDiscoverer<ExposableServletEndpoint,Operation>

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 Operation createOperation(String endpointId,
                                    DiscoveredOperationMethod operationMethod,
                                    OperationInvoker invoker)

Description copied from class: EndpointDiscoverer

Factory method to create an endpoint operation.

Specified by:

createOperation in class EndpointDiscoverer<ExposableServletEndpoint,Operation>

Parameters:

endpointId - the endpoint id

operationMethod - the operation method

invoker - the invoker to use

Returns:

a created operation

createOperationKey

protected EndpointDiscoverer.OperationKey createOperationKey(Operation operation)

Description copied from class: EndpointDiscoverer

Create a EndpointDiscoverer.OperationKey for the given operation.

Specified by:

createOperationKey in class EndpointDiscoverer<ExposableServletEndpoint,Operation>

Parameters:

operation - the source operation

Returns:

the operation key