| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DefaultJWTClaimsProvider (Apache CXF JavaDoc 3.2.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultJWTClaimsProvider (Apache CXF JavaDoc 3.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/DefaultJWTClaimsProvider.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">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProvider.html" title="interface in org.apache.cxf.sts.token.provider.jwt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html" target="_top">Frames</a></li> |
| <li><a href="DefaultJWTClaimsProvider.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.provider.jwt</div> |
| <h2 title="Class DefaultJWTClaimsProvider" class="title">Class DefaultJWTClaimsProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/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.cxf.sts.token.provider.jwt.DefaultJWTClaimsProvider</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/provider/jwt/JWTClaimsProvider.html" title="interface in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DefaultJWTClaimsProvider</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProvider.html" title="interface in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProvider</a></pre> |
| <div class="block">A default implementation to create a JWTClaims object. The Subject name is the name |
| of the current principal.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#DEFAULT_MAX_LIFETIME">DEFAULT_MAX_LIFETIME</a></span></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#DefaultJWTClaimsProvider--">DefaultJWTClaimsProvider</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getClaimTypeMap--">getClaimTypeMap</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getFutureTimeToLive--">getFutureTimeToLive</a></span>()</code> |
| <div class="block">Get how long (in seconds) a client-supplied Created Element is allowed to be in the future.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getJwtClaims-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-">getJwtClaims</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</code> |
| <div class="block">Get a JwtClaims object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getLifetime--">getLifetime</a></span>()</code> |
| <div class="block">Get the default lifetime in seconds for issued JWT token where requestor |
| doesn't specify a lifetime element</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getMaxLifetime--">getMaxLifetime</a></span>()</code> |
| <div class="block">Get the maximum lifetime in seconds for issued JWT token |
| if requestor specifies lifetime element</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getPrincipal-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-">getPrincipal</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</code> |
| <div class="block">Get the Principal (which is used as the Subject).</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#getSubjectName-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-">getSubjectName</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#handleActAs-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-">handleActAs</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#handleAudienceRestriction-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-">handleAudienceRestriction</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</code> |
| <div class="block">Set the audience restriction claim.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#handleConditions-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-">handleConditions</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#handleWSTrustClaims-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-">handleWSTrustClaims</a></span>(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#isAcceptClientLifetime--">isAcceptClientLifetime</a></span>()</code> |
| <div class="block">Is client lifetime element accepted |
| Default: false</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#isFailLifetimeExceedance--">isFailLifetimeExceedance</a></span>()</code> |
| <div class="block">If requested lifetime exceeds shall it fail (default) |
| or overwrite with maximum lifetime</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#isUseX500CN--">isUseX500CN</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setAcceptClientLifetime-boolean-">setAcceptClientLifetime</a></span>(boolean acceptClientLifetime)</code> |
| <div class="block">Set whether client lifetime is accepted</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setClaimTypeMap-java.util.Map-">setClaimTypeMap</a></span>(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> claimTypeMap)</code> |
| <div class="block">Specify a way to map ClaimType URIs to custom ClaimTypes</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setFailLifetimeExceedance-boolean-">setFailLifetimeExceedance</a></span>(boolean failLifetimeExceedance)</code> |
| <div class="block">If requested lifetime exceeds shall it fail (default) |
| or overwrite with maximum lifetime</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setFutureTimeToLive-long-">setFutureTimeToLive</a></span>(long futureTimeToLive)</code> |
| <div class="block">Set how long (in seconds) a client-supplied Created Element is allowed to be in the future.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setLifetime-long-">setLifetime</a></span>(long lifetime)</code> |
| <div class="block">Set the default lifetime in seconds for issued JWT tokens</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setMaxLifetime-long-">setMaxLifetime</a></span>(long maxLifetime)</code> |
| <div class="block">Set the maximum lifetime in seconds for issued JWT tokens</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html#setUseX500CN-boolean-">setUseX500CN</a></span>(boolean useX500CN)</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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_MAX_LIFETIME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAX_LIFETIME</h4> |
| <pre>public static final long DEFAULT_MAX_LIFETIME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.cxf.sts.token.provider.jwt.DefaultJWTClaimsProvider.DEFAULT_MAX_LIFETIME">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="DefaultJWTClaimsProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultJWTClaimsProvider</h4> |
| <pre>public DefaultJWTClaimsProvider()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getJwtClaims-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJwtClaims</h4> |
| <pre>public <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> getJwtClaims(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</pre> |
| <div class="block">Get a JwtClaims object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProvider.html#getJwtClaims-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-">getJwtClaims</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProvider.html" title="interface in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSubjectName-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubjectName</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSubjectName(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</pre> |
| </li> |
| </ul> |
| <a name="getPrincipal-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipal</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a> getPrincipal(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters)</pre> |
| <div class="block">Get the Principal (which is used as the Subject). By default, we check the following (in order): |
| - A valid OnBehalfOf principal |
| - A valid principal associated with a token received as ValidateTarget |
| - The principal associated with the request. We don't need to check to see if it is "valid" here, as it |
| is not parsed by the STS (but rather the WS-Security layer).</div> |
| </li> |
| </ul> |
| <a name="handleWSTrustClaims-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleWSTrustClaims</h4> |
| <pre>protected void handleWSTrustClaims(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</pre> |
| </li> |
| </ul> |
| <a name="handleConditions-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleConditions</h4> |
| <pre>protected void handleConditions(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</pre> |
| </li> |
| </ul> |
| <a name="handleAudienceRestriction-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleAudienceRestriction</h4> |
| <pre>protected void handleAudienceRestriction(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</pre> |
| <div class="block">Set the audience restriction claim. The Audiences are from an AppliesTo address, and the wst:Participants |
| (if either exist).</div> |
| </li> |
| </ul> |
| <a name="handleActAs-org.apache.cxf.sts.token.provider.jwt.JWTClaimsProviderParameters-org.apache.cxf.rs.security.jose.jwt.JwtClaims-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleActAs</h4> |
| <pre>protected void handleActAs(<a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProviderParameters.html" title="class in org.apache.cxf.sts.token.provider.jwt">JWTClaimsProviderParameters</a> jwtClaimsProviderParameters, |
| <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwt/JwtClaims.html" title="class in org.apache.cxf.rs.security.jose.jwt">JwtClaims</a> claims)</pre> |
| </li> |
| </ul> |
| <a name="isUseX500CN--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUseX500CN</h4> |
| <pre>public boolean isUseX500CN()</pre> |
| </li> |
| </ul> |
| <a name="setUseX500CN-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseX500CN</h4> |
| <pre>public void setUseX500CN(boolean useX500CN)</pre> |
| </li> |
| </ul> |
| <a name="getFutureTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFutureTimeToLive</h4> |
| <pre>public long getFutureTimeToLive()</pre> |
| <div class="block">Get how long (in seconds) a client-supplied Created Element is allowed to be in the future. |
| The default is 60 seconds to avoid common problems relating to clock skew.</div> |
| </li> |
| </ul> |
| <a name="setFutureTimeToLive-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFutureTimeToLive</h4> |
| <pre>public void setFutureTimeToLive(long futureTimeToLive)</pre> |
| <div class="block">Set how long (in seconds) a client-supplied Created Element is allowed to be in the future. |
| The default is 60 seconds to avoid common problems relating to clock skew.</div> |
| </li> |
| </ul> |
| <a name="setLifetime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLifetime</h4> |
| <pre>public void setLifetime(long lifetime)</pre> |
| <div class="block">Set the default lifetime in seconds for issued JWT tokens</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>default</code> - lifetime in seconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLifetime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLifetime</h4> |
| <pre>public long getLifetime()</pre> |
| <div class="block">Get the default lifetime in seconds for issued JWT token where requestor |
| doesn't specify a lifetime element</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the lifetime in seconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxLifetime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxLifetime</h4> |
| <pre>public void setMaxLifetime(long maxLifetime)</pre> |
| <div class="block">Set the maximum lifetime in seconds for issued JWT tokens</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maximum</code> - lifetime in seconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxLifetime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxLifetime</h4> |
| <pre>public long getMaxLifetime()</pre> |
| <div class="block">Get the maximum lifetime in seconds for issued JWT token |
| if requestor specifies lifetime element</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum lifetime in seconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAcceptClientLifetime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAcceptClientLifetime</h4> |
| <pre>public boolean isAcceptClientLifetime()</pre> |
| <div class="block">Is client lifetime element accepted |
| Default: false</div> |
| </li> |
| </ul> |
| <a name="setAcceptClientLifetime-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAcceptClientLifetime</h4> |
| <pre>public void setAcceptClientLifetime(boolean acceptClientLifetime)</pre> |
| <div class="block">Set whether client lifetime is accepted</div> |
| </li> |
| </ul> |
| <a name="isFailLifetimeExceedance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFailLifetimeExceedance</h4> |
| <pre>public boolean isFailLifetimeExceedance()</pre> |
| <div class="block">If requested lifetime exceeds shall it fail (default) |
| or overwrite with maximum lifetime</div> |
| </li> |
| </ul> |
| <a name="setFailLifetimeExceedance-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFailLifetimeExceedance</h4> |
| <pre>public void setFailLifetimeExceedance(boolean failLifetimeExceedance)</pre> |
| <div class="block">If requested lifetime exceeds shall it fail (default) |
| or overwrite with maximum lifetime</div> |
| </li> |
| </ul> |
| <a name="getClaimTypeMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClaimTypeMap</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getClaimTypeMap()</pre> |
| </li> |
| </ul> |
| <a name="setClaimTypeMap-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setClaimTypeMap</h4> |
| <pre>public void setClaimTypeMap(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> claimTypeMap)</pre> |
| <div class="block">Specify a way to map ClaimType URIs to custom ClaimTypes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>claimTypeMap</code> - </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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/DefaultJWTClaimsProvider.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">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/cxf/sts/token/provider/jwt/JWTClaimsProvider.html" title="interface in org.apache.cxf.sts.token.provider.jwt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/sts/token/provider/jwt/DefaultJWTClaimsProvider.html" target="_top">Frames</a></li> |
| <li><a href="DefaultJWTClaimsProvider.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> |