/* * Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.management.openmbean; // java import // // jmx import // import javax.management.MBeanParameterInfo; /** *

Describes an operation of an Open MBean.

* *

This interface declares the same methods as the class {@link * javax.management.MBeanOperationInfo}. A class implementing this * interface (typically {@link OpenMBeanOperationInfoSupport}) should * extend {@link javax.management.MBeanOperationInfo}.

* *

The {@link #getSignature()} method should return at runtime an * array of instances of a subclass of {@link MBeanParameterInfo} * which implements the {@link OpenMBeanParameterInfo} interface * (typically {@link OpenMBeanParameterInfoSupport}).

* * * @since 1.5 */ public interface OpenMBeanOperationInfo { // Re-declares fields and methods that are in class MBeanOperationInfo of JMX 1.0 // (fields and methods will be removed when MBeanOperationInfo is made a parent interface of this interface) /** * Returns a human readable description of the operation * described by this OpenMBeanOperationInfo instance. * * @return the description. */ public String getDescription() ; /** * Returns the name of the operation * described by this OpenMBeanOperationInfo instance. * * @return the name. */ public String getName() ; /** * Returns an array of OpenMBeanParameterInfo instances * describing each parameter in the signature of the operation * described by this OpenMBeanOperationInfo instance. * Each instance in the returned array should actually be a * subclass of MBeanParameterInfo which implements the * OpenMBeanParameterInfo interface (typically {@link * OpenMBeanParameterInfoSupport}). * * @return the signature. */ public MBeanParameterInfo[] getSignature() ; /** * Returns an int constant qualifying the impact of the * operation described by this OpenMBeanOperationInfo * instance. * * The returned constant is one of {@link * javax.management.MBeanOperationInfo#INFO}, {@link * javax.management.MBeanOperationInfo#ACTION}, {@link * javax.management.MBeanOperationInfo#ACTION_INFO}, or {@link * javax.management.MBeanOperationInfo#UNKNOWN}. * * @return the impact code. */ public int getImpact() ; /** * Returns the fully qualified Java class name of the values * returned by the operation described by this * OpenMBeanOperationInfo instance. This method should * return the same value as a call to * getReturnOpenType().getClassName(). * * @return the return type. */ public String getReturnType() ; // Now declares methods that are specific to open MBeans // /** * Returns the open type of the values returned by the * operation described by this OpenMBeanOperationInfo * instance. * * @return the return type. */ public OpenType getReturnOpenType() ; // open MBean specific method // commodity methods // /** * Compares the specified obj parameter with this OpenMBeanOperationInfo instance for equality. *

* Returns true if and only if all of the following statements are true: *

* This ensures that this equals method works properly for obj parameters which are * different implementations of the OpenMBeanOperationInfo interface. *
  * @param obj the object to be compared for equality with this OpenMBeanOperationInfo instance; * * @return true if the specified object is equal to this OpenMBeanOperationInfo instance. */ public boolean equals(Object obj); /** * Returns the hash code value for this OpenMBeanOperationInfo instance. *

* The hash code of an OpenMBeanOperationInfo instance is the sum of the hash codes * of all elements of information used in equals comparisons * (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to * java.util.Arrays.asList(this.getSignature).hashCode()). *

* This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() * for any two OpenMBeanOperationInfo instances t1 and t2, * as required by the general contract of the method * {@link Object#hashCode() Object.hashCode()}. * * * @return the hash code value for this OpenMBeanOperationInfo instance */ public int hashCode(); /** * Returns a string representation of this OpenMBeanOperationInfo instance. *

* The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanOperationInfo), * and the name, signature, return open type and impact of the described operation. * * @return a string representation of this OpenMBeanOperationInfo instance */ public String toString(); }