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

Class WebEndpointDiscoverer

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer<ExposableWebEndpoint,WebOperation>

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

All Implemented Interfaces:

EndpointsSupplier<ExposableWebEndpoint>, WebEndpointsSupplier

Direct Known Subclasses:

CloudFoundryWebEndpointDiscoverer

public class WebEndpointDiscoverer
extends EndpointDiscoverer<ExposableWebEndpoint,WebOperation>
implements WebEndpointsSupplier

EndpointDiscoverer for web 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
WebEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, EndpointMediaTypes endpointMediaTypes, PathMapper endpointPathMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<ExposableWebEndpoint>> filters) Create a new WebEndpointDiscoverer instance.

Method Summary

Modifier and Type	Method and Description
protected ExposableWebEndpoint	createEndpoint(Object endpointBean, String id, boolean enabledByDefault, Collection<WebOperation> operations) Factory method called to create the endpoint.
protected WebOperation	createOperation(String endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker) Factory method to create an endpoint operation.
protected EndpointDiscoverer.OperationKey	createOperationKey(WebOperation operation) Create a EndpointDiscoverer.OperationKey for the given operation.

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

doIt, getEndpoints, getEndpointType, isEndpointExposed, 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

WebEndpointDiscoverer

public WebEndpointDiscoverer(org.springframework.context.ApplicationContext applicationContext,
                             ParameterValueMapper parameterValueMapper,
                             EndpointMediaTypes endpointMediaTypes,
                             PathMapper endpointPathMapper,
                             Collection<OperationInvokerAdvisor> invokerAdvisors,
                             Collection<EndpointFilter<ExposableWebEndpoint>> filters)

Create a new WebEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

endpointMediaTypes - the endpoint media types

endpointPathMapper - the endpoint path mapper

invokerAdvisors - invoker advisors to apply

filters - filters to apply

Method Detail

createEndpoint

protected ExposableWebEndpoint createEndpoint(Object endpointBean,
                                              String id,
                                              boolean enabledByDefault,
                                              Collection<WebOperation> operations)

Description copied from class: EndpointDiscoverer

Factory method called to create the endpoint.

Specified by:

createEndpoint in class EndpointDiscoverer<ExposableWebEndpoint,WebOperation>

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 WebOperation 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<ExposableWebEndpoint,WebOperation>

Parameters:

endpointId - the endpoint id

operationMethod - the operation method

invoker - the invoker to use

Returns:

a created operation

createOperationKey

protected EndpointDiscoverer.OperationKey createOperationKey(WebOperation operation)

Description copied from class: EndpointDiscoverer

Create a EndpointDiscoverer.OperationKey for the given operation.

Specified by:

createOperationKey in class EndpointDiscoverer<ExposableWebEndpoint,WebOperation>

Parameters:

operation - the source operation

Returns:

the operation key