0N/A/*
2362N/A * Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/A
0N/Apackage javax.management.openmbean;
0N/A
0N/A
0N/A// java import
0N/A//
0N/A
0N/A
0N/A// jmx import
0N/A//
0N/Aimport javax.management.MBeanParameterInfo;
0N/A
0N/A/**
0N/A * <p>Describes an operation of an Open MBean.</p>
0N/A *
0N/A * <p>This interface declares the same methods as the class {@link
0N/A * javax.management.MBeanOperationInfo}. A class implementing this
0N/A * interface (typically {@link OpenMBeanOperationInfoSupport}) should
0N/A * extend {@link javax.management.MBeanOperationInfo}.</p>
0N/A *
0N/A * <p>The {@link #getSignature()} method should return at runtime an
0N/A * array of instances of a subclass of {@link MBeanParameterInfo}
0N/A * which implements the {@link OpenMBeanParameterInfo} interface
0N/A * (typically {@link OpenMBeanParameterInfoSupport}).</p>
0N/A *
0N/A *
0N/A * @since 1.5
0N/A */
0N/Apublic interface OpenMBeanOperationInfo {
0N/A
0N/A // Re-declares fields and methods that are in class MBeanOperationInfo of JMX 1.0
0N/A // (fields and methods will be removed when MBeanOperationInfo is made a parent interface of this interface)
0N/A
0N/A /**
0N/A * Returns a human readable description of the operation
0N/A * described by this <tt>OpenMBeanOperationInfo</tt> instance.
0N/A *
0N/A * @return the description.
0N/A */
0N/A public String getDescription() ;
0N/A
0N/A /**
0N/A * Returns the name of the operation
0N/A * described by this <tt>OpenMBeanOperationInfo</tt> instance.
0N/A *
0N/A * @return the name.
0N/A */
0N/A public String getName() ;
0N/A
0N/A /**
0N/A * Returns an array of <tt>OpenMBeanParameterInfo</tt> instances
0N/A * describing each parameter in the signature of the operation
0N/A * described by this <tt>OpenMBeanOperationInfo</tt> instance.
0N/A * Each instance in the returned array should actually be a
0N/A * subclass of <tt>MBeanParameterInfo</tt> which implements the
0N/A * <tt>OpenMBeanParameterInfo</tt> interface (typically {@link
0N/A * OpenMBeanParameterInfoSupport}).
0N/A *
0N/A * @return the signature.
0N/A */
0N/A public MBeanParameterInfo[] getSignature() ;
0N/A
0N/A /**
0N/A * Returns an <tt>int</tt> constant qualifying the impact of the
0N/A * operation described by this <tt>OpenMBeanOperationInfo</tt>
0N/A * instance.
0N/A *
0N/A * The returned constant is one of {@link
0N/A * javax.management.MBeanOperationInfo#INFO}, {@link
0N/A * javax.management.MBeanOperationInfo#ACTION}, {@link
0N/A * javax.management.MBeanOperationInfo#ACTION_INFO}, or {@link
0N/A * javax.management.MBeanOperationInfo#UNKNOWN}.
0N/A *
0N/A * @return the impact code.
0N/A */
0N/A public int getImpact() ;
0N/A
0N/A /**
0N/A * Returns the fully qualified Java class name of the values
0N/A * returned by the operation described by this
0N/A * <tt>OpenMBeanOperationInfo</tt> instance. This method should
0N/A * return the same value as a call to
0N/A * <tt>getReturnOpenType().getClassName()</tt>.
0N/A *
0N/A * @return the return type.
0N/A */
0N/A public String getReturnType() ;
0N/A
0N/A
0N/A // Now declares methods that are specific to open MBeans
0N/A //
0N/A
0N/A /**
0N/A * Returns the <i>open type</i> of the values returned by the
0N/A * operation described by this <tt>OpenMBeanOperationInfo</tt>
0N/A * instance.
0N/A *
0N/A * @return the return type.
0N/A */
0N/A public OpenType<?> getReturnOpenType() ; // open MBean specific method
0N/A
0N/A
0N/A // commodity methods
0N/A //
0N/A
0N/A /**
0N/A * Compares the specified <var>obj</var> parameter with this <code>OpenMBeanOperationInfo</code> instance for equality.
0N/A * <p>
0N/A * Returns <tt>true</tt> if and only if all of the following statements are true:
0N/A * <ul>
0N/A * <li><var>obj</var> is non null,</li>
0N/A * <li><var>obj</var> also implements the <code>OpenMBeanOperationInfo</code> interface,</li>
0N/A * <li>their names are equal</li>
0N/A * <li>their signatures are equal</li>
0N/A * <li>their return open types are equal</li>
0N/A * <li>their impacts are equal</li>
0N/A * </ul>
0N/A * This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
0N/A * different implementations of the <code>OpenMBeanOperationInfo</code> interface.
0N/A * <br>&nbsp;
0N/A * @param obj the object to be compared for equality with this <code>OpenMBeanOperationInfo</code> instance;
0N/A *
0N/A * @return <code>true</code> if the specified object is equal to this <code>OpenMBeanOperationInfo</code> instance.
0N/A */
0N/A public boolean equals(Object obj);
0N/A
0N/A /**
0N/A * Returns the hash code value for this <code>OpenMBeanOperationInfo</code> instance.
0N/A * <p>
0N/A * The hash code of an <code>OpenMBeanOperationInfo</code> instance is the sum of the hash codes
0N/A * of all elements of information used in <code>equals</code> comparisons
0N/A * (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to
0N/A * <tt>java.util.Arrays.asList(this.getSignature).hashCode()</tt>).
0N/A * <p>
0N/A * This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
0N/A * for any two <code>OpenMBeanOperationInfo</code> instances <code>t1</code> and <code>t2</code>,
0N/A * as required by the general contract of the method
0N/A * {@link Object#hashCode() Object.hashCode()}.
0N/A * <p>
0N/A *
0N/A * @return the hash code value for this <code>OpenMBeanOperationInfo</code> instance
0N/A */
0N/A public int hashCode();
0N/A
0N/A /**
0N/A * Returns a string representation of this <code>OpenMBeanOperationInfo</code> instance.
0N/A * <p>
0N/A * The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanOperationInfo</code>),
0N/A * and the name, signature, return open type and impact of the described operation.
0N/A *
0N/A * @return a string representation of this <code>OpenMBeanOperationInfo</code> instance
0N/A */
0N/A public String toString();
0N/A
0N/A}