001: /* JFox, the OpenSource J2EE Application Server
002: *
003: * Copyright (C) 2002 huihoo.org
004: * Distributable under GNU LGPL license
005: * See the GNU Lesser General Public License for more details.
006: */
007:
008: package javax.management.openmbean;
009:
010: import javax.management.MBeanParameterInfo;
011:
012: /**
013: * <p>Describes an operation of an Open MBean.</p>
014: *
015: * <p>This interface declares the same methods as the class {@link
016: * javax.management.MBeanOperationInfo}. A class implementing this
017: * interface (typically {@link OpenMBeanOperationInfoSupport}) should
018: * extend {@link javax.management.MBeanOperationInfo}.</p>
019: *
020: * <p>The {@link #getSignature()} method should return at runtime an
021: * array of instances of a subclass of {@link MBeanParameterInfo}
022: * which implements the {@link OpenMBeanParameterInfo} interface
023: * (typically {@link OpenMBeanParameterInfoSupport}).</p>
024: *
025: * @author <a href="mailto:young_yy@hotmail.org">Young Yang</a>
026: */
027:
028: public interface OpenMBeanOperationInfo {
029:
030: // Re-declares fields and methods that are in class MBeanOperationInfo of JMX 1.0
031: // (fields and methods will be removed when MBeanOperationInfo is made a parent interface of this interface)
032:
033: /**
034: * Returns a human readable description of the operation
035: * described by this <tt>OpenMBeanOperationInfo</tt> instance.
036: *
037: * @return the description.
038: */
039: public String getDescription();
040:
041: /**
042: * Returns the name of the operation
043: * described by this <tt>OpenMBeanOperationInfo</tt> instance.
044: *
045: * @return the name.
046: */
047: public String getName();
048:
049: /**
050: * Returns an array of <tt>OpenMBeanParameterInfo</tt> instances
051: * describing each parameter in the signature of the operation
052: * described by this <tt>OpenMBeanOperationInfo</tt> instance.
053: * Each instance in the returned array should actually be a
054: * subclass of <tt>MBeanParameterInfo</tt> which implements the
055: * <tt>OpenMBeanParameterInfo</tt> interface (typically {@link
056: * OpenMBeanParameterInfoSupport}).
057: *
058: * @return the signature.
059: */
060: public MBeanParameterInfo[] getSignature();
061:
062: /**
063: * Returns an <tt>int</tt> constant qualifying the impact of the
064: * operation described by this <tt>OpenMBeanOperationInfo</tt>
065: * instance.
066: *
067: * The returned constant is one of {@link
068: * javax.management.MBeanOperationInfo#INFO}, {@link
069: * javax.management.MBeanOperationInfo#ACTION} or {@link
070: * javax.management.MBeanOperationInfo#ACTION_INFO}.
071: *
072: * @return the impact code.
073: */
074: public int getImpact();
075:
076: /**
077: * Returns the fully qualified Java class name of the values
078: * returned by the operation described by this
079: * <tt>OpenMBeanOperationInfo</tt> instance. This method should
080: * return the same value as a call to
081: * <tt>getReturnOpenType().getClassName()</tt>.
082: *
083: * @return the return type.
084: */
085: public String getReturnType();
086:
087: // Now declares methods that are specific to open MBeans
088: //
089:
090: /**
091: * Returns the <i>open type</i> of the values returned by the
092: * operation described by this <tt>OpenMBeanOperationInfo</tt>
093: * instance.
094: *
095: * @return the return type.
096: */
097: public OpenType getReturnOpenType(); // open MBean specific method
098:
099: // commodity methods
100: //
101:
102: /**
103: * Compares the specified <var>obj</var> parameter with this <code>OpenMBeanOperationInfo</code> instance for equality.
104: * <p>
105: * Returns <tt>true</tt> if and only if all of the following statements are true:
106: * <ul>
107: * <li><var>obj</var> is non null,</li>
108: * <li><var>obj</var> also implements the <code>OpenMBeanOperationInfo</code> interface,</li>
109: * <li>their names are equal</li>
110: * <li>their signatures are equal</li>
111: * <li>their return open types are equal</li>
112: * <li>their impacts are equal</li>
113: * </ul>
114: * This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
115: * different implementations of the <code>OpenMBeanOperationInfo</code> interface.
116: * <br>
117: * @param obj the object to be compared for equality with this <code>OpenMBeanOperationInfo</code> instance;
118: *
119: * @return <code>true</code> if the specified object is equal to this <code>OpenMBeanOperationInfo</code> instance.
120: */
121: public boolean equals(Object obj);
122:
123: /**
124: * Returns the hash code value for this <code>OpenMBeanOperationInfo</code> instance.
125: * <p>
126: * The hash code of an <code>OpenMBeanOperationInfo</code> instance is the sum of the hash codes
127: * of all elements of information used in <code>equals</code> comparisons
128: * (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to
129: * <tt>java.util.Arrays.asList(this.getSignature).hashCode()</tt>).
130: * <p>
131: * This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
132: * for any two <code>OpenMBeanOperationInfo</code> instances <code>t1</code> and <code>t2</code>,
133: * as required by the general contract of the method
134: * {@link <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">
135: * <code>Object.hashCode</code> </a>}.
136: * <p>
137: *
138: * @return the hash code value for this <code>OpenMBeanOperationInfo</code> instance
139: */
140: public int hashCode();
141:
142: /**
143: * Returns a string representation of this <code>OpenMBeanOperationInfo</code> instance.
144: * <p>
145: * The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanOperationInfo</code>),
146: * and the name, signature, return open type and impact of the described operation.
147: *
148: * @return a string representation of this <code>OpenMBeanOperationInfo</code> instance
149: */
150: public String toString();
151:
152: }
|