| <!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>BasicHandler (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="BasicHandler (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/BasicHandler.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>Prev Class</li> |
| <li><a href="../../../../org/apache/axis/handlers/DebugHandler.html" title="class in org.apache.axis.handlers"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis/handlers/BasicHandler.html" target="_top">Frames</a></li> |
| <li><a href="BasicHandler.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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">org.apache.axis.handlers</div> |
| <h2 title="Class BasicHandler" class="title">Class BasicHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis.handlers.BasicHandler</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</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>, <a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/axis/AxisEngine.html" title="class in org.apache.axis">AxisEngine</a>, <a href="../../../../org/apache/axis/providers/BasicProvider.html" title="class in org.apache.axis.providers">BasicProvider</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/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/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/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/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/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/handlers/SOAPMonitorHandler.html" title="class in org.apache.axis.handlers">SOAPMonitorHandler</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 abstract class <span class="strong">BasicHandler</span> |
| extends <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> |
| implements <a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></pre> |
| <div class="block"><code>BasicHandler</code> is a utility class which implements simple |
| property setting/getting behavior, and stubs out a lot of the Handler |
| methods. Extend this class to make writing your Handlers easier, and |
| then override what you need to.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Glen Daniels (gdaniels@allaire.com), Doug Davis (dug@us.ibm.com</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.axis.handlers.BasicHandler">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#makeLockable">makeLockable</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/handlers/BasicHandler.html#name">name</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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/handlers/BasicHandler.html#options">options</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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="../../../../org/apache/axis/handlers/BasicHandler.html#BasicHandler()">BasicHandler</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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#canHandleBlock(javax.xml.namespace.QName)">canHandleBlock</a></strong>(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a> 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/handlers/BasicHandler.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/handlers/BasicHandler.html#generateWSDL(org.apache.axis.MessageContext)">generateWSDL</a></strong>(<a href="../../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> 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/handlers/BasicHandler.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> 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/handlers/BasicHandler.html#getName()">getName</a></strong>()</code> |
| <div class="block">Return the name (i.e. registry key) for this Handler</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/handlers/BasicHandler.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> 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/handlers/BasicHandler.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/handlers/BasicHandler.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/handlers/BasicHandler.html#init()">init</a></strong>()</code> |
| <div class="block">Stubbed-out methods.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#initHashtable()">initHashtable</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#onFault(org.apache.axis.MessageContext)">onFault</a></strong>(<a href="../../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> 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/handlers/BasicHandler.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> 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/handlers/BasicHandler.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> 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> value)</code> |
| <div class="block">Set the given option (name/value) in this handler's bag of options</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#setOptionDefault(java.lang.String,%20java.lang.Object)">setOptionDefault</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> 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> value)</code> |
| <div class="block">Set a default value for the given option: |
| if the option is not already set, then set it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.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> opts)</code> |
| <div class="block">Sets a whole list of options.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/handlers/BasicHandler.html#setOptionsLockable(boolean)">setOptionsLockable</a></strong>(boolean makeLockable)</code> |
| <div class="block">Should this Handler use a LockableHashtable for options?</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.<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></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.axis.Handler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axis.<a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></h3> |
| <code><a href="../../../../org/apache/axis/Handler.html#invoke(org.apache.axis.MessageContext)">invoke</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="makeLockable"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeLockable</h4> |
| <pre>protected boolean makeLockable</pre> |
| </li> |
| </ul> |
| <a name="options"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>options</h4> |
| <pre>protected <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> options</pre> |
| </li> |
| </ul> |
| <a name="name"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>protected <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> name</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BasicHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BasicHandler</h4> |
| <pre>public BasicHandler()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setOptionsLockable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptionsLockable</h4> |
| <pre>protected void setOptionsLockable(boolean makeLockable)</pre> |
| <div class="block">Should this Handler use a LockableHashtable for options? |
| Default is 'false'.</div> |
| </li> |
| </ul> |
| <a name="initHashtable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initHashtable</h4> |
| <pre>protected void initHashtable()</pre> |
| </li> |
| </ul> |
| <a name="init()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void init()</pre> |
| <div class="block">Stubbed-out methods. Override in your child class to implement |
| any real behavior. Note that there is NOT a stub for invoke(), since |
| we require any Handler derivative to implement that.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#init()">init</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre>public void cleanup()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#cleanup()">Handler</a></code></strong></div> |
| <div class="block">Cleanup is called when the chain containing this Handler object |
| is done processing the chain.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#cleanup()">cleanup</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canHandleBlock(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleBlock</h4> |
| <pre>public boolean canHandleBlock(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a> qname)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#canHandleBlock(javax.xml.namespace.QName)">Handler</a></code></strong></div> |
| <div class="block">Indicate if this handler can process <code>qname</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#canHandleBlock(javax.xml.namespace.QName)">canHandleBlock</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="onFault(org.apache.axis.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onFault</h4> |
| <pre>public void onFault(<a href="../../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> msgContext)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#onFault(org.apache.axis.MessageContext)">Handler</a></code></strong></div> |
| <div class="block">Called when a subsequent handler throws a fault.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#onFault(org.apache.axis.MessageContext)">onFault</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="setOption(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOption</h4> |
| <pre>public void 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> 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> value)</pre> |
| <div class="block">Set the given option (name/value) in this handler's bag of options</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#setOption(java.lang.String,%20java.lang.Object)">setOption</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="setOptionDefault(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptionDefault</h4> |
| <pre>public boolean setOptionDefault(<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> 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> value)</pre> |
| <div class="block">Set a default value for the given option: |
| if the option is not already set, then set it. |
| if the option is already set, then do not set it. |
| <p> |
| If this is called multiple times, the first with a non-null value |
| if 'value' will set the default, remaining calls will be ignored. |
| <p> |
| Returns true if value set (by this call), otherwise false;</div> |
| </li> |
| </ul> |
| <a name="getOption(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOption</h4> |
| <pre>public <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> 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> name)</pre> |
| <div class="block">Returns the option corresponding to the 'name' given</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#getOption(java.lang.String)">getOption</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="getOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptions</h4> |
| <pre>public <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> getOptions()</pre> |
| <div class="block">Return the entire list of options</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#getOptions()">getOptions</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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>public void 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> opts)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#setOptions(java.util.Hashtable)">Handler</a></code></strong></div> |
| <div class="block">Sets a whole list of options.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#setOptions(java.util.Hashtable)">setOptions</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void 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> name)</pre> |
| <div class="block">Set the name (i.e. registry key) of this Handler</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#setName(java.lang.String)">setName</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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>public <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> getName()</pre> |
| <div class="block">Return the name (i.e. registry key) for this Handler</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#getName()">getName</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the name for this <code>Handler</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getDeploymentData(org.w3c.dom.Document)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeploymentData</h4> |
| <pre>public <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> 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> doc)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#getDeploymentData(org.w3c.dom.Document)">Handler</a></code></strong></div> |
| <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#getDeploymentData(org.w3c.dom.Document)">getDeploymentData</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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="blockList"> |
| <li class="blockList"> |
| <h4>generateWSDL</h4> |
| <pre>public void generateWSDL(<a href="../../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> msgContext) |
| throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/axis/Handler.html#generateWSDL(org.apache.axis.MessageContext)">Handler</a></code></strong></div> |
| <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#generateWSDL(org.apache.axis.MessageContext)">generateWSDL</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <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> |
| <a name="getUnderstoodHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUnderstoodHeaders</h4> |
| <pre>public <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> 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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/axis/Handler.html#getUnderstoodHeaders()">getUnderstoodHeaders</a></code> in interface <code><a href="../../../../org/apache/axis/Handler.html" title="interface in org.apache.axis">Handler</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a List of <code>QName</code> instances</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/BasicHandler.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>Prev Class</li> |
| <li><a href="../../../../org/apache/axis/handlers/DebugHandler.html" title="class in org.apache.axis.handlers"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis/handlers/BasicHandler.html" target="_top">Frames</a></li> |
| <li><a href="BasicHandler.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
