<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>HttpAdaptorMBeanDescription (MX4J API)</title>
<meta name="date" content="2013-10-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpAdaptorMBeanDescription (MX4J API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpAdaptorMBeanDescription.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBean.html" title="interface in mx4j.tools.adaptor.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../mx4j/tools/adaptor/http/HttpCommandProcessor.html" title="interface in mx4j.tools.adaptor.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html" target="_top">Frames</a></li>
<li><a href="HttpAdaptorMBeanDescription.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mx4j.tools.adaptor.http</div>
<h2 title="Class HttpAdaptorMBeanDescription" class="title">Class HttpAdaptorMBeanDescription</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">mx4j.MBeanDescriptionAdapter</a></li>
<li>
<ul class="inheritance">
<li>mx4j.tools.adaptor.http.HttpAdaptorMBeanDescription</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">HttpAdaptorMBeanDescription</span>
extends <a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></pre>
<div class="block">Management interface descriptions for the HttpAdaptor MBean.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.3 $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#HttpAdaptorMBeanDescription()">HttpAdaptorMBeanDescription</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getAttributeDescription(java.lang.String)">getAttributeDescription</a></strong>(java.lang.String attribute)</code>
<div class="block">Should return the description for the specified attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getConstructorDescription(java.lang.reflect.Constructor)">getConstructorDescription</a></strong>(java.lang.reflect.Constructor ctor)</code>
<div class="block">Should return the description for the given constructor of the MBean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getConstructorParameterDescription(java.lang.reflect.Constructor, int)">getConstructorParameterDescription</a></strong>(java.lang.reflect.Constructor ctor,
int index)</code>
<div class="block">Should return the description for the constructor's parameter for the given constructor and parameter index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getConstructorParameterName(java.lang.reflect.Constructor, int)">getConstructorParameterName</a></strong>(java.lang.reflect.Constructor ctor,
int index)</code>
<div class="block">Should return the name of the constructor's parameter for the given constructor and parameter index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getMBeanDescription()">getMBeanDescription</a></strong>()</code>
<div class="block">Should return the description of the MBean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getOperationDescription(java.lang.reflect.Method)">getOperationDescription</a></strong>(java.lang.reflect.Method operation)</code>
<div class="block">Should return the description for the specified operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getOperationParameterDescription(java.lang.reflect.Method, int)">getOperationParameterDescription</a></strong>(java.lang.reflect.Method method,
int index)</code>
<div class="block">Should return the description for the operations's parameter for the given operation and parameter index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html#getOperationParameterName(java.lang.reflect.Method, int)">getOperationParameterName</a></strong>(java.lang.reflect.Method method,
int index)</code>
<div class="block">Should return the name of the operation's parameter for the given operation and parameter index.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HttpAdaptorMBeanDescription()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HttpAdaptorMBeanDescription</h4>
<pre>public HttpAdaptorMBeanDescription()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMBeanDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMBeanDescription</h4>
<pre>public java.lang.String getMBeanDescription()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getMBeanDescription()">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description of the MBean.
For example: "This MBean is the rmiregistry service"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getMBeanDescription()">getMBeanDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getMBeanDescription()">getMBeanDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getConstructorDescription(java.lang.reflect.Constructor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstructorDescription</h4>
<pre>public java.lang.String getConstructorDescription(java.lang.reflect.Constructor ctor)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getConstructorDescription(java.lang.reflect.Constructor)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description for the given constructor of the MBean.
For example: "Creates an rmiregistry instance on the specified port"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getConstructorDescription(java.lang.reflect.Constructor)">getConstructorDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getConstructorDescription(java.lang.reflect.Constructor)">getConstructorDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getConstructorParameterName(java.lang.reflect.Constructor, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstructorParameterName</h4>
<pre>public java.lang.String getConstructorParameterName(java.lang.reflect.Constructor ctor,
int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getConstructorParameterName(java.lang.reflect.Constructor, int)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the name of the constructor's parameter for the given constructor and parameter index.
For example: "port"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getConstructorParameterName(java.lang.reflect.Constructor, int)">getConstructorParameterName</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getConstructorParameterName(java.lang.reflect.Constructor, int)">getConstructorParameterName</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getConstructorParameterDescription(java.lang.reflect.Constructor, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstructorParameterDescription</h4>
<pre>public java.lang.String getConstructorParameterDescription(java.lang.reflect.Constructor ctor,
int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getConstructorParameterDescription(java.lang.reflect.Constructor, int)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description for the constructor's parameter for the given constructor and parameter index.
For example: "The port on which the rmiregistry will wait on for client requests"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getConstructorParameterDescription(java.lang.reflect.Constructor, int)">getConstructorParameterDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getConstructorParameterDescription(java.lang.reflect.Constructor, int)">getConstructorParameterDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getAttributeDescription(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeDescription</h4>
<pre>public java.lang.String getAttributeDescription(java.lang.String attribute)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getAttributeDescription(java.lang.String)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description for the specified attribute.
For example: "The port on which the rmiregistry will wait on for client requests"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getAttributeDescription(java.lang.String)">getAttributeDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getAttributeDescription(java.lang.String)">getAttributeDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getOperationDescription(java.lang.reflect.Method)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationDescription</h4>
<pre>public java.lang.String getOperationDescription(java.lang.reflect.Method operation)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getOperationDescription(java.lang.reflect.Method)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description for the specified operation.
For example: "Binds the given object to the given name"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getOperationDescription(java.lang.reflect.Method)">getOperationDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getOperationDescription(java.lang.reflect.Method)">getOperationDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getOperationParameterName(java.lang.reflect.Method, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationParameterName</h4>
<pre>public java.lang.String getOperationParameterName(java.lang.reflect.Method method,
int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getOperationParameterName(java.lang.reflect.Method, int)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the name of the operation's parameter for the given operation and parameter index.
For example: "bindName"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getOperationParameterName(java.lang.reflect.Method, int)">getOperationParameterName</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getOperationParameterName(java.lang.reflect.Method, int)">getOperationParameterName</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
<a name="getOperationParameterDescription(java.lang.reflect.Method, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOperationParameterDescription</h4>
<pre>public java.lang.String getOperationParameterDescription(java.lang.reflect.Method method,
int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../mx4j/MBeanDescription.html#getOperationParameterDescription(java.lang.reflect.Method, int)">MBeanDescription</a></code></strong></div>
<div class="block">Should return the description for the operations's parameter for the given operation and parameter index.
For example: "The name to which the object will be bound to"</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescription.html#getOperationParameterDescription(java.lang.reflect.Method, int)">getOperationParameterDescription</a></code> in interface <code><a href="../../../../mx4j/MBeanDescription.html" title="interface in mx4j">MBeanDescription</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../mx4j/MBeanDescriptionAdapter.html#getOperationParameterDescription(java.lang.reflect.Method, int)">getOperationParameterDescription</a></code> in class <code><a href="../../../../mx4j/MBeanDescriptionAdapter.html" title="class in mx4j">MBeanDescriptionAdapter</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpAdaptorMBeanDescription.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../mx4j/tools/adaptor/http/HttpAdaptorMBean.html" title="interface in mx4j.tools.adaptor.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../mx4j/tools/adaptor/http/HttpCommandProcessor.html" title="interface in mx4j.tools.adaptor.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?mx4j/tools/adaptor/http/HttpAdaptorMBeanDescription.html" target="_top">Frames</a></li>
<li><a href="HttpAdaptorMBeanDescription.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
