blob: a30247534d4d574458aace4604dc5b6a9ae62702 [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>HandlerInfo</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="HandlerInfo";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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><a href="../../../../javax/xml/rpc/handler/HandlerChain.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/rpc/handler/HandlerRegistry.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/HandlerInfo.html" target="_top">Frames</a></li>
<li><a href="HandlerInfo.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 HandlerInfo" class="title">Class HandlerInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.xml.rpc.handler.HandlerInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">HandlerInfo</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">The <code>javax.xml.rpc.handler.HandlerInfo</code> represents
information about a handler in the HandlerChain. A HandlerInfo
instance is passed in the <code>Handler.init</code> method to
initialize a <code>Handler</code> instance.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/rpc/handler/HandlerChain.html" title="interface in javax.xml.rpc.handler"><code>HandlerChain</code></a>,
<a href="../../../../serialized-form.html#javax.xml.rpc.handler.HandlerInfo">Serialized Form</a></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="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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#HandlerInfo--">HandlerInfo</a></span>()</code>
<div class="block">Default constructor</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#HandlerInfo-java.lang.Class-java.util.Map-javax.xml.namespace.QName:A-">HandlerInfo</a></span>(java.lang.Class&nbsp;handlerClass,
java.util.Map&nbsp;config,
javax.xml.namespace.QName[]&nbsp;headers)</code>
<div class="block">Constructor for HandlerInfo</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="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>java.lang.Class</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#getHandlerClass--">getHandlerClass</a></span>()</code>
<div class="block">Gets the Handler class</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#getHandlerConfig--">getHandlerConfig</a></span>()</code>
<div class="block">Gets the Handler configuration</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>javax.xml.namespace.QName[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#getHeaders--">getHeaders</a></span>()</code>
<div class="block">Gets the header blocks processed by this Handler.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#setHandlerClass-java.lang.Class-">setHandlerClass</a></span>(java.lang.Class&nbsp;handlerClass)</code>
<div class="block">Sets the Handler class</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/handler/HandlerInfo.html#setHandlerConfig-java.util.Map-">setHandlerConfig</a></span>(java.util.Map&nbsp;config)</code>
<div class="block">Sets the Handler configuration as <code>java.util.Map</code></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/HandlerInfo.html#setHeaders-javax.xml.namespace.QName:A-">setHeaders</a></span>(javax.xml.namespace.QName[]&nbsp;headers)</code>
<div class="block">Sets the header blocks processed by this Handler.</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="HandlerInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HandlerInfo</h4>
<pre>public&nbsp;HandlerInfo()</pre>
<div class="block">Default constructor</div>
</li>
</ul>
<a name="HandlerInfo-java.lang.Class-java.util.Map-javax.xml.namespace.QName:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HandlerInfo</h4>
<pre>public&nbsp;HandlerInfo(java.lang.Class&nbsp;handlerClass,
java.util.Map&nbsp;config,
javax.xml.namespace.QName[]&nbsp;headers)</pre>
<div class="block">Constructor for HandlerInfo</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlerClass</code> - Java Class for the Handler</dd>
<dd><code>config</code> - Handler Configuration as a java.util.Map</dd>
<dd><code>headers</code> - QNames for the header blocks processed
by this Handler. QName is the qualified
name of the outermost element of a header
block</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setHandlerClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandlerClass</h4>
<pre>public&nbsp;void&nbsp;setHandlerClass(java.lang.Class&nbsp;handlerClass)</pre>
<div class="block">Sets the Handler class</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlerClass</code> - Class for the Handler</dd>
</dl>
</li>
</ul>
<a name="getHandlerClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerClass</h4>
<pre>public&nbsp;java.lang.Class&nbsp;getHandlerClass()</pre>
<div class="block">Gets the Handler class</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns null if no Handler class has been
set; otherwise the set handler class</dd>
</dl>
</li>
</ul>
<a name="setHandlerConfig-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandlerConfig</h4>
<pre>public&nbsp;void&nbsp;setHandlerConfig(java.util.Map&nbsp;config)</pre>
<div class="block">Sets the Handler configuration as <code>java.util.Map</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - Configuration map</dd>
</dl>
</li>
</ul>
<a name="getHandlerConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerConfig</h4>
<pre>public&nbsp;java.util.Map&nbsp;getHandlerConfig()</pre>
<div class="block">Gets the Handler configuration</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns empty Map if no configuration map
has been set; otherwise returns the set
configuration map</dd>
</dl>
</li>
</ul>
<a name="setHeaders-javax.xml.namespace.QName:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeaders</h4>
<pre>public&nbsp;void&nbsp;setHeaders(javax.xml.namespace.QName[]&nbsp;headers)</pre>
<div class="block">Sets the header blocks processed by this Handler.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - QNames of the header blocks. QName
is the qualified name of the outermost
element of the SOAP header block</dd>
</dl>
</li>
</ul>
<a name="getHeaders--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHeaders</h4>
<pre>public&nbsp;javax.xml.namespace.QName[]&nbsp;getHeaders()</pre>
<div class="block">Gets the header blocks processed by this Handler.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of QNames for the header blocks. Returns
<code>null</code> if no header blocks have been
set using the <code>setHeaders</code> method.</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><a href="../../../../javax/xml/rpc/handler/HandlerChain.html" title="interface in javax.xml.rpc.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/rpc/handler/HandlerRegistry.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/HandlerInfo.html" target="_top">Frames</a></li>
<li><a href="HandlerInfo.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>