001/* 002 * Copyright 2012-2018 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.actuate.endpoint.jmx; 018 019import java.util.List; 020 021import org.springframework.boot.actuate.endpoint.Operation; 022 023/** 024 * An operation on a JMX endpoint. 025 * 026 * @author Stephane Nicoll 027 * @author Andy Wilkinson 028 * @author Phillip Webb 029 * @since 2.0.0 030 */ 031public interface JmxOperation extends Operation { 032 033 /** 034 * Returns the name of the operation. 035 * @return the operation name 036 */ 037 String getName(); 038 039 /** 040 * Returns the type of the output of the operation. 041 * @return the output type 042 */ 043 Class<?> getOutputType(); 044 045 /** 046 * Returns the description of the operation. 047 * @return the operation description 048 */ 049 String getDescription(); 050 051 /** 052 * Returns the parameters the operation expects in the order that they should be 053 * provided. 054 * @return the operation parameter names 055 */ 056 List<JmxOperationParameter> getParameters(); 057 058}