Google Git
Sign in
apache / axis-site / f545f87a6b723b56329b1ebb949e3b91067c8436 / . / axis / java / apiDocs / org / apache / axis / Handler.html
blob: ebf30059257d1c7a0c2899fa0f3fa04fdaa915e8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Handler (Apache Axis)</title>
<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="Handler (Apache Axis)";
}
//-->
</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/Handler.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="../../../org/apache/axis/FaultableHandler.html" title="class in org.apache.axis"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/axis/HandlerIterationStrategy.html" title="interface in org.apache.axis"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/axis/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">org.apache.axis</div>
<h2 title="Interface Handler" class="title">Interface Handler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/apache/axis/Chain.html" title="interface in org.apache.axis">Chain</a>, <a href="../../../org/apache/axis/TargetedChain.html" title="interface in org.apache.axis">TargetedChain</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/axis/client/AxisClient.html" title="class in org.apache.axis.client">AxisClient</a>, <a href="../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>, <a href="../../../org/apache/axis/server/AxisServer.html" title="class in org.apache.axis.server">AxisServer</a>, <a href="../../../org/apache/axis/handlers/BasicHandler.html" title="class in org.apache.axis.handlers">BasicHandler</a>, <a href="../../../org/apache/axis/providers/BasicProvider.html" title="class in org.apache.axis.providers">BasicProvider</a>, <a href="../../../org/apache/axis/providers/BSFProvider.html" title="class in org.apache.axis.providers">BSFProvider</a>, <a href="../../../org/apache/axis/transport/http/CommonsHTTPSender.html" title="class in org.apache.axis.transport.http">CommonsHTTPSender</a>, <a href="../../../org/apache/axis/providers/ComProvider.html" title="class in org.apache.axis.providers">ComProvider</a>, <a href="../../../org/apache/axis/providers/java/CORBAProvider.html" title="class in org.apache.axis.providers.java">CORBAProvider</a>, <a href="../../../org/apache/axis/handlers/DebugHandler.html" title="class in org.apache.axis.handlers">DebugHandler</a>, <a href="../../../org/apache/axis/handlers/EchoHandler.html" title="class in org.apache.axis.handlers">EchoHandler</a>, <a href="../../../org/apache/axis/providers/java/EJBProvider.html" title="class in org.apache.axis.providers.java">EJBProvider</a>, <a href="../../../org/apache/axis/handlers/ErrorHandler.html" title="class in org.apache.axis.handlers">ErrorHandler</a>, <a href="../../../org/apache/axis/FaultableHandler.html" title="class in org.apache.axis">FaultableHandler</a>, <a href="../../../org/apache/axis/handlers/http/HTTPActionHandler.html" title="class in org.apache.axis.handlers.http">HTTPActionHandler</a>, <a href="../../../org/apache/axis/handlers/http/HTTPAuthHandler.html" title="class in org.apache.axis.handlers.http">HTTPAuthHandler</a>, <a href="../../../org/apache/axis/transport/http/HTTPSender.html" title="class in org.apache.axis.transport.http">HTTPSender</a>, <a href="../../../org/apache/axis/transport/http/javanet/JavaNetHTTPSender.html" title="class in org.apache.axis.transport.http.javanet">JavaNetHTTPSender</a>, <a href="../../../org/apache/axis/providers/java/JavaProvider.html" title="class in org.apache.axis.providers.java">JavaProvider</a>, <a href="../../../org/apache/axis/transport/java/JavaSender.html" title="class in org.apache.axis.transport.java">JavaSender</a>, <a href="../../../org/apache/axis/handlers/JAXRPCHandler.html" title="class in org.apache.axis.handlers">JAXRPCHandler</a>, <a href="../../../org/apache/axis/transport/jms/JMSSender.html" title="class in org.apache.axis.transport.jms">JMSSender</a>, <a href="../../../org/apache/axis/handlers/JWSHandler.html" title="class in org.apache.axis.handlers">JWSHandler</a>, <a href="../../../org/apache/axis/transport/local/LocalResponder.html" title="class in org.apache.axis.transport.local">LocalResponder</a>, <a href="../../../org/apache/axis/transport/local/LocalSender.html" title="class in org.apache.axis.transport.local">LocalSender</a>, <a href="../../../org/apache/axis/handlers/LogHandler.html" title="class in org.apache.axis.handlers">LogHandler</a>, <a href="../../../org/apache/axis/handlers/LogMessage.html" title="class in org.apache.axis.handlers">LogMessage</a>, <a href="../../../org/apache/axis/transport/mail/MailSender.html" title="class in org.apache.axis.transport.mail">MailSender</a>, <a href="../../../org/apache/axis/handlers/MD5AttachHandler.html" title="class in org.apache.axis.handlers">MD5AttachHandler</a>, <a href="../../../org/apache/axis/providers/java/MsgProvider.html" title="class in org.apache.axis.providers.java">MsgProvider</a>, <a href="../../../org/apache/axis/handlers/soap/MustUnderstandChecker.html" title="class in org.apache.axis.handlers.soap">MustUnderstandChecker</a>, <a href="../../../org/apache/axis/server/standalone/QuitHandler.html" title="class in org.apache.axis.server.standalone">QuitHandler</a>, <a href="../../../org/apache/axis/providers/java/RMIProvider.html" title="class in org.apache.axis.providers.java">RMIProvider</a>, <a href="../../../org/apache/axis/providers/java/RPCProvider.html" title="class in org.apache.axis.providers.java">RPCProvider</a>, <a href="../../../org/apache/axis/handlers/SimpleAuthenticationHandler.html" title="class in org.apache.axis.handlers">SimpleAuthenticationHandler</a>, <a href="../../../org/apache/axis/handlers/SimpleAuthorizationHandler.html" title="class in org.apache.axis.handlers">SimpleAuthorizationHandler</a>, <a href="../../../org/apache/axis/SimpleChain.html" title="class in org.apache.axis">SimpleChain</a>, <a href="../../../org/apache/axis/handlers/SimpleSessionHandler.html" title="class in org.apache.axis.handlers">SimpleSessionHandler</a>, <a href="../../../org/apache/axis/SimpleTargetedChain.html" title="class in org.apache.axis">SimpleTargetedChain</a>, <a href="../../../org/apache/axis/handlers/SOAPMonitorHandler.html" title="class in org.apache.axis.handlers">SOAPMonitorHandler</a>, <a href="../../../org/apache/axis/handlers/soap/SOAPService.html" title="class in org.apache.axis.handlers.soap">SOAPService</a>, <a href="../../../org/apache/axis/server/Transport.html" title="class in org.apache.axis.server">Transport</a>, <a href="../../../org/apache/axis/handlers/http/URLMapper.html" title="class in org.apache.axis.handlers.http">URLMapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Handler</span>
extends <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">An AXIS handler.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Doug Davis (dug@us.ibm.com)</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#canHandleBlock(javax.xml.namespace.QName)">canHandleBlock</a></strong>(<a href="../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;qname)</code>
<div class="block">Indicate if this handler can process <code>qname</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#cleanup()">cleanup</a></strong>()</code>
<div class="block">Cleanup is called when the chain containing this Handler object
is done processing the chain.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#generateWSDL(org.apache.axis.MessageContext)">generateWSDL</a></strong>(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">Obtain WSDL information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#getDeploymentData(org.w3c.dom.Document)">getDeploymentData</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a>&nbsp;doc)</code>
<div class="block">This will return the root element of an XML doc that describes the
deployment information about this handler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#getName()">getName</a></strong>()</code>
<div class="block">Return the name (i.e. registry key) for this <code>Handler</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#getOption(java.lang.String)">getOption</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the option corresponding to the 'name' given.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#getOptions()">getOptions</a></strong>()</code>
<div class="block">Return the entire list of options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#getUnderstoodHeaders()">getUnderstoodHeaders</a></strong>()</code>
<div class="block">Return a list of QNames which this Handler understands.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#init()">init</a></strong>()</code>
<div class="block">Init is called when the chain containing this Handler object
is instantiated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#invoke(org.apache.axis.MessageContext)">invoke</a></strong>(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">Invoke is called to do the actual work of the Handler object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#onFault(org.apache.axis.MessageContext)">onFault</a></strong>(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">Called when a subsequent handler throws a fault.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#setName(java.lang.String)">setName</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Set the name (i.e. registry key) of this Handler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#setOption(java.lang.String,%20java.lang.Object)">setOption</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Add the given option (name/value) to this handler's bag of options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/axis/Handler.html#setOptions(java.util.Hashtable)">setOptions</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</a>&nbsp;opts)</code>
<div class="block">Sets a whole list of options.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init()</pre>
<div class="block">Init is called when the chain containing this Handler object
is instantiated.</div>
</li>
</ul>
<a name="cleanup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanup</h4>
<pre>void&nbsp;cleanup()</pre>
<div class="block">Cleanup is called when the chain containing this Handler object
is done processing the chain.</div>
</li>
</ul>
<a name="invoke(org.apache.axis.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invoke</h4>
<pre>void&nbsp;invoke(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Invoke is called to do the actual work of the Handler object.
If there is a fault during the processing of this method it is
invoke's job to catch the exception and undo any partial work
that has been completed. Once we leave 'invoke' if a fault
is thrown, this classes 'onFault' method will be called.
Invoke should rethrow any exceptions it catches, wrapped in
an AxisFault.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process with this
<code>Handler</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if the handler encounters an error</dd></dl>
</li>
</ul>
<a name="onFault(org.apache.axis.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFault</h4>
<pre>void&nbsp;onFault(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)</pre>
<div class="block">Called when a subsequent handler throws a fault.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process the fault
to</dd></dl>
</li>
</ul>
<a name="canHandleBlock(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canHandleBlock</h4>
<pre>boolean&nbsp;canHandleBlock(<a href="../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;qname)</pre>
<div class="block">Indicate if this handler can process <code>qname</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qname</code> - the <code>QName</code> to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this <code>Handler</code> can handle <code>qname<code>,
false otherwise</dd></dl>
</li>
</ul>
<a name="getUnderstoodHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnderstoodHeaders</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;getUnderstoodHeaders()</pre>
<div class="block">Return a list of QNames which this Handler understands. By returning
a particular QName here, we are committing to fulfilling any contracts
defined in the specification of the SOAP header with that QName.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a List of <code>QName</code> instances</dd></dl>
</li>
</ul>
<a name="setOption(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOption</h4>
<pre>void&nbsp;setOption(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Add the given option (name/value) to this handler's bag of options.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the option</dd><dd><code>value</code> - the new value of the option</dd></dl>
</li>
</ul>
<a name="getOption(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOption</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getOption(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns the option corresponding to the 'name' given.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the option</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of the option</dd></dl>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void&nbsp;setName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Set the name (i.e. registry key) of this Handler.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the new name</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Return the name (i.e. registry key) for this <code>Handler</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name for this <code>Handler</code></dd></dl>
</li>
</ul>
<a name="getOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptions</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</a>&nbsp;getOptions()</pre>
<div class="block">Return the entire list of options.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>Hashset</code> containing all name/value pairs</dd></dl>
</li>
</ul>
<a name="setOptions(java.util.Hashtable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOptions</h4>
<pre>void&nbsp;setOptions(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</a>&nbsp;opts)</pre>
<div class="block">Sets a whole list of options.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opts</code> - a <code>Hashtable</code> of name-value pairs to use</dd></dl>
</li>
</ul>
<a name="getDeploymentData(org.w3c.dom.Document)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeploymentData</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a>&nbsp;getDeploymentData(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a>&nbsp;doc)</pre>
<div class="block">This will return the root element of an XML doc that describes the
deployment information about this handler. This is NOT the WSDL,
this is all of the static internal data use by Axis - WSDL takes into
account run-time information (like which service we're talking about)
this is just the data that's stored in the registry. Used by the
'list' Admin function.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doc</code> - a <code>Document</code> within which to build the deployment
data</dd>
<dt><span class="strong">Returns:</span></dt><dd>an Element representing the deployment data</dd></dl>
</li>
</ul>
<a name="generateWSDL(org.apache.axis.MessageContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateWSDL</h4>
<pre>void&nbsp;generateWSDL(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Obtain WSDL information. Some Handlers will implement this by
merely setting properties in the MessageContext, others (providers)
will take responsibility for doing the "real work" of generating
WSDL for a given service.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to generate the WSDL
to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if there was a problem generating the WSDL</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/Handler.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="../../../org/apache/axis/FaultableHandler.html" title="class in org.apache.axis"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/axis/HandlerIterationStrategy.html" title="interface in org.apache.axis"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/axis/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>