org.springframework.boot.actuate.endpoint.jmx

Class JmxOperation

java.lang.Object

org.springframework.boot.actuate.endpoint.Operation

org.springframework.boot.actuate.endpoint.jmx.JmxOperation

public class JmxOperation
extends Operation

An operation on a JMX endpoint.

Since:

2.0.0

Author:

Stephane Nicoll, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
JmxOperation(OperationType type, OperationInvoker invoker, String operationName, Class<?> outputType, String description, List<JmxEndpointOperationParameterInfo> parameters) Creates a new JmxEndpointOperation for an operation of the given type.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the operation.
String	getOperationName() Returns the name of the operation.
Class<?>	getOutputType() Returns the type of the output of the operation.
List<JmxEndpointOperationParameterInfo>	getParameters() Returns the parameters of the operation.
String	toString()

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

getInvoker, getType, isBlocking

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxOperation

public JmxOperation(OperationType type,
                    OperationInvoker invoker,
                    String operationName,
                    Class<?> outputType,
                    String description,
                    List<JmxEndpointOperationParameterInfo> parameters)

Creates a new JmxEndpointOperation for an operation of the given type. The operation can be performed using the given invoker.

Parameters:

type - the type of the operation

invoker - used to perform the operation

operationName - the name of the operation

outputType - the type of the output of the operation

description - the description of the operation

parameters - the parameters of the operation

Method Detail

getOperationName

public String getOperationName()

Returns the name of the operation.

Returns:

the operation name

getOutputType

public Class<?> getOutputType()

Returns the type of the output of the operation.

Returns:

the output type

getDescription

public String getDescription()

Returns the description of the operation.

Returns:

the operation description

getParameters

public List<JmxEndpointOperationParameterInfo> getParameters()

Returns the parameters of the operation.

Returns:

the operation parameters

toString

public String toString()

Overrides:

toString in class Object