Google Git
Sign in
apache / axis-site / f7bdbce8f5178add02522fdbf11ca5350d8eef03 / . / axis2 / java / rampart-staging / apidocs / org / apache / rampart / util / Axis2Util.html
blob: e08b87b28d3820ef104e687d325933fa36da109e [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>Axis2Util (Apache Rampart)</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="Axis2Util (Apache Rampart)";
}
//-->
</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/Axis2Util.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/rampart/util/MessageOptimizer.html" title="class in org.apache.rampart.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/rampart/util/Axis2Util.html" target="_top">Frames</a></li>
<li><a href="Axis2Util.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.rampart.util</div>
<h2 title="Class Axis2Util" class="title">Class Axis2Util</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.rampart.util.Axis2Util</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Axis2Util</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></pre>
<div class="block">Utility class for the Axis2-WSS4J Module</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/rampart/util/Axis2Util.html#Axis2Util()">Axis2Util</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>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/util/Axis2Util.html#getDocumentFromSOAPEnvelope(org.apache.axiom.soap.SOAPEnvelope, boolean)">getDocumentFromSOAPEnvelope</a></strong>(org.apache.axiom.soap.SOAPEnvelope&nbsp;env,
boolean&nbsp;useDoom)</code>
<div class="block">Creates a DOM Document using the SOAP Envelope.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/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/rampart/util/Axis2Util.html#getKey(java.lang.String, boolean, int)">getKey</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalKey,
boolean&nbsp;inHandler,
int&nbsp;repetition)</code>
<div class="block">Provides the appropriate key to pickup config params from the message context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.apache.axiom.soap.SOAPEnvelope</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/util/Axis2Util.html#getSOAPEnvelopeFromDOMDocument(org.w3c.dom.Document, boolean)">getSOAPEnvelopeFromDOMDocument</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a>&nbsp;doc,
boolean&nbsp;useDoom)</code>
<div class="block">Builds a SOAPEnvelope from DOM Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/util/Axis2Util.html#isUseDOOM()">isUseDOOM</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.apache.axiom.om.OMElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/util/Axis2Util.html#toDOOM(org.apache.axiom.om.OMFactory, org.apache.axiom.om.OMElement)">toDOOM</a></strong>(org.apache.axiom.om.OMFactory&nbsp;factory,
org.apache.axiom.om.OMElement&nbsp;element)</code>
<div class="block">This will build a DOOM Element that is of the same <code>Document</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/util/Axis2Util.html#useDOOM(boolean)">useDOOM</a></strong>(boolean&nbsp;isDOOMRequired)</code>&nbsp;</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="Axis2Util()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Axis2Util</h4>
<pre>public&nbsp;Axis2Util()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isUseDOOM()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseDOOM</h4>
<pre>public static&nbsp;boolean&nbsp;isUseDOOM()</pre>
</li>
</ul>
<a name="useDOOM(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useDOOM</h4>
<pre>public static&nbsp;void&nbsp;useDOOM(boolean&nbsp;isDOOMRequired)</pre>
</li>
</ul>
<a name="getDocumentFromSOAPEnvelope(org.apache.axiom.soap.SOAPEnvelope, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocumentFromSOAPEnvelope</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a>&nbsp;getDocumentFromSOAPEnvelope(org.apache.axiom.soap.SOAPEnvelope&nbsp;env,
boolean&nbsp;useDoom)
throws org.apache.ws.security.WSSecurityException</pre>
<div class="block">Creates a DOM Document using the SOAP Envelope.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - An org.apache.axiom.soap.SOAPEnvelope instance</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the DOM Document of the given SOAP Envelope.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.ws.security.WSSecurityException</code></dd></dl>
</li>
</ul>
<a name="getSOAPEnvelopeFromDOMDocument(org.w3c.dom.Document, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSOAPEnvelopeFromDOMDocument</h4>
<pre>public static&nbsp;org.apache.axiom.soap.SOAPEnvelope&nbsp;getSOAPEnvelopeFromDOMDocument(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a>&nbsp;doc,
boolean&nbsp;useDoom)
throws org.apache.ws.security.WSSecurityException</pre>
<div class="block">Builds a SOAPEnvelope from DOM Document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doc</code> - - The dom document that contains a SOAP message</dd><dd><code>useDoom</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.ws.security.WSSecurityException</code></dd></dl>
</li>
</ul>
<a name="getKey(java.lang.String, boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKey(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalKey,
boolean&nbsp;inHandler,
int&nbsp;repetition)</pre>
<div class="block">Provides the appropriate key to pickup config params from the message context.
This is acutally used when the outflow handler (WSDoAllSender)
is repeated n number of times.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>originalKey</code> - The default key</dd><dd><code>inHandler</code> - Whether the handler is the inflow handler or not</dd><dd><code>repetition</code> - The current repetition number</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the key to be used internally in the security module to pick
up the config params.</dd></dl>
</li>
</ul>
<a name="toDOOM(org.apache.axiom.om.OMFactory, org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toDOOM</h4>
<pre>public static&nbsp;org.apache.axiom.om.OMElement&nbsp;toDOOM(org.apache.axiom.om.OMFactory&nbsp;factory,
org.apache.axiom.om.OMElement&nbsp;element)</pre>
<div class="block">This will build a DOOM Element that is of the same <code>Document</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - </dd><dd><code>element</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></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/Axis2Util.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/rampart/util/MessageOptimizer.html" title="class in org.apache.rampart.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/rampart/util/Axis2Util.html" target="_top">Frames</a></li>
<li><a href="Axis2Util.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="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>