| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_22) on Thu Apr 26 14:22:13 IST 2012 --> |
| <TITLE> |
| SAML1AssertionHandler (Apache Rampart API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-04-26"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SAML1AssertionHandler (Apache Rampart API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SAML1AssertionHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/rampart/saml/SAML2AssertionHandler.html" title="class in org.apache.rampart.saml"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/rampart/saml/SAML1AssertionHandler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SAML1AssertionHandler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.rampart.saml</FONT> |
| <BR> |
| Class SAML1AssertionHandler</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">org.apache.rampart.saml.SAMLAssertionHandler</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.rampart.saml.SAML1AssertionHandler</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>SAML1AssertionHandler</B><DT>extends <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></DL> |
| </PRE> |
| |
| <P> |
| This class handles SAML1 assertions.Processes SAML1 assertion and will extract SAML1 attributes |
| such as assertion id, start date, end date etc ... |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html#SAML1AssertionHandler(org.opensaml.saml1.core.Assertion)">SAML1AssertionHandler</A></B>(org.opensaml.saml1.core.Assertion saml1Assertion)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.axiom.om.OMElement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html#getAssertionElement()">getAssertionElement</A></B>()</CODE> |
| |
| <BR> |
| Gets the assertion element as an Axiom OMElement.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html#getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)">getAssertionKeyInfoSecret</A></B>(org.apache.ws.security.components.crypto.Crypto signatureCrypto, |
| <A HREF="../../../../org/apache/rampart/TokenCallbackHandler.html" title="class in org.apache.rampart">TokenCallbackHandler</A> tokenCallbackHandler)</CODE> |
| |
| <BR> |
| Gets the secret in assertion.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html#isBearerAssertion()">isBearerAssertion</A></B>()</CODE> |
| |
| <BR> |
| Checks whether SAML assertion is bearer - urn:oasis:names:tc:SAML:2.0:cm:bearer</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rampart/saml/SAML1AssertionHandler.html#processSAMLAssertion()">processSAMLAssertion</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.rampart.saml.SAMLAssertionHandler"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.rampart.saml.<A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionId()">getAssertionId</A>, <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getDateNotBefore()">getDateNotBefore</A>, <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getDateNotOnOrAfter()">getDateNotOnOrAfter</A>, <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setAssertionId(java.lang.String)">setAssertionId</A>, <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setDateNotBefore(java.util.Date)">setDateNotBefore</A>, <A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#setDateNotOnOrAfter(java.util.Date)">setDateNotOnOrAfter</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SAML1AssertionHandler(org.opensaml.saml1.core.Assertion)"><!-- --></A><H3> |
| SAML1AssertionHandler</H3> |
| <PRE> |
| public <B>SAML1AssertionHandler</B>(org.opensaml.saml1.core.Assertion saml1Assertion)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="isBearerAssertion()"><!-- --></A><H3> |
| isBearerAssertion</H3> |
| <PRE> |
| public boolean <B>isBearerAssertion</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#isBearerAssertion()">SAMLAssertionHandler</A></CODE></B></DD> |
| <DD>Checks whether SAML assertion is bearer - urn:oasis:names:tc:SAML:2.0:cm:bearer |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#isBearerAssertion()">isBearerAssertion</A></CODE> in class <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if assertion is bearer else false.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processSAMLAssertion()"><!-- --></A><H3> |
| processSAMLAssertion</H3> |
| <PRE> |
| protected void <B>processSAMLAssertion</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#processSAMLAssertion()">processSAMLAssertion</A></CODE> in class <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)"><!-- --></A><H3> |
| getAssertionKeyInfoSecret</H3> |
| <PRE> |
| public byte[] <B>getAssertionKeyInfoSecret</B>(org.apache.ws.security.components.crypto.Crypto signatureCrypto, |
| <A HREF="../../../../org/apache/rampart/TokenCallbackHandler.html" title="class in org.apache.rampart">TokenCallbackHandler</A> tokenCallbackHandler) |
| throws org.apache.ws.security.WSSecurityException</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)">SAMLAssertionHandler</A></CODE></B></DD> |
| <DD>Gets the secret in assertion. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionKeyInfoSecret(org.apache.ws.security.components.crypto.Crypto, org.apache.rampart.TokenCallbackHandler)">getAssertionKeyInfoSecret</A></CODE> in class <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>signatureCrypto</CODE> - Signature crypto info, private,public keys.<DD><CODE>tokenCallbackHandler</CODE> - The token callback class. TODO Why ? |
| <DT><B>Returns:</B><DD>Secret as a byte array |
| <DT><B>Throws:</B> |
| <DD><CODE>org.apache.ws.security.WSSecurityException</CODE> - If an error occurred while validating the signature.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAssertionElement()"><!-- --></A><H3> |
| getAssertionElement</H3> |
| <PRE> |
| public org.apache.axiom.om.OMElement <B>getAssertionElement</B>() |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionElement()">SAMLAssertionHandler</A></CODE></B></DD> |
| <DD>Gets the assertion element as an Axiom OMElement. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html#getAssertionElement()">getAssertionElement</A></CODE> in class <CODE><A HREF="../../../../org/apache/rampart/saml/SAMLAssertionHandler.html" title="class in org.apache.rampart.saml">SAMLAssertionHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>OMElement representation of assertion. |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SAML1AssertionHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/rampart/saml/SAML2AssertionHandler.html" title="class in org.apache.rampart.saml"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/rampart/saml/SAML1AssertionHandler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SAML1AssertionHandler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
