| <!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>STSClient (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="STSClient (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/STSClient.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/rahas/client/STSClient.html" target="_top">Frames</a></li> |
| <li><a href="STSClient.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.rahas.client</div> |
| <h2 title="Class STSClient" class="title">Class STSClient</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.rahas.client.STSClient</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">STSClient</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> |
| </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/rahas/client/STSClient.html#STSClient(org.apache.axis2.context.ConfigurationContext)">STSClient</a></strong>(org.apache.axis2.context.ConfigurationContext configCtx)</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></strong>(org.apache.axis2.description.Parameter param)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#cancelToken(java.lang.String, java.lang.String, java.lang.String)">cancelToken</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> 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> |
| <div class="block">Cancel a particular security token</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.axiom.om.OMElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#createIssueRequest(java.lang.String)">createIssueRequest</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> appliesTo)</code> |
| <div class="block">This creates a request security token (RST) message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#processIssueResponse(int, org.apache.axiom.om.OMElement, java.lang.String)">processIssueResponse</a></strong>(int version, |
| org.apache.axiom.om.OMElement result, |
| <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)</code> |
| <div class="block">Processes the response from Token issuer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)">renewToken</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> 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> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><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></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> 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> |
| <div class="block">Renews the token referenced by the token id, updates the token store</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a></code></td> |
| <td class="colLast"><code><strong><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></strong>(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> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setAction(java.lang.String)">setAction</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> action)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setAddressingNs(java.lang.String)">setAddressingNs</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> addressingNs)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setAlgorithmSuite(org.apache.ws.secpolicy.model.AlgorithmSuite)">setAlgorithmSuite</a></strong>(<a href="../../../../org/apache/ws/secpolicy/model/AlgorithmSuite.html" title="class in org.apache.ws.secpolicy.model">AlgorithmSuite</a> algorithmSuite)</code> |
| <div class="block">This can be used in the case where the AlgorithmSuite is not specified in |
| the given policy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, javax.security.auth.callback.CallbackHandler)">setCryptoInfo</a></strong>(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> |
| <div class="block">Sets the crypto information required to process the RSTR.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, java.lang.String)">setCryptoInfo</a></strong>(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> |
| <div class="block">Sets the crypto information required to process the RSTR.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setOptions(org.apache.axis2.client.Options)">setOptions</a></strong>(org.apache.axis2.client.Options options)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setRstTemplate(org.apache.axiom.om.OMElement)">setRstTemplate</a></strong>(org.apache.axiom.om.OMElement rstTemplate)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setSoapVersion(java.lang.String)">setSoapVersion</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> soapVersion)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setTrust10(org.apache.ws.secpolicy.model.Trust10)">setTrust10</a></strong>(<a href="../../../../org/apache/ws/secpolicy/model/Trust10.html" title="class in org.apache.ws.secpolicy.model">Trust10</a> trust10)</code> |
| <div class="block">Set this to set the entropy configurations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setTrust13(org.apache.ws.secpolicy.model.Trust13)">setTrust13</a></strong>(<a href="../../../../org/apache/ws/secpolicy/model/Trust13.html" title="class in org.apache.ws.secpolicy.model">Trust13</a> trust13)</code> |
| <div class="block">Set this to set the entropy configurations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setTtl(int)">setTtl</a></strong>(int ttl)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#setVersion(int)">setVersion</a></strong>(int version)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/rahas/client/STSClient.html#validateToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)">validateToken</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> 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> </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/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="STSClient(org.apache.axis2.context.ConfigurationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>STSClient</h4> |
| <pre>public STSClient(org.apache.axis2.context.ConfigurationContext configCtx) |
| throws <a href="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre> |
| <dl><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></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="requestSecurityToken(org.apache.neethi.Policy, java.lang.String, org.apache.neethi.Policy, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestSecurityToken</h4> |
| <pre>public <a href="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a> requestSecurityToken(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><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></dd></dl> |
| </li> |
| </ul> |
| <a name="cancelToken(java.lang.String, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelToken</h4> |
| <pre>public boolean cancelToken(<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> |
| <div class="block">Cancel a particular security token</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>issuerAddress</code> - </dd><dd><code>tokenId</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true is the Token was successfully canceled. False otherwise.</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></dd></dl> |
| </li> |
| </ul> |
| <a name="validateToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateToken</h4> |
| <pre>public boolean validateToken(<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><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></dd></dl> |
| </li> |
| </ul> |
| <a name="renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewToken</h4> |
| <pre>public boolean renewToken(<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><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></dd></dl> |
| </li> |
| </ul> |
| <a name="renewToken(java.lang.String, java.lang.String, org.apache.neethi.Policy, org.apache.rahas.TokenStorage)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewToken</h4> |
| <pre>public boolean renewToken(<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> |
| <div class="block">Renews the token referenced by the token id, updates the token store</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>tokenId</code> - </dd><dd><code>issuerAddress</code> - </dd><dd><code>issuerPolicy</code> - </dd><dd><code>store</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>status</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></dd></dl> |
| </li> |
| </ul> |
| <a name="processIssueResponse(int, org.apache.axiom.om.OMElement, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processIssueResponse</h4> |
| <pre>protected <a href="../../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a> processIssueResponse(int version, |
| org.apache.axiom.om.OMElement result, |
| <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) |
| throws <a href="../../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre> |
| <div class="block">Processes the response from Token issuer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - The supported version.</dd><dd><code>result</code> - Resulting token response from token issuer.</dd><dd><code>issuerAddress</code> - The respective token applying entity (as a url)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The issued token.</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 extracting token from response.</dd></dl> |
| </li> |
| </ul> |
| <a name="createIssueRequest(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createIssueRequest</h4> |
| <pre>protected org.apache.axiom.om.OMElement createIssueRequest(<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> |
| <div class="block">This creates a request security token (RST) message.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>appliesTo</code> - The address which token is applicable to.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The axiom object representation of RST.</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 creating the RST.</dd></dl> |
| </li> |
| </ul> |
| <a name="setTrust10(org.apache.ws.secpolicy.model.Trust10)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrust10</h4> |
| <pre>public void setTrust10(<a href="../../../../org/apache/ws/secpolicy/model/Trust10.html" title="class in org.apache.ws.secpolicy.model">Trust10</a> trust10)</pre> |
| <div class="block">Set this to set the entropy configurations. |
| If this is provided in the given policy it will be overridden.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>trust10</code> - The trust10 to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setTrust13(org.apache.ws.secpolicy.model.Trust13)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrust13</h4> |
| <pre>public void setTrust13(<a href="../../../../org/apache/ws/secpolicy/model/Trust13.html" title="class in org.apache.ws.secpolicy.model">Trust13</a> trust13)</pre> |
| <div class="block">Set this to set the entropy configurations. |
| If this is provided in the given policy it will be overridden.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>trust13</code> - The trust13 to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setAlgorithmSuite(org.apache.ws.secpolicy.model.AlgorithmSuite)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAlgorithmSuite</h4> |
| <pre>public void setAlgorithmSuite(<a href="../../../../org/apache/ws/secpolicy/model/AlgorithmSuite.html" title="class in org.apache.ws.secpolicy.model">AlgorithmSuite</a> algorithmSuite)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>algorithmSuite</code> - The algorithmSuite to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setAddressingNs(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddressingNs</h4> |
| <pre>public void setAddressingNs(<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><dt><span class="strong">Parameters:</span></dt><dd><code>addressingNs</code> - The addressingNs to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setTtl(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTtl</h4> |
| <pre>public void setTtl(int ttl)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ttl</code> - The ttl to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, javax.security.auth.callback.CallbackHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCryptoInfo</h4> |
| <pre>public void setCryptoInfo(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> |
| <div class="block">Sets the crypto information required to process the RSTR.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>crypto</code> - Crypto information</dd><dd><code>cbHandler</code> - Callback handler to provide the private key password to |
| decrypt</dd></dl> |
| </li> |
| </ul> |
| <a name="setCryptoInfo(org.apache.ws.security.components.crypto.Crypto, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCryptoInfo</h4> |
| <pre>public void setCryptoInfo(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> |
| <div class="block">Sets the crypto information required to process the RSTR.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>crypto</code> - The crypto information</dd><dd><code>privKeyPasswd</code> - Private key password to decrypt</dd></dl> |
| </li> |
| </ul> |
| <a name="setAction(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAction</h4> |
| <pre>public void setAction(<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><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setOptions(org.apache.axis2.client.Options)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptions</h4> |
| <pre>public void setOptions(org.apache.axis2.client.Options options)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - The options to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setRstTemplate(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRstTemplate</h4> |
| <pre>public void setRstTemplate(org.apache.axiom.om.OMElement rstTemplate)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rstTemplate</code> - The rstTemplate to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setVersion(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre>public void setVersion(int version)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - The version to set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSoapVersion(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSoapVersion</h4> |
| <pre>public void setSoapVersion(<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> |
| </li> |
| </ul> |
| <a name="addParameter(org.apache.axis2.description.Parameter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addParameter</h4> |
| <pre>public void addParameter(org.apache.axis2.description.Parameter param)</pre> |
| </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/STSClient.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/rahas/client/STSClient.html" target="_top">Frames</a></li> |
| <li><a href="STSClient.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 © <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
