| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| STSClient (Apache Rampart) |
| </TITLE> |
| |
| |
| <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="STSClient (Apache Rampart)"; |
| } |
| } |
| </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/STSClient.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 |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/rahas/client/STSClient.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="STSClient.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.rahas.client</FONT> |
| <BR> |
| Class STSClient</H2> |
| <PRE> |
| <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> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.rahas.client.STSClient</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>STSClient</B><DT>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></DL> |
| </PRE> |
| |
| <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/rahas/client/STSClient.html#STSClient(org.apache.axis2.context.ConfigurationContext)">STSClient</A></B>(org.apache.axis2.context.ConfigurationContext configCtx)</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</A></B>(org.apache.axis2.description.Parameter param)</CODE> |
| |
| <BR> |
| </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/rahas/client/STSClient.html#cancelToken(java.lang.String, java.lang.String, java.lang.String)">cancelToken</A></B>(<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> issuerAddress, |
| <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> tokenId, |
| <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> action)</CODE> |
| |
| <BR> |
| Cancel a particular security token</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/rahas/client/STSClient.html#renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)">renewToken</A></B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy)</CODE> |
| |
| <BR> |
| </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/rahas/client/STSClient.html#renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy, org.apache.rahas.TokenStorage)">renewToken</A></B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy, |
| <A HREF="../../../../org/apache/rahas/TokenStorage.html" title="interface in org.apache.rahas">TokenStorage</A> store)</CODE> |
| |
| <BR> |
| Renews the token referenced by the token id, updates the token store</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#requestSecurityToken(org.apache.neethi.Policy, java.lang.String, org.apache.neethi.Policy, java.lang.String)">requestSecurityToken</A></B>(org.apache.neethi.Policy servicePolicy, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy, |
| <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> appliesTo)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setAction(java.lang.String)">setAction</A></B>(<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> action)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setAddressingNs(java.lang.String)">setAddressingNs</A></B>(<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> addressingNs)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setAlgorithmSuite(org.apache.ws.secpolicy.model.AlgorithmSuite)">setAlgorithmSuite</A></B>(<A HREF="../../../../org/apache/ws/secpolicy/model/AlgorithmSuite.html" title="class in org.apache.ws.secpolicy.model">AlgorithmSuite</A> algorithmSuite)</CODE> |
| |
| <BR> |
| This can be used in the case where the AlgorithmSuite is not specified in |
| the given policy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, javax.security.auth.callback.CallbackHandler)">setCryptoInfo</A></B>(org.apache.ws.security.components.crypto.Crypto crypto, |
| <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</A> cbHandler)</CODE> |
| |
| <BR> |
| Sets the crypto information required to process the RSTR.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, java.lang.String)">setCryptoInfo</A></B>(org.apache.ws.security.components.crypto.Crypto crypto, |
| <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> privKeyPasswd)</CODE> |
| |
| <BR> |
| Sets the crypto information required to process the RSTR.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setOptions(org.apache.axis2.client.Options)">setOptions</A></B>(org.apache.axis2.client.Options options)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setRstTemplate(org.apache.axiom.om.OMElement)">setRstTemplate</A></B>(org.apache.axiom.om.OMElement rstTemplate)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setSoapVersion(java.lang.String)">setSoapVersion</A></B>(<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> soapVersion)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setTrust10(org.apache.ws.secpolicy.model.Trust10)">setTrust10</A></B>(<A HREF="../../../../org/apache/ws/secpolicy/model/Trust10.html" title="class in org.apache.ws.secpolicy.model">Trust10</A> trust10)</CODE> |
| |
| <BR> |
| Set this to set the entropy configurations.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setTrust13(org.apache.ws.secpolicy.model.Trust13)">setTrust13</A></B>(<A HREF="../../../../org/apache/ws/secpolicy/model/Trust13.html" title="class in org.apache.ws.secpolicy.model">Trust13</A> trust13)</CODE> |
| |
| <BR> |
| Set this to set the entropy configurations.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setTtl(int)">setTtl</A></B>(int ttl)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/rahas/client/STSClient.html#setVersion(int)">setVersion</A></B>(int version)</CODE> |
| |
| <BR> |
| </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/rahas/client/STSClient.html#validateToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)">validateToken</A></B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy)</CODE> |
| |
| <BR> |
| </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.<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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></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="STSClient(org.apache.axis2.context.ConfigurationContext)"><!-- --></A><H3> |
| STSClient</H3> |
| <PRE> |
| public <B>STSClient</B>(org.apache.axis2.context.ConfigurationContext configCtx) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></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="requestSecurityToken(org.apache.neethi.Policy, java.lang.String, org.apache.neethi.Policy, java.lang.String)"><!-- --></A><H3> |
| requestSecurityToken</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</A> <B>requestSecurityToken</B>(org.apache.neethi.Policy servicePolicy, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy, |
| <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> appliesTo) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="cancelToken(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| cancelToken</H3> |
| <PRE> |
| public boolean <B>cancelToken</B>(<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> issuerAddress, |
| <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> tokenId, |
| <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> action) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD>Cancel a particular security token |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>issuerAddress</CODE> - <DD><CODE>tokenId</CODE> - |
| <DT><B>Returns:</B><DD>true is the Token was successfully canceled. False otherwise. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validateToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)"><!-- --></A><H3> |
| validateToken</H3> |
| <PRE> |
| public boolean <B>validateToken</B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)"><!-- --></A><H3> |
| renewToken</H3> |
| <PRE> |
| public boolean <B>renewToken</B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy, org.apache.rahas.TokenStorage)"><!-- --></A><H3> |
| renewToken</H3> |
| <PRE> |
| public boolean <B>renewToken</B>(<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> tokenId, |
| <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> issuerAddress, |
| org.apache.neethi.Policy issuerPolicy, |
| <A HREF="../../../../org/apache/rahas/TokenStorage.html" title="interface in org.apache.rahas">TokenStorage</A> store) |
| throws <A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DD>Renews the token referenced by the token id, updates the token store |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>tokenId</CODE> - <DD><CODE>issuerAddress</CODE> - <DD><CODE>issuerPolicy</CODE> - <DD><CODE>store</CODE> - |
| <DT><B>Returns:</B><DD>status |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTrust10(org.apache.ws.secpolicy.model.Trust10)"><!-- --></A><H3> |
| setTrust10</H3> |
| <PRE> |
| public void <B>setTrust10</B>(<A HREF="../../../../org/apache/ws/secpolicy/model/Trust10.html" title="class in org.apache.ws.secpolicy.model">Trust10</A> trust10)</PRE> |
| <DL> |
| <DD>Set this to set the entropy configurations. |
| If this is provided in the given policy it will be overridden. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>trust10</CODE> - The trust10 to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTrust13(org.apache.ws.secpolicy.model.Trust13)"><!-- --></A><H3> |
| setTrust13</H3> |
| <PRE> |
| public void <B>setTrust13</B>(<A HREF="../../../../org/apache/ws/secpolicy/model/Trust13.html" title="class in org.apache.ws.secpolicy.model">Trust13</A> trust13)</PRE> |
| <DL> |
| <DD>Set this to set the entropy configurations. |
| If this is provided in the given policy it will be overridden. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>trust13</CODE> - The trust13 to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAlgorithmSuite(org.apache.ws.secpolicy.model.AlgorithmSuite)"><!-- --></A><H3> |
| setAlgorithmSuite</H3> |
| <PRE> |
| public void <B>setAlgorithmSuite</B>(<A HREF="../../../../org/apache/ws/secpolicy/model/AlgorithmSuite.html" title="class in org.apache.ws.secpolicy.model">AlgorithmSuite</A> algorithmSuite)</PRE> |
| <DL> |
| <DD>This can be used in the case where the AlgorithmSuite is not specified in |
| the given policy. |
| If the AlgorithmSuite exists in a binding in the policy then the value |
| set will be overridden. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>algorithmSuite</CODE> - The algorithmSuite to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAddressingNs(java.lang.String)"><!-- --></A><H3> |
| setAddressingNs</H3> |
| <PRE> |
| public void <B>setAddressingNs</B>(<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> addressingNs)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>addressingNs</CODE> - The addressingNs to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTtl(int)"><!-- --></A><H3> |
| setTtl</H3> |
| <PRE> |
| public void <B>setTtl</B>(int ttl)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ttl</CODE> - The ttl to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, javax.security.auth.callback.CallbackHandler)"><!-- --></A><H3> |
| setCryptoInfo</H3> |
| <PRE> |
| public void <B>setCryptoInfo</B>(org.apache.ws.security.components.crypto.Crypto crypto, |
| <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</A> cbHandler)</PRE> |
| <DL> |
| <DD>Sets the crypto information required to process the RSTR. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>crypto</CODE> - Crypto information<DD><CODE>cbHandler</CODE> - Callback handler to provide the private key password to |
| decrypt</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, java.lang.String)"><!-- --></A><H3> |
| setCryptoInfo</H3> |
| <PRE> |
| public void <B>setCryptoInfo</B>(org.apache.ws.security.components.crypto.Crypto crypto, |
| <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> privKeyPasswd)</PRE> |
| <DL> |
| <DD>Sets the crypto information required to process the RSTR. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>crypto</CODE> - The crypto information<DD><CODE>privKeyPasswd</CODE> - Private key password to decrypt</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAction(java.lang.String)"><!-- --></A><H3> |
| setAction</H3> |
| <PRE> |
| public void <B>setAction</B>(<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> action)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>action</CODE> - The action to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOptions(org.apache.axis2.client.Options)"><!-- --></A><H3> |
| setOptions</H3> |
| <PRE> |
| public void <B>setOptions</B>(org.apache.axis2.client.Options options)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>options</CODE> - The options to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRstTemplate(org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| setRstTemplate</H3> |
| <PRE> |
| public void <B>setRstTemplate</B>(org.apache.axiom.om.OMElement rstTemplate)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>rstTemplate</CODE> - The rstTemplate to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersion(int)"><!-- --></A><H3> |
| setVersion</H3> |
| <PRE> |
| public void <B>setVersion</B>(int version)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>version</CODE> - The version to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSoapVersion(java.lang.String)"><!-- --></A><H3> |
| setSoapVersion</H3> |
| <PRE> |
| public void <B>setSoapVersion</B>(<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> soapVersion)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addParameter(org.apache.axis2.description.Parameter)"><!-- --></A><H3> |
| addParameter</H3> |
| <PRE> |
| public void <B>addParameter</B>(org.apache.axis2.description.Parameter param)</PRE> |
| <DL> |
| <DD><DL> |
| </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/STSClient.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 |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/rahas/client/STSClient.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="STSClient.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> |
| Copyright © <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
