Added: webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/InboundWSSec.html URL: http://svn.apache.org/viewvc/webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/InboundWSSec.html?rev=1710775&view=auto ============================================================================== --- webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/InboundWSSec.html (added) +++ webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/InboundWSSec.html Tue Oct 27 11:08:19 2015 @@ -0,0 +1,445 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_71) on Tue Oct 27 10:53:35 GMT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>InboundWSSec (Apache WSS4J 2.1.5-SNAPSHOT API)</title> +<meta name="date" content="2015-10-27"> +<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="InboundWSSec (Apache WSS4J 2.1.5-SNAPSHOT API)"; + } +//--> +</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/InboundWSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/ConfigurationConverter.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/InboundWSSec.html" target="_top">Frames</a></li> +<li><a href="InboundWSSec.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.wss4j.stax.setup</div> +<h2 title="Class InboundWSSec" class="title">Class InboundWSSec</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.wss4j.stax.setup.InboundWSSec</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">InboundWSSec</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Inbound Streaming-WebService-Security + An instance of this class can be retrieved over the WSSec class</div> +</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 static org.slf4j.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#log">log</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/wss4j/stax/setup/InboundWSSec.html#InboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)">InboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#InboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties,%20boolean,%20boolean)">InboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator, + boolean returnSecurityError)</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><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#processInMessage(javax.xml.stream.XMLStreamReader)">processInMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader)</code> +<div class="block">Warning: + configure your xmlStreamReader correctly.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#processInMessage(javax.xml.stream.XMLStreamReader,%20java.util.List)">processInMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents)</code> +<div class="block">Warning: + configure your xmlStreamReader correctly.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#processInMessage(javax.xml.stream.XMLStreamReader,%20java.util.List,%20java.util.List)">processInMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEventListener> securityEventListeners)</code> +<div class="block">Warning: + configure your xmlStreamReader correctly.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html#processInMessage(javax.xml.stream.XMLStreamReader,%20java.util.List,%20org.apache.xml.security.stax.securityEvent.SecurityEventListener)">processInMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener)</code> +<div class="block">Warning: + configure your xmlStreamReader correctly.</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="log"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>log</h4> +<pre>protected static final transient org.slf4j.Logger log</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="InboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>InboundWSSec</h4> +<pre>public InboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</pre> +</li> +</ul> +<a name="InboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InboundWSSec</h4> +<pre>public InboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator, + boolean returnSecurityError)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="processInMessage(javax.xml.stream.XMLStreamReader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processInMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> processInMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader) + throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a>, + <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Warning: + configure your xmlStreamReader correctly. Otherwise you can create a security hole. + At minimum configure the following properties: + xmlInputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_COALESCING, false); + xmlInputFactory.setProperty(WstxInputProperties.P_MIN_TEXT_SEGMENT, new Integer(8192)); + <p/> + This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamReader and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamReader</code> - The original XMLStreamReader</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamReader which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a></code> - thrown when a streaming error occurs</dd> +<dd><code>org.apache.xml.security.exceptions.XMLSecurityException</code></dd> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="processInMessage(javax.xml.stream.XMLStreamReader, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processInMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> processInMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents) + throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a>, + <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Warning: + configure your xmlStreamReader correctly. Otherwise you can create a security hole. + At minimum configure the following properties: + xmlInputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_COALESCING, false); + xmlInputFactory.setProperty(WstxInputProperties.P_MIN_TEXT_SEGMENT, new Integer(8192)); + <p/> + This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamReader and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamReader</code> - The original XMLStreamReader</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamReader which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a></code> - thrown when a streaming error occurs</dd> +<dd><code>org.apache.xml.security.exceptions.XMLSecurityException</code></dd> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="processInMessage(javax.xml.stream.XMLStreamReader, java.util.List, org.apache.xml.security.stax.securityEvent.SecurityEventListener)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processInMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> processInMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener) + throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a>, + <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Warning: + configure your xmlStreamReader correctly. Otherwise you can create a security hole. + At minimum configure the following properties: + xmlInputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_COALESCING, false); + xmlInputFactory.setProperty(WstxInputProperties.P_MIN_TEXT_SEGMENT, new Integer(8192)); + <p/> + This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamReader and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamReader</code> - The original XMLStreamReader</dd><dd><code>securityEventListener</code> - A SecurityEventListener to receive security-relevant events.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamReader which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a></code> - thrown when a streaming error occurs</dd> +<dd><code>org.apache.xml.security.exceptions.XMLSecurityException</code></dd> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="processInMessage(javax.xml.stream.XMLStreamReader, java.util.List, java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processInMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> processInMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEventListener> securityEventListeners) + throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a>, + <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Warning: + configure your xmlStreamReader correctly. Otherwise you can create a security hole. + At minimum configure the following properties: + xmlInputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); + xmlInputFactory.setProperty(XMLInputFactory.IS_COALESCING, false); + xmlInputFactory.setProperty(WstxInputProperties.P_MIN_TEXT_SEGMENT, new Integer(8192)); + <p/> + This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamReader and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamReader</code> - The original XMLStreamReader</dd><dd><code>securityEventListeners</code> - A list of SecurityEventListeners to receive security-relevant events.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamReader which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamException</a></code> - thrown when a streaming error occurs</dd> +<dd><code>org.apache.xml.security.exceptions.XMLSecurityException</code></dd> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</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/InboundWSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/ConfigurationConverter.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/InboundWSSec.html" target="_top">Frames</a></li> +<li><a href="InboundWSSec.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 © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/OutboundWSSec.html URL: http://svn.apache.org/viewvc/webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/OutboundWSSec.html?rev=1710775&view=auto ============================================================================== --- webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/OutboundWSSec.html (added) +++ webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/OutboundWSSec.html Tue Oct 27 11:08:19 2015 @@ -0,0 +1,401 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_71) on Tue Oct 27 10:53:35 GMT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>OutboundWSSec (Apache WSS4J 2.1.5-SNAPSHOT API)</title> +<meta name="date" content="2015-10-27"> +<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="OutboundWSSec (Apache WSS4J 2.1.5-SNAPSHOT API)"; + } +//--> +</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/OutboundWSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/OutboundWSSec.html" target="_top">Frames</a></li> +<li><a href="OutboundWSSec.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>Field | </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>Field | </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.wss4j.stax.setup</div> +<h2 title="Class OutboundWSSec" class="title">Class OutboundWSSec</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.wss4j.stax.setup.OutboundWSSec</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">OutboundWSSec</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Outbound Streaming-WebService-Security + An instance of this class can be retrieved over the WSSec 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="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/wss4j/stax/setup/OutboundWSSec.html#OutboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)">OutboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</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><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(java.lang.Object,%20java.lang.String,%20org.apache.xml.security.stax.ext.OutboundSecurityContext)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + org.apache.xml.security.stax.ext.OutboundSecurityContext outboundSecurityContext)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(java.io.OutputStream,%20java.lang.String,%20java.util.List)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outputStream, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents)</code> +<div class="block">This method is the entry point for the incoming security-engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(java.io.OutputStream,%20java.lang.String,%20java.util.List,%20org.apache.xml.security.stax.securityEvent.SecurityEventListener)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outputStream, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener)</code> +<div class="block">This method is the entry point for the incoming security-engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(javax.xml.stream.XMLStreamWriter,%20java.lang.String,%20java.util.List)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents)</code> +<div class="block">This method is the entry point for the incoming security-engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(javax.xml.stream.XMLStreamWriter,%20java.lang.String,%20java.util.List,%20org.apache.xml.security.stax.securityEvent.SecurityEventListener)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener)</code> +<div class="block">This method is the entry point for the incoming security-engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html#processOutMessage(javax.xml.stream.XMLStreamWriter,%20java.lang.String,%20org.apache.xml.security.stax.ext.OutboundSecurityContext)">processOutMessage</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + org.apache.xml.security.stax.ext.OutboundSecurityContext outbounSecurityContext)</code> +<div class="block">This method is the entry point for the incoming security-engine.</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="OutboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OutboundWSSec</h4> +<pre>public OutboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="processOutMessage(java.io.OutputStream, java.lang.String, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outputStream, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">This method is the entry point for the incoming security-engine. + Hand over a outputStream and use the returned XMLStreamWriter for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outputStream</code> - The original outputStream</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamWriter which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - thrown when a Security failure occurs</dd></dl> +</li> +</ul> +<a name="processOutMessage(javax.xml.stream.XMLStreamWriter, java.lang.String, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamWriter and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamWriter</code> - The original xmlStreamWriter</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamWriter which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - thrown when a Security failure occurs</dd></dl> +</li> +</ul> +<a name="processOutMessage(java.io.OutputStream, java.lang.String, java.util.List, org.apache.xml.security.stax.securityEvent.SecurityEventListener)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outputStream, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">This method is the entry point for the incoming security-engine. + Hand over a outputstream and use the returned XMLStreamWriter for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outputStream</code> - The original outputStream</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamWriter which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - thrown when a Security failure occurs</dd></dl> +</li> +</ul> +<a name="processOutMessage(javax.xml.stream.XMLStreamWriter, java.lang.String, java.util.List, org.apache.xml.security.stax.securityEvent.SecurityEventListener)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.xml.security.stax.securityEvent.SecurityEvent> requestSecurityEvents, + org.apache.xml.security.stax.securityEvent.SecurityEventListener securityEventListener) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamWriter and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamWriter</code> - The original outputStream</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamWriter which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - thrown when a Security failure occurs</dd></dl> +</li> +</ul> +<a name="processOutMessage(javax.xml.stream.XMLStreamWriter, java.lang.String, org.apache.xml.security.stax.ext.OutboundSecurityContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> xmlStreamWriter, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + org.apache.xml.security.stax.ext.OutboundSecurityContext outbounSecurityContext) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">This method is the entry point for the incoming security-engine. + Hand over the original XMLStreamWriter and use the returned one for further processing</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlStreamWriter</code> - The original outputStream</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new XMLStreamWriter which does transparently the security processing.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - thrown when a Security failure occurs</dd></dl> +</li> +</ul> +<a name="processOutMessage(java.lang.Object, java.lang.String, org.apache.xml.security.stax.ext.OutboundSecurityContext)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processOutMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true"; title="class or interface in javax.xml.stream">XMLStreamWriter</a> processOutMessage(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> encoding, + org.apache.xml.security.stax.ext.OutboundSecurityContext outboundSecurityContext) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</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/OutboundWSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/OutboundWSSec.html" target="_top">Frames</a></li> +<li><a href="OutboundWSSec.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>Field | </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>Field | </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 © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/WSSec.html URL: http://svn.apache.org/viewvc/webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/WSSec.html?rev=1710775&view=auto ============================================================================== --- webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/WSSec.html (added) +++ webservices/website/wss4j/apidocs/org/apache/wss4j/stax/setup/WSSec.html Tue Oct 27 11:08:19 2015 @@ -0,0 +1,413 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_71) on Tue Oct 27 10:53:35 GMT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>WSSec (Apache WSS4J 2.1.5-SNAPSHOT API)</title> +<meta name="date" content="2015-10-27"> +<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="WSSec (Apache WSS4J 2.1.5-SNAPSHOT API)"; + } +//--> +</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/WSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/WSSec.html" target="_top">Frames</a></li> +<li><a href="WSSec.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>Field | </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>Field | </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.wss4j.stax.setup</div> +<h2 title="Class WSSec" class="title">Class WSSec</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.wss4j.stax.setup.WSSec</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">WSSec</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">This is the central class of the streaming webservice-security framework.<br/> + Instances of the inbound and outbound security streams can be retrieved + with this 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="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/wss4j/stax/setup/WSSec.html#WSSec()">WSSec</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>static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)">getInboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</code> +<div class="block">Creates and configures an inbound streaming security engine</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties,%20boolean)">getInboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator)</code> +<div class="block">Creates and configures an inbound streaming security engine</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties,%20boolean,%20boolean)">getInboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator, + boolean returnSecurityError)</code> +<div class="block">Creates and configures an inbound streaming security engine</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup">OutboundWSSec</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#getOutboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)">getOutboundWSSec</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</code> +<div class="block">Creates and configures an outbound streaming security engine</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#init()">init</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/validation/Schema.html?is-external=true"; title="class or interface in javax.xml.validation">Schema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#loadWSSecuritySchemas()">loadWSSecuritySchemas</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#validateAndApplyDefaultsToInboundSecurityProperties(org.apache.wss4j.stax.ext.WSSSecurityProperties)">validateAndApplyDefaultsToInboundSecurityProperties</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</code> +<div class="block">Validates the user supplied configuration and applies default values as apropriate for the inbound security engine</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/wss4j/stax/setup/WSSec.html#validateAndApplyDefaultsToOutboundSecurityProperties(org.apache.wss4j.stax.ext.WSSSecurityProperties)">validateAndApplyDefaultsToOutboundSecurityProperties</a></strong>(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties)</code> +<div class="block">Validates the user supplied configuration and applies default values as apropriate for the outbound security engine</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="WSSec()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>WSSec</h4> +<pre>public WSSec()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public static void init()</pre> +</li> +</ul> +<a name="getOutboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutboundWSSec</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup">OutboundWSSec</a> getOutboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Creates and configures an outbound streaming security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The user-defined security configuration</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new OutboundWSSec</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - if the initialisation failed</dd> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInboundWSSec</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a> getInboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Creates and configures an inbound streaming security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The user-defined security configuration</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new InboundWSSec</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - if the initialisation failed</dd> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInboundWSSec</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a> getInboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Creates and configures an inbound streaming security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The user-defined security configuration</dd><dd><code>initiator</code> - Whether we are the message initiator or not</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new InboundWSSec</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - if the initialisation failed</dd> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="getInboundWSSec(org.apache.wss4j.stax.ext.WSSSecurityProperties, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInboundWSSec</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/setup/InboundWSSec.html" title="class in org.apache.wss4j.stax.setup">InboundWSSec</a> getInboundWSSec(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties, + boolean initiator, + boolean returnSecurityError) + throws <a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></pre> +<div class="block">Creates and configures an inbound streaming security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The user-defined security configuration</dd><dd><code>initiator</code> - Whether we are the message initiator or not</dd><dd><code>returnSecurityError</code> - Whether to return the underlying security error or not</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new InboundWSSec</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html" title="class in org.apache.wss4j.common.ext">WSSecurityException</a></code> - if the initialisation failed</dd> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="validateAndApplyDefaultsToOutboundSecurityProperties(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateAndApplyDefaultsToOutboundSecurityProperties</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> validateAndApplyDefaultsToOutboundSecurityProperties(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties) + throws <a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></pre> +<div class="block">Validates the user supplied configuration and applies default values as apropriate for the outbound security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The configuration to validate</dd> +<dt><span class="strong">Returns:</span></dt><dd>The validated configuration</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="validateAndApplyDefaultsToInboundSecurityProperties(org.apache.wss4j.stax.ext.WSSSecurityProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateAndApplyDefaultsToInboundSecurityProperties</h4> +<pre>public static <a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> validateAndApplyDefaultsToInboundSecurityProperties(<a href="../../../../../org/apache/wss4j/stax/ext/WSSSecurityProperties.html" title="class in org.apache.wss4j.stax.ext">WSSSecurityProperties</a> securityProperties) + throws <a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></pre> +<div class="block">Validates the user supplied configuration and applies default values as apropriate for the inbound security engine</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityProperties</code> - The configuration to validate</dd> +<dt><span class="strong">Returns:</span></dt><dd>The validated configuration</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/wss4j/stax/ext/WSSConfigurationException.html" title="class in org.apache.wss4j.stax.ext">WSSConfigurationException</a></code> - if the configuration is invalid</dd></dl> +</li> +</ul> +<a name="loadWSSecuritySchemas()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>loadWSSecuritySchemas</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/validation/Schema.html?is-external=true"; title="class or interface in javax.xml.validation">Schema</a> loadWSSecuritySchemas() + throws <a href="http://docs.oracle.com/javase/7/docs/api/org/xml/sax/SAXException.html?is-external=true"; title="class or interface in org.xml.sax">SAXException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/org/xml/sax/SAXException.html?is-external=true"; title="class or interface in org.xml.sax">SAXException</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/WSSec.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><a href="../../../../../org/apache/wss4j/stax/setup/OutboundWSSec.html" title="class in org.apache.wss4j.stax.setup"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/wss4j/stax/setup/WSSec.html" target="_top">Frames</a></li> +<li><a href="WSSec.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>Field | </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>Field | </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 © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
