Google Git
Sign in
apache / axis-site / 3093048f5b6dcd87d976050a42adfd57786946ac / . / axis2 / java / rampart / apidocs / org / apache / rampart / saml / SAMLAssertionHandler.html
blob: bdfaa3dde3c4967b4f403ec9d3201abb51519428 [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>SAMLAssertionHandler (Apache Rampart)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SAMLAssertionHandler (Apache Rampart)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SAMLAssertionHandler.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/rampart/saml/SAML2AssertionHandler.html" title="class in org.apache.rampart.saml"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandlerFactory.html" title="class in org.apache.rampart.saml"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/rampart/saml/SAMLAssertionHandler.html" target="_top">Frames</a></li>
<li><a href="SAMLAssertionHandler.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.rampart.saml</div>
<h2 title="Class SAMLAssertionHandler" class="title">Class SAMLAssertionHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.rampart.saml.SAMLAssertionHandler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html" title="class in org.apache.rampart.saml">SAML1AssertionHandler</a>, <a href="../../../../org/apache/rampart/saml/SAML2AssertionHandler.html" title="class in org.apache.rampart.saml">SAML2AssertionHandler</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">SAMLAssertionHandler</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A class to handle attributes to common SAML1 and SAML2 assertions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#SAMLAssertionHandler()">SAMLAssertionHandler</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract org.apache.axiom.om.OMElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionElement()">getAssertionElement</a></strong>()</code>
<div class="block">Gets the assertion element as an Axiom OMElement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionId()">getAssertionId</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)">getAssertionKeyInfoSecret</a></strong>(org.apache.ws.security.components.crypto.Crypto&nbsp;signatureCrypto,
<a href="../../../../org/apache/rampart/TokenCallbackHandler.html" title="class in org.apache.rampart">TokenCallbackHandler</a>&nbsp;tokenCallbackHandler)</code>
<div class="block">Gets the secret in assertion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getDateNotBefore()">getDateNotBefore</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getDateNotOnOrAfter()">getDateNotOnOrAfter</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#isBearerAssertion()">isBearerAssertion</a></strong>()</code>
<div class="block">Checks whether SAML assertion is bearer - urn:oasis:names:tc:SAML:2.0:cm:bearer</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#processSAMLAssertion()">processSAMLAssertion</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setAssertionId(java.lang.String)">setAssertionId</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;assertionId)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setDateNotBefore(java.util.Date)">setDateNotBefore</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dateNotBefore)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setDateNotOnOrAfter(java.util.Date)">setDateNotOnOrAfter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dateNotOnOrAfter)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SAMLAssertionHandler()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAMLAssertionHandler</h4>
<pre>public&nbsp;SAMLAssertionHandler()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAssertionId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAssertionId</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAssertionId()</pre>
</li>
</ul>
<a name="setAssertionId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAssertionId</h4>
<pre>protected&nbsp;void&nbsp;setAssertionId(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;assertionId)</pre>
</li>
</ul>
<a name="getDateNotBefore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDateNotBefore</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;getDateNotBefore()</pre>
</li>
</ul>
<a name="setDateNotBefore(java.util.Date)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDateNotBefore</h4>
<pre>protected&nbsp;void&nbsp;setDateNotBefore(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dateNotBefore)</pre>
</li>
</ul>
<a name="getDateNotOnOrAfter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDateNotOnOrAfter</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;getDateNotOnOrAfter()</pre>
</li>
</ul>
<a name="setDateNotOnOrAfter(java.util.Date)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDateNotOnOrAfter</h4>
<pre>protected&nbsp;void&nbsp;setDateNotOnOrAfter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dateNotOnOrAfter)</pre>
</li>
</ul>
<a name="isBearerAssertion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBearerAssertion</h4>
<pre>public abstract&nbsp;boolean&nbsp;isBearerAssertion()</pre>
<div class="block">Checks whether SAML assertion is bearer - urn:oasis:names:tc:SAML:2.0:cm:bearer</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if assertion is bearer else false.</dd></dl>
</li>
</ul>
<a name="processSAMLAssertion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processSAMLAssertion</h4>
<pre>protected abstract&nbsp;void&nbsp;processSAMLAssertion()</pre>
</li>
</ul>
<a name="getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAssertionKeyInfoSecret</h4>
<pre>public abstract&nbsp;byte[]&nbsp;getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto&nbsp;signatureCrypto,
<a href="../../../../org/apache/rampart/TokenCallbackHandler.html" title="class in org.apache.rampart">TokenCallbackHandler</a>&nbsp;tokenCallbackHandler)
throws org.apache.ws.security.WSSecurityException</pre>
<div class="block">Gets the secret in assertion.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureCrypto</code> - Signature crypto info, private,public keys.</dd><dd><code>tokenCallbackHandler</code> - The token callback class. TODO Why ?</dd>
<dt><span class="strong">Returns:</span></dt><dd>Secret as a byte array</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.ws.security.WSSecurityException</code> - If an error occurred while validating the signature.</dd></dl>
</li>
</ul>
<a name="getAssertionElement()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAssertionElement</h4>
<pre>public abstract&nbsp;org.apache.axiom.om.OMElement&nbsp;getAssertionElement()
throws <a href="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Gets the assertion element as an Axiom OMElement.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>OMElement representation of assertion.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - if an error occurred while converting Assertion to an OMElement.</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/SAMLAssertionHandler.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/rampart/saml/SAML2AssertionHandler.html" title="class in org.apache.rampart.saml"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/rampart/saml/SAMLAssertionHandlerFactory.html" title="class in org.apache.rampart.saml"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/rampart/saml/SAMLAssertionHandler.html" target="_top">Frames</a></li>
<li><a href="SAMLAssertionHandler.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>