| <!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>SAMLTokenRenewer (Apache CXF JavaDoc 3.1.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SAMLTokenRenewer (Apache CXF JavaDoc 3.1.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SAMLTokenRenewer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html" target="_top">Frames</a></li> |
| <li><a href="SAMLTokenRenewer.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.cxf.sts.token.renewer</div> |
| <h2 title="Class SAMLTokenRenewer" class="title">Class SAMLTokenRenewer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/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><a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">org.apache.cxf.sts.token.provider.AbstractSAMLTokenProvider</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.sts.token.renewer.SAMLTokenRenewer</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SAMLTokenRenewer</span> |
| extends <a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">AbstractSAMLTokenProvider</a> |
| implements <a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></pre> |
| <div class="block">A TokenRenewer implementation that renews a (valid or expired) SAML Token.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#DEFAULT_MAX_EXPIRY">DEFAULT_MAX_EXPIRY</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/cxf/sts/token/renewer/SAMLTokenRenewer.html#SAMLTokenRenewer()">SAMLTokenRenewer</a></strong>()</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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">canHandleToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> renewTarget)</code> |
| <div class="block">Return true if this TokenRenewer implementation is able to renew a token.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken,%20java.lang.String)">canHandleToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> renewTarget, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</code> |
| <div class="block">Return true if this TokenRenewer implementation is able to renew a token in the given realm.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#getConditionsProvider()">getConditionsProvider</a></strong>()</code> |
| <div class="block">Get the ConditionsProvider</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#getMaxExpiry()">getMaxExpiry</a></strong>()</code> |
| <div class="block">Get how long a token is allowed to be expired for before renewal (in seconds).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/SAMLRealm.html" title="class in org.apache.cxf.sts.token.realm">SAMLRealm</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#getRealmMap()">getRealmMap</a></strong>()</code> |
| <div class="block">Get the map of realm->SAMLRealm for this token provider</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#isAllowRenewalAfterExpiry()">isAllowRenewalAfterExpiry</a></strong>()</code> |
| <div class="block">Get whether we allow renewal after expiry.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#isSignToken()">isSignToken</a></strong>()</code> |
| <div class="block">Return whether the provided token will be signed or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewerResponse.html" title="class in org.apache.cxf.sts.token.renewer">TokenRenewerResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#renewToken(org.apache.cxf.sts.token.renewer.TokenRenewerParameters)">renewToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewerParameters.html" title="class in org.apache.cxf.sts.token.renewer">TokenRenewerParameters</a> tokenParameters)</code> |
| <div class="block">Renew a token given a TokenRenewerParameters</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setAllowRenewalAfterExpiry(boolean)">setAllowRenewalAfterExpiry</a></strong>(boolean allowRenewalAfterExpiry)</code> |
| <div class="block">Set whether we allow renewal after expiry.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setConditionsProvider(org.apache.cxf.sts.token.provider.ConditionsProvider)">setConditionsProvider</a></strong>(<a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> conditionsProvider)</code> |
| <div class="block">Set the ConditionsProvider</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setMaxExpiry(long)">setMaxExpiry</a></strong>(long newExpiry)</code> |
| <div class="block">Set a new value (in seconds) for how long a token is allowed to be expired for before renewal.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setRealmMap(java.util.Map)">setRealmMap</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/SAMLRealm.html" title="class in org.apache.cxf.sts.token.realm">SAMLRealm</a>> realms)</code> |
| <div class="block">Set the map of realm->SAMLRealm for this token provider</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setSignToken(boolean)">setSignToken</a></strong>(boolean signToken)</code> |
| <div class="block">Set whether the provided token will be signed or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html#setVerifyProofOfPossession(boolean)">setVerifyProofOfPossession</a></strong>(boolean verifyProofOfPossession)</code> |
| <div class="block">Set whether proof of possession is required or not to renew a token</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.sts.token.provider.AbstractSAMLTokenProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cxf.sts.token.provider.<a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">AbstractSAMLTokenProvider</a></h3> |
| <code><a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html#signToken(org.apache.wss4j.common.saml.SamlAssertionWrapper,%20org.apache.cxf.sts.token.realm.SAMLRealm,%20org.apache.cxf.sts.STSPropertiesMBean,%20org.apache.cxf.sts.request.KeyRequirements)">signToken</a></code></li> |
| </ul> |
| <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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_MAX_EXPIRY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAX_EXPIRY</h4> |
| <pre>public static final long DEFAULT_MAX_EXPIRY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.cxf.sts.token.renewer.SAMLTokenRenewer.DEFAULT_MAX_EXPIRY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SAMLTokenRenewer()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SAMLTokenRenewer</h4> |
| <pre>public SAMLTokenRenewer()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="canHandleToken(org.apache.cxf.sts.request.ReceivedToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleToken</h4> |
| <pre>public boolean canHandleToken(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> renewTarget)</pre> |
| <div class="block">Return true if this TokenRenewer implementation is able to renew a token.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">canHandleToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canHandleToken(org.apache.cxf.sts.request.ReceivedToken, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleToken</h4> |
| <pre>public boolean canHandleToken(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> renewTarget, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</pre> |
| <div class="block">Return true if this TokenRenewer implementation is able to renew a token in the given realm.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken,%20java.lang.String)">canHandleToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVerifyProofOfPossession(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVerifyProofOfPossession</h4> |
| <pre>public void setVerifyProofOfPossession(boolean verifyProofOfPossession)</pre> |
| <div class="block">Set whether proof of possession is required or not to renew a token</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html#setVerifyProofOfPossession(boolean)">setVerifyProofOfPossession</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAllowRenewalAfterExpiry()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAllowRenewalAfterExpiry</h4> |
| <pre>public boolean isAllowRenewalAfterExpiry()</pre> |
| <div class="block">Get whether we allow renewal after expiry. The default is false.</div> |
| </li> |
| </ul> |
| <a name="setAllowRenewalAfterExpiry(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllowRenewalAfterExpiry</h4> |
| <pre>public void setAllowRenewalAfterExpiry(boolean allowRenewalAfterExpiry)</pre> |
| <div class="block">Set whether we allow renewal after expiry. The default is false.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html#setAllowRenewalAfterExpiry(boolean)">setAllowRenewalAfterExpiry</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxExpiry(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxExpiry</h4> |
| <pre>public void setMaxExpiry(long newExpiry)</pre> |
| <div class="block">Set a new value (in seconds) for how long a token is allowed to be expired for before renewal. |
| The default is 30 minutes.</div> |
| </li> |
| </ul> |
| <a name="getMaxExpiry()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxExpiry</h4> |
| <pre>public long getMaxExpiry()</pre> |
| <div class="block">Get how long a token is allowed to be expired for before renewal (in seconds). The default is |
| 30 minutes.</div> |
| </li> |
| </ul> |
| <a name="renewToken(org.apache.cxf.sts.token.renewer.TokenRenewerParameters)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewToken</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewerResponse.html" title="class in org.apache.cxf.sts.token.renewer">TokenRenewerResponse</a> renewToken(<a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewerParameters.html" title="class in org.apache.cxf.sts.token.renewer">TokenRenewerParameters</a> tokenParameters)</pre> |
| <div class="block">Renew a token given a TokenRenewerParameters</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html#renewToken(org.apache.cxf.sts.token.renewer.TokenRenewerParameters)">renewToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer">TokenRenewer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConditionsProvider(org.apache.cxf.sts.token.provider.ConditionsProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConditionsProvider</h4> |
| <pre>public void setConditionsProvider(<a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> conditionsProvider)</pre> |
| <div class="block">Set the ConditionsProvider</div> |
| </li> |
| </ul> |
| <a name="getConditionsProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConditionsProvider</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> getConditionsProvider()</pre> |
| <div class="block">Get the ConditionsProvider</div> |
| </li> |
| </ul> |
| <a name="isSignToken()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSignToken</h4> |
| <pre>public boolean isSignToken()</pre> |
| <div class="block">Return whether the provided token will be signed or not. Default is true.</div> |
| </li> |
| </ul> |
| <a name="setSignToken(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSignToken</h4> |
| <pre>public void setSignToken(boolean signToken)</pre> |
| <div class="block">Set whether the provided token will be signed or not. Default is true.</div> |
| </li> |
| </ul> |
| <a name="setRealmMap(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealmMap</h4> |
| <pre>public void setRealmMap(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/SAMLRealm.html" title="class in org.apache.cxf.sts.token.realm">SAMLRealm</a>> realms)</pre> |
| <div class="block">Set the map of realm->SAMLRealm for this token provider</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>realms</code> - the map of realm->SAMLRealm for this token provider</dd></dl> |
| </li> |
| </ul> |
| <a name="getRealmMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRealmMap</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/SAMLRealm.html" title="class in org.apache.cxf.sts.token.realm">SAMLRealm</a>> getRealmMap()</pre> |
| <div class="block">Get the map of realm->SAMLRealm for this token provider</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the map of realm->SAMLRealm for this token provider</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/SAMLTokenRenewer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/renewer/TokenRenewer.html" title="interface in org.apache.cxf.sts.token.renewer"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/renewer/SAMLTokenRenewer.html" target="_top">Frames</a></li> |
| <li><a href="SAMLTokenRenewer.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>Apache CXF</small></p> |
| </body> |
| </html> |