Package org.springframework.boot.actuate.endpoint.jmx.annotation

Class JmxEndpointDiscoverer

java.lang.Object

org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer<ExposableJmxEndpoint,JmxOperation>

org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer

All Implemented Interfaces:

EndpointsSupplier<ExposableJmxEndpoint>, JmxEndpointsSupplier

@ImportRuntimeHints(org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer.JmxEndpointDiscovererRuntimeHints.class)
public class JmxEndpointDiscoverer
extends EndpointDiscoverer<ExposableJmxEndpoint,JmxOperation>
implements JmxEndpointsSupplier

EndpointDiscoverer for JMX 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
JmxEndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<ExposableJmxEndpoint>> endpointFilters)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 3.6.0 in favor of JmxEndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection, Collection, Collection)
JmxEndpointDiscoverer(ApplicationContext applicationContext, ParameterValueMapper parameterValueMapper, Collection<OperationInvokerAdvisor> invokerAdvisors, Collection<EndpointFilter<ExposableJmxEndpoint>> endpointFilters, Collection<OperationFilter<JmxOperation>> operationFilters)	Create a new JmxEndpointDiscoverer instance.

Method Summary

Modifier and Type	Method	Description
protected ExposableJmxEndpoint	createEndpoint(Object endpointBean, EndpointId id, Access defaultAccess, Collection<JmxOperation> operations)	Factory method called to create the endpoint.
protected JmxOperation	createOperation(EndpointId endpointId, DiscoveredOperationMethod operationMethod, OperationInvoker invoker)	Factory method to create an endpoint operation.
protected EndpointDiscoverer.OperationKey	createOperationKey(JmxOperation 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

JmxEndpointDiscoverer

@Deprecated(since="3.4.0",
            forRemoval=true)
public JmxEndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<ExposableJmxEndpoint>> endpointFilters)

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

since 3.4.0 for removal in 3.6.0 in favor of JmxEndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection, Collection, Collection)

Create a new JmxEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

invokerAdvisors - invoker advisors to apply

endpointFilters - endpoint filters to apply

JmxEndpointDiscoverer

public JmxEndpointDiscoverer(ApplicationContext applicationContext,
 ParameterValueMapper parameterValueMapper,
 Collection<OperationInvokerAdvisor> invokerAdvisors,
 Collection<EndpointFilter<ExposableJmxEndpoint>> endpointFilters,
 Collection<OperationFilter<JmxOperation>> operationFilters)

Create a new JmxEndpointDiscoverer instance.

Parameters:

applicationContext - the source application context

parameterValueMapper - the parameter value mapper

invokerAdvisors - invoker advisors to apply

endpointFilters - endpoint filters to apply

operationFilters - operation filters to apply

Since:

3.4.0

Method Details

createEndpoint

protected ExposableJmxEndpoint createEndpoint(Object endpointBean,
 EndpointId id,
 Access defaultAccess,
 Collection<JmxOperation> operations)

Description copied from class: EndpointDiscoverer

Factory method called to create the endpoint.

Specified by:

createEndpoint in class EndpointDiscoverer<ExposableJmxEndpoint,JmxOperation>

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 JmxOperation 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<ExposableJmxEndpoint,JmxOperation>

Parameters:

endpointId - the endpoint id

operationMethod - the operation method

invoker - the invoker to use

Returns:

a created operation

createOperationKey

protected EndpointDiscoverer.OperationKey createOperationKey(JmxOperation operation)

Description copied from class: EndpointDiscoverer

Create an EndpointDiscoverer.OperationKey for the given operation.

Specified by:

createOperationKey in class EndpointDiscoverer<ExposableJmxEndpoint,JmxOperation>

Parameters:

operation - the source operation

Returns:

the operation key