blob: 6bd1542782f13544264e9167f011e37e5d30bd2a [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>EndpointContextMapMigrator (Apache Axis2)</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="EndpointContextMapMigrator (Apache Axis2)";
}
//-->
</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/EndpointContextMapMigrator.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html" target="_top">Frames</a></li>
<li><a href="EndpointContextMapMigrator.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><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">org.apache.axis2.jaxws.addressing.migrator</div>
<h2 title="Class EndpointContextMapMigrator" class="title">Class EndpointContextMapMigrator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/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.axis2.jaxws.addressing.migrator.EndpointContextMapMigrator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">EndpointContextMapMigrator</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></pre>
<div class="block">This class will enable the JAX-WS 2.1 API methods to create instances of
<a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/EndpointReference.html?is-external=true" title="class or interface in javax.xml.ws"><code>EndpointReference</code></a> that target a particular web service
endpoint, identified by specifying the WSDL service name and port name of the
endpoint, to work correctly. This is achieved by enabling the implementation of
<a href="../../../../../../org/apache/axis2/jaxws/addressing/factory/Axis2EndpointReferenceFactory.html" title="interface in org.apache.axis2.jaxws.addressing.factory"><code>Axis2EndpointReferenceFactory</code></a>
to retrieve the context it needs from the invoking thread. The instances of
<a href="../../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing"><code>EndpointReference</code></a> that it produces can
then converted to instances of <a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/EndpointReference.html?is-external=true" title="class or interface in javax.xml.ws"><code>EndpointReference</code></a>, as
needed.</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="overviewSummary" 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><strong><a href="../../../../../../org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html#EndpointContextMapMigrator()">EndpointContextMapMigrator</a></strong>()</code>&nbsp;</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">&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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html#cleanupContext(org.apache.axis2.context.MessageContext)">cleanupContext</a></strong>(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to be on the thread of execution that will be used in user
space, after all processing has completed (i.e. when the particular
processing of a message is unwinding.)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html#cleanupThread(org.apache.axis2.context.MessageContext)">cleanupThread</a></strong>(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to still be on the thread of execution that was used in user
space, after all processing has completed (i.e. when the particular
processing of a message is unwinding.)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html#migrateContextToThread(org.apache.axis2.context.MessageContext)">migrateContextToThread</a></strong>(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to be on the thread of execution that will be used in
user space.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html#migrateThreadToContext(org.apache.axis2.context.MessageContext)">migrateThreadToContext</a></strong>(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to still be on the thread of execution that was used in
user space.</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.<a href="http://docs.oracle.com/javase/1.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/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.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="EndpointContextMapMigrator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EndpointContextMapMigrator</h4>
<pre>public&nbsp;EndpointContextMapMigrator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="migrateContextToThread(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>migrateContextToThread</h4>
<pre>public&nbsp;void&nbsp;migrateContextToThread(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)
throws <a href="../../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#migrateContextToThread(org.apache.axis2.context.MessageContext)">ThreadContextMigrator</a></code></strong></div>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to be on the thread of execution that will be used in
user space. It will be invoked for incoming messages.
Implementations of this interface can use the information found in the
MessageContext to determine whether a request or response is being
processed.
(e.g. MessageContext.getAxisOperation().getMessageExchangePattern())</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#migrateContextToThread(org.apache.axis2.context.MessageContext)">migrateContextToThread</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="cleanupThread(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanupThread</h4>
<pre>public&nbsp;void&nbsp;cleanupThread(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#cleanupThread(org.apache.axis2.context.MessageContext)">ThreadContextMigrator</a></code></strong></div>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to still be on the thread of execution that was used in user
space, after all processing has completed (i.e. when the particular
processing of a message is unwinding.) It provides a mechanism which can
be used to clean up the TLS.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#cleanupThread(org.apache.axis2.context.MessageContext)">cleanupThread</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></code></dd>
</dl>
</li>
</ul>
<a name="migrateThreadToContext(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>migrateThreadToContext</h4>
<pre>public&nbsp;void&nbsp;migrateThreadToContext(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)
throws <a href="../../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#migrateThreadToContext(org.apache.axis2.context.MessageContext)">ThreadContextMigrator</a></code></strong></div>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to still be on the thread of execution that was used in
user space. It will be invoked for both outgoing messages.
Implementations of this interface can use the information found in the
MessageContext to determine whether a request or response is being
processed.
(e.g. MessageContext.getAxisOperation().getMessageExchangePattern())</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#migrateThreadToContext(org.apache.axis2.context.MessageContext)">migrateThreadToContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="cleanupContext(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cleanupContext</h4>
<pre>public&nbsp;void&nbsp;cleanupContext(<a href="../../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#cleanupContext(org.apache.axis2.context.MessageContext)">ThreadContextMigrator</a></code></strong></div>
<div class="block">This method will be invoked when the processing of the message is
guaranteed to be on the thread of execution that will be used in user
space, after all processing has completed (i.e. when the particular
processing of a message is unwinding.) It provides a mechanism which can
be used to clean up the MessageContext or restore TLS.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html#cleanupContext(org.apache.axis2.context.MessageContext)">cleanupContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/axis2/util/ThreadContextMigrator.html" title="interface in org.apache.axis2.util">ThreadContextMigrator</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EndpointContextMapMigrator.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/addressing/migrator/EndpointContextMapMigrator.html" target="_top">Frames</a></li>
<li><a href="EndpointContextMapMigrator.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><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 ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>