blob: cd7209444c29eb60dd3add919f258f9e14fef8e1 [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>
<title>GenericHandler</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GenericHandler";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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&nbsp;Class</li>
<li><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/rpc/handler/GenericHandler.html" target="_top">Frames</a></li>
<li><a href="GenericHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">javax.xml.rpc.handler</div>
<h2 title="Class GenericHandler" class="title">Class GenericHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.xml.rpc.handler.GenericHandler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">GenericHandler</span>
extends java.lang.Object
implements <a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></pre>
<div class="block">The <code>javax.xml.rpc.handler.GenericHandler</code> class
implements the <code>Handler</code> interface. SOAP Message
Handler developers should typically subclass
<code>GenericHandler</code> class unless the Handler class
needs another class as a superclass.
<p>The <code>GenericHandler</code> class is a convenience abstract
class that makes writing Handlers easy. This class provides
default implementations of the lifecycle methods <code>init</code>
and <code>destroy</code> and also different handle methods.
A Handler developer should only override methods that it needs
to specialize as part of the derived <code>Handler</code>
implementation class.</div>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#GenericHandler--">GenericHandler</a></span>()</code>
<div class="block">Default constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#destroy--">destroy</a></span>()</code>
<div class="block">The <code>destroy</code> method indicates the end of lifecycle
for a Handler instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract javax.xml.namespace.QName[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#getHeaders--">getHeaders</a></span>()</code>
<div class="block">Gets the header blocks processed by this Handler instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#handleFault-javax.xml.rpc.handler.MessageContext-">handleFault</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</code>
<div class="block">The <code>handleFault</code> method processes the SOAP faults
based on the SOAP message processing model.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#handleRequest-javax.xml.rpc.handler.MessageContext-">handleRequest</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</code>
<div class="block">The <code>handleRequest</code> method processes the request
SOAP message.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#handleResponse-javax.xml.rpc.handler.MessageContext-">handleResponse</a></span>(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</code>
<div class="block">The <code>handleResponse</code> method processes the response
message.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/GenericHandler.html#init-javax.xml.rpc.handler.HandlerInfo-">init</a></span>(<a href="../../../../javax/xml/rpc/handler/HandlerInfo.html" title="class in javax.xml.rpc.handler">HandlerInfo</a>&nbsp;config)</code>
<div class="block">The <code>init</code> method to enable the Handler instance to
initialize itself.</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&nbsp;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="GenericHandler--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GenericHandler</h4>
<pre>protected&nbsp;GenericHandler()</pre>
<div class="block">Default constructor</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="handleRequest-javax.xml.rpc.handler.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleRequest</h4>
<pre>public&nbsp;boolean&nbsp;handleRequest(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</pre>
<div class="block">The <code>handleRequest</code> method processes the request
SOAP message. The default implementation of this method returns
<code>true</code>. This indicates that the handler chain
should continue processing of the request SOAP message.
This method should be overridden if the derived Handler class
needs to specialize implementation of this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#handleRequest-javax.xml.rpc.handler.MessageContext-">handleRequest</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <code>MessageContext</code> parameter provides
access to the request message.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean Indicates the processing mode
<UL>
<LI>Return <code>true</code> to indicate continued
processing of the request handler chain. The
<code>HandlerChain</code>
takes the responsibility of invoking the next
entity. The next entity may be the next handler
in the <code>HandlerChain</code> or if this
handler is the last handler in the chain, the
next entity is the service endpoint object.
<LI>Return <code>false</code> to indicate blocking
of the request handler chain. In this case,
further processing of the request handler chain
is blocked and the target service endpoint is
not dispatched. The JAX-RPC runtime system takes
the responsibility of invoking the response
handler chain next with the SOAPMessageContext.
The Handler implementation class has the the
responsibility of setting the appropriate response
SOAP message in either handleRequest and/or
handleResponse method. In the default processing
model, the response handler chain starts processing
from the same Handler instance (that returned false)
and goes backward in the execution sequence.
</UL></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleRequest-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleRequest(javax.xml.rpc.handler.MessageContext)</code></a></dd>
</dl>
</li>
</ul>
<a name="handleResponse-javax.xml.rpc.handler.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleResponse</h4>
<pre>public&nbsp;boolean&nbsp;handleResponse(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</pre>
<div class="block">The <code>handleResponse</code> method processes the response
message. The default implementation of this method returns
<code>true</code>. This indicates that the handler chain
should continue processing of the response SOAP message.
This method should be overridden if the derived Handler class
needs to specialize implementation of this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#handleResponse-javax.xml.rpc.handler.MessageContext-">handleResponse</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - MessageContext parameter provides access to
the response SOAP message</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean Indicates the processing mode
<UL>
<LI>Return <code>true</code> to indicate continued
processing ofthe response handler chain. The
HandlerChain invokes the <code>handleResponse</code>
method on the next <code>Handler</code> in
the handler chain.
<LI>Return <code>false</code> to indicate blocking
of the response handler chain. In this case, no
other response handlers in the handler chain
are invoked.
</UL></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleResponse-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleResponse(javax.xml.rpc.handler.MessageContext)</code></a></dd>
</dl>
</li>
</ul>
<a name="handleFault-javax.xml.rpc.handler.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleFault</h4>
<pre>public&nbsp;boolean&nbsp;handleFault(<a href="../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a>&nbsp;context)</pre>
<div class="block">The <code>handleFault</code> method processes the SOAP faults
based on the SOAP message processing model. The default
implementation of this method returns <code>true</code>. This
indicates that the handler chain should continue processing
of the SOAP fault. This method should be overridden if
the derived Handler class needs to specialize implementation
of this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#handleFault-javax.xml.rpc.handler.MessageContext-">handleFault</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - MessageContext parameter provides access to
the SOAP message</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean Indicates the processing mode
<UL>
<LI>Return <code>true</code> to indicate continued
processing of SOAP Fault. The HandlerChain invokes
the <code>handleFault</code> method on the
next <code>Handler</code> in the handler chain.
<LI>Return <code>false</code> to indicate end
of the SOAP fault processing. In this case, no
other handlers in the handler chain
are invoked.
</UL></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html#handleFault-javax.xml.rpc.handler.MessageContext-"><code>Handler.handleFault(javax.xml.rpc.handler.MessageContext)</code></a></dd>
</dl>
</li>
</ul>
<a name="init-javax.xml.rpc.handler.HandlerInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../../../../javax/xml/rpc/handler/HandlerInfo.html" title="class in javax.xml.rpc.handler">HandlerInfo</a>&nbsp;config)</pre>
<div class="block">The <code>init</code> method to enable the Handler instance to
initialize itself. This method should be overridden if
the derived Handler class needs to specialize implementation
of this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#init-javax.xml.rpc.handler.HandlerInfo-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - Configuration for the initialization of
this handler</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html#init-javax.xml.rpc.handler.HandlerInfo-"><code>Handler.init(javax.xml.rpc.handler.HandlerInfo)</code></a></dd>
</dl>
</li>
</ul>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public&nbsp;void&nbsp;destroy()</pre>
<div class="block">The <code>destroy</code> method indicates the end of lifecycle
for a Handler instance. This method should be overridden if
the derived Handler class needs to specialize implementation
of this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#destroy--">destroy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/Handler.html#destroy--"><code>Handler.destroy()</code></a></dd>
</dl>
</li>
</ul>
<a name="getHeaders--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHeaders</h4>
<pre>public abstract&nbsp;javax.xml.namespace.QName[]&nbsp;getHeaders()</pre>
<div class="block">Gets the header blocks processed by this Handler instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/handler/Handler.html#getHeaders--">getHeaders</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler">Handler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of QNames of header blocks processed by this
handler instance. <code>QName</code> is the qualified
name of the outermost element of the Header block.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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&nbsp;Class</li>
<li><a href="../../../../javax/xml/rpc/handler/Handler.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/rpc/handler/GenericHandler.html" target="_top">Frames</a></li>
<li><a href="GenericHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>