Class ControllerEndpointDiscoverer

java.lang.Object

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

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

All Implemented Interfaces:

EndpointsSupplier<ExposableControllerEndpoint>, ControllerEndpointsSupplier

@ImportRuntimeHints(org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer.ControllerEndpointDiscovererRuntimeHints.class)
@Deprecated(since="3.3.0",
            forRemoval=true)
public class ControllerEndpointDiscoverer
extends EndpointDiscoverer<ExposableControllerEndpoint, Operation>
implements ControllerEndpointsSupplier

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

since 3.3.0 in favor of @Endpoint and @WebEndpoint support

EndpointDiscoverer for controller endpoints.

Since:

2.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class EndpointDiscoverer

EndpointDiscoverer.OperationKey

Constructor Summary

Constructors

Constructor	Description
ControllerEndpointDiscoverer(ApplicationContext applicationContext, @Nullable List<PathMapper> endpointPathMappers, Collection<EndpointFilter<ExposableControllerEndpoint>> filters)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new ControllerEndpointDiscoverer instance.

Method Summary

Modifier and Type	Method	Description
protected ExposableControllerEndpoint	createEndpoint(Object endpointBean, EndpointId id, Access defaultAccess, Collection<Operation> operations)	Deprecated, for removal: This API element is subject to removal in a future version. Factory method called to create the endpoint.
protected Operation	createOperation(EndpointId endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker)	Deprecated, for removal: This API element is subject to removal in a future version. Factory method to create an endpoint operation.
protected EndpointDiscoverer.OperationKey	createOperationKey(Operation operation)	Deprecated, for removal: This API element is subject to removal in a future version. Create an EndpointDiscoverer.OperationKey for the given operation.
protected boolean	isEndpointTypeExposed(Class<?> beanType)	Deprecated, for removal: This API element is subject to removal in a future version. Determine if an endpoint bean should be exposed.
protected boolean	isInvocable(ExposableControllerEndpoint endpoint)	Deprecated, for removal: This API element is subject to removal in a future version. Returns whether the endpoint is invocable and should be included in the discovered endpoints.

Methods inherited from class EndpointDiscoverer

getEndpoints, getEndpointType, isExtensionTypeExposed

Methods inherited from class Object

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

Methods inherited from interface EndpointsSupplier

getEndpoints

Constructor Details

ControllerEndpointDiscoverer

public ControllerEndpointDiscoverer(ApplicationContext applicationContext,
 @Nullable List<PathMapper> endpointPathMappers,
 Collection<EndpointFilter<ExposableControllerEndpoint>> filters)

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

Create a new ControllerEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

endpointPathMappers - the endpoint path mappers

filters - filters to apply

Method Details

isEndpointTypeExposed

protected boolean isEndpointTypeExposed(Class<?> beanType)

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

Description copied from class: EndpointDiscoverer

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

Overrides:

isEndpointTypeExposed in class EndpointDiscoverer<ExposableControllerEndpoint, Operation>

Parameters:

beanType - the endpoint bean type

Returns:

true if the endpoint is exposed

createEndpoint

protected ExposableControllerEndpoint createEndpoint(Object endpointBean,
 EndpointId id,
 Access defaultAccess,
 Collection<Operation> operations)

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

Description copied from class: EndpointDiscoverer

Factory method called to create the endpoint.

Specified by:

createEndpoint in class EndpointDiscoverer<ExposableControllerEndpoint, Operation>

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

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

Description copied from class: EndpointDiscoverer

Factory method to create an endpoint operation.

Specified by:

createOperation in class EndpointDiscoverer<ExposableControllerEndpoint, 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)

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

Description copied from class: EndpointDiscoverer

Create an EndpointDiscoverer.OperationKey for the given operation.

Specified by:

createOperationKey in class EndpointDiscoverer<ExposableControllerEndpoint, Operation>

Parameters:

operation - the source operation

Returns:

the operation key

isInvocable

protected boolean isInvocable(ExposableControllerEndpoint endpoint)

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

Description copied from class: EndpointDiscoverer

Returns whether the endpoint is invocable and should be included in the discovered endpoints. The default implementation returns true if the endpoint has any operations, otherwise false.

Overrides:

isInvocable in class EndpointDiscoverer<ExposableControllerEndpoint, Operation>

Parameters:

endpoint - the endpoint to assess

Returns:

true if the endpoint is invocable, otherwise false.