Package 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

@ImportRuntimeHints(org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer.WebEndpointDiscovererRuntimeHints.class)
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	Description
WebEndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, EndpointMediaTypes endpointMediaTypes, List<PathMapper> endpointPathMappers, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<ExposableWebEndpoint>> filters)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 4.0.0 in favor of WebEndpointDiscoverer(ApplicationContext, ParameterValueMapper, EndpointMediaTypes, List, List, Collection, Collection, Collection)
WebEndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, EndpointMediaTypes endpointMediaTypes, List<PathMapper> endpointPathMappers, List<AdditionalPathsMapper> additionalPathsMappers, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<ExposableWebEndpoint>> endpointFilters, Collection<OperationFilter<WebOperation>> operationFilters)	Create a new WebEndpointDiscoverer instance.

Method Summary

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

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

createEndpoint, getEndpoints, getEndpointType, isEndpointTypeExposed, isExtensionTypeExposed, isInvocable

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 Details

WebEndpointDiscoverer

@Deprecated(since="3.4.0",
            forRemoval=true)
public WebEndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 EndpointMediaTypes endpointMediaTypes,
 List<PathMapper> endpointPathMappers,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<ExposableWebEndpoint>> filters)

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

since 3.4.0 for removal in 4.0.0 in favor of WebEndpointDiscoverer(ApplicationContext, ParameterValueMapper, EndpointMediaTypes, List, List, Collection, Collection, Collection)

Create a new WebEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

endpointMediaTypes - the endpoint media types

endpointPathMappers - the endpoint path mappers

invokerAdvisors - invoker advisors to apply

filters - filters to apply

WebEndpointDiscoverer

public WebEndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 EndpointMediaTypes endpointMediaTypes,
 List<PathMapper> endpointPathMappers,
 List<AdditionalPathsMapper> additionalPathsMappers,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<ExposableWebEndpoint>> endpointFilters,
 Collection<OperationFilter<WebOperation>> operationFilters)

Create a new WebEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

endpointMediaTypes - the endpoint media types

endpointPathMappers - the endpoint path mappers

additionalPathsMappers - the

invokerAdvisors - invoker advisors to apply

endpointFilters - endpoint filters to apply

operationFilters - operation filters to apply

Since:

3.4.0

Method Details

createEndpoint

protected ExposableWebEndpoint createEndpoint(Object endpointBean,
 EndpointId id,
 Access defaultAccess,
 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

defaultAccess - access to the endpoint that is permitted by default

operations - the endpoint operations

Returns:

a created endpoint (a DiscoveredEndpoint is recommended)

createOperation

protected WebOperation createOperation(EndpointId 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 an EndpointDiscoverer.OperationKey for the given operation.

Specified by:

createOperationKey in class EndpointDiscoverer<ExposableWebEndpoint,WebOperation>

Parameters:

operation - the source operation

Returns:

the operation key