org.springframework.boot.actuate.endpoint.jmx

Interface JmxOperation

All Superinterfaces:

Operation

public interface JmxOperation
extends Operation

An operation on a JMX endpoint.

Since:

2.0.0

Author:

Stephane Nicoll, Andy Wilkinson, Phillip Webb

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the operation.
String	getName() Returns the name of the operation.
Class<?>	getOutputType() Returns the type of the output of the operation.
List<JmxOperationParameter>	getParameters() Returns the parameters the operation expects in the order that they should be provided.

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

getType, invoke

Method Detail

getName

String getName()

Returns the name of the operation.

Returns:

the operation name

getOutputType

Class<?> getOutputType()

Returns the type of the output of the operation.

Returns:

the output type

getDescription

String getDescription()

Returns the description of the operation.

Returns:

the operation description

getParameters

List<JmxOperationParameter> getParameters()

Returns the parameters the operation expects in the order that they should be provided.

Returns:

the operation parameter names