blob: 4a47109d8fbb174ad20ca57da8d69b62b53fdcb5 [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>org.apache.cxf.ws.security.wss4j (Apache CXF JavaDoc 3.1.0 API)</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="org.apache.cxf.ws.security.wss4j (Apache CXF JavaDoc 3.1.0 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/ws/security/trust/delegation/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../../org/apache/cxf/ws/security/wss4j/policyhandlers/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/ws/security/wss4j/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.cxf.ws.security.wss4j</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">AbstractTokenInterceptor</a></td>
<td class="colLast">
<div class="block">An abstract interceptor that can be used to form the basis of an interceptor to add and process
a specific type of security token.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AbstractUsernameTokenAuthenticatingInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">AbstractUsernameTokenAuthenticatingInterceptor</a></td>
<td class="colLast">
<div class="block">Base class providing an extensibility point for populating
javax.security.auth.Subject from a current UsernameToken.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AbstractWSS4JInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">AbstractWSS4JInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AbstractWSS4JStaxInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">AbstractWSS4JStaxInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AlgorithmSuiteTranslater.html" title="class in org.apache.cxf.ws.security.wss4j">AlgorithmSuiteTranslater</a></td>
<td class="colLast">
<div class="block">Translate any AlgorithmSuite policy that may be operative into a WSS4J AlgorithmSuite object
to enforce what algorithms are allowed in a request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/AttachmentCallbackHandler.html" title="class in org.apache.cxf.ws.security.wss4j">AttachmentCallbackHandler</a></td>
<td class="colLast">
<div class="block">A CallbackHandler to be used to sign/encrypt SOAP Attachments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/BinarySecurityTokenInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">BinarySecurityTokenInterceptor</a></td>
<td class="colLast">
<div class="block">An interceptor to add a BinarySecurityToken token to the security header of an outbound request, and to
process a BinarySecurityToken on an inbound request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CryptoCoverageChecker.html" title="class in org.apache.cxf.ws.security.wss4j">CryptoCoverageChecker</a></td>
<td class="colLast">
<div class="block">Utility to enable the checking of WS-Security signature/encryption
coverage based on the results of the WSS4J processors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CryptoCoverageChecker.XPathExpression.html" title="class in org.apache.cxf.ws.security.wss4j">CryptoCoverageChecker.XPathExpression</a></td>
<td class="colLast">
<div class="block">A simple wrapper for an XPath expression and coverage type / scope
indicating how the XPath expression should be enforced as a cryptographic
coverage requirement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.html" title="class in org.apache.cxf.ws.security.wss4j">CryptoCoverageUtil</a></td>
<td class="colLast">
<div class="block">Utility to enable the checking of WS-Security signature / WS-Security
encryption coverage based on the results of the WSS4J signature/encryption
processor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CXFCallbackLookup.html" title="class in org.apache.cxf.ws.security.wss4j">CXFCallbackLookup</a></td>
<td class="colLast">
<div class="block">This class uses a DOM-based approach to locate Elements that are referenced via an Id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CXFRequestData.html" title="class in org.apache.cxf.ws.security.wss4j">CXFRequestData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/DefaultCryptoCoverageChecker.html" title="class in org.apache.cxf.ws.security.wss4j">DefaultCryptoCoverageChecker</a></td>
<td class="colLast">
<div class="block">This utility extends the CryptoCoverageChecker to provide an easy way to check to see
if the SOAP (1.1 + 1.2) Body was signed and/or encrypted, if the Timestamp was signed,
if the WS-Addressing ReplyTo and FaultTo headers were signed, and if the UsernameToken
was encrypted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/DelegatingCallbackHandler.html" title="class in org.apache.cxf.ws.security.wss4j">DelegatingCallbackHandler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/KerberosTokenInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">KerberosTokenInterceptor</a></td>
<td class="colLast">
<div class="block">An interceptor to add a Kerberos token to the security header of an outbound request, and to
process a Kerberos Token on an inbound request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/PolicyBasedWSS4JInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">PolicyBasedWSS4JInInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/PolicyBasedWSS4JOutInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">PolicyBasedWSS4JOutInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/PolicyBasedWSS4JStaxInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">PolicyBasedWSS4JStaxInInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/PolicyBasedWSS4JStaxOutInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">PolicyBasedWSS4JStaxOutInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/SamlTokenInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">SamlTokenInterceptor</a></td>
<td class="colLast">
<div class="block">An interceptor to create and add a SAML token to the security header of an outbound
request, and to process a SAML Token on an inbound request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/StaxActionInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">StaxActionInInterceptor</a></td>
<td class="colLast">
<div class="block">This interceptor handles parsing the StaX WS-Security results (events) + checks to see
whether the required Actions were fulfilled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/StaxCryptoCoverageChecker.html" title="class in org.apache.cxf.ws.security.wss4j">StaxCryptoCoverageChecker</a></td>
<td class="colLast">
<div class="block">This interceptor handles parsing the StaX WS-Security results (events) + checks that the
specified crypto coverage events actually occurred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/StaxSecurityContextInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">StaxSecurityContextInInterceptor</a></td>
<td class="colLast">
<div class="block">This interceptor handles parsing the StaX WS-Security results (events) + sets up the
security context appropriately.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/TokenStoreCallbackHandler.html" title="class in org.apache.cxf.ws.security.wss4j">TokenStoreCallbackHandler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/UsernameTokenInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">UsernameTokenInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JInInterceptor</a></td>
<td class="colLast">
<div class="block">Performs WS-Security inbound actions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JOutInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JOutInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JPolicyAsserter.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JPolicyAsserter</a></td>
<td class="colLast">
<div class="block">Assert policies in CXF that are asserted in the WSS4J policy stax module</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JStaxInInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JStaxInInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JStaxOutInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JTokenConverter.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JTokenConverter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/WSS4JUtils.html" title="class in org.apache.cxf.ws.security.wss4j">WSS4JUtils</a></td>
<td class="colLast">
<div class="block">Some common functionality that can be shared between the WSS4JInInterceptor and the
UsernameTokenInterceptor.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.CoverageScope.html" title="enum in org.apache.cxf.ws.security.wss4j">CryptoCoverageUtil.CoverageScope</a></td>
<td class="colLast">
<div class="block">Differentiates which part of an element to check for cryptographic coverage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.CoverageType.html" title="enum in org.apache.cxf.ws.security.wss4j">CryptoCoverageUtil.CoverageType</a></td>
<td class="colLast">
<div class="block">Differentiates which type of cryptographic coverage to check for.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/ws/security/trust/delegation/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../../org/apache/cxf/ws/security/wss4j/policyhandlers/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/ws/security/wss4j/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Apache CXF</small></p>
</body>
</html>