| <!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>OAuthDataProvider (Apache CXF JavaDoc 3.4.5 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="OAuthDataProvider (Apache CXF JavaDoc 3.4.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OAuthDataProvider.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><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthContextProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthJoseJwtConsumer.html" title="class in org.apache.cxf.rs.security.oauth2.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" target="_top">Frames</a></li> |
| <li><a href="OAuthDataProvider.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.rs.security.oauth2.provider</div> |
| <h2 title="Interface OAuthDataProvider" class="title">Interface OAuthDataProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.grants.code">AuthorizationCodeDataProvider</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AbstractAuthorizationCodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">AbstractAuthorizationCodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AbstractCodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">AbstractCodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/AbstractOAuthDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider">AbstractOAuthDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/DefaultEncryptingCodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">DefaultEncryptingCodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/DefaultEncryptingOAuthDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider">DefaultEncryptingOAuthDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/JCacheCodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">JCacheCodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/JCacheOAuthDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider">JCacheOAuthDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/JPACMTCodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">JPACMTCodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/JPACodeDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">JPACodeDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/JPAOAuthDataProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider">JPAOAuthDataProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OAuthDataProvider</span></pre> |
| <div class="block">OAuth provider responsible for persisting the information about |
| OAuth consumers, request and access tokens.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthPermission.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthPermission</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#convertScopeToPermissions-org.apache.cxf.rs.security.oauth2.common.Client-java.util.List-">convertScopeToPermissions</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes)</code> |
| <div class="block">Converts the requested scopes to the list of permissions.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#createAccessToken-org.apache.cxf.rs.security.oauth2.common.AccessTokenRegistration-">createAccessToken</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.common">AccessTokenRegistration</a> accessToken)</code> |
| <div class="block">Create access token</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getAccessToken-java.lang.String-">getAccessToken</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken)</code> |
| <div class="block">Get access token</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getAccessTokens-org.apache.cxf.rs.security.oauth2.common.Client-org.apache.cxf.rs.security.oauth2.common.UserSubject-">getAccessTokens</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject)</code> |
| <div class="block">Return all access tokens associated with a given client</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getClient-java.lang.String-">getClient</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</code> |
| <div class="block">Returns the previously registered third-party <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common"><code>Client</code></a></div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getPreauthorizedToken-org.apache.cxf.rs.security.oauth2.common.Client-java.util.List-org.apache.cxf.rs.security.oauth2.common.UserSubject-java.lang.String-">getPreauthorizedToken</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> grantType)</code> |
| <div class="block">Get preauthorized access token</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/tokens/refresh/RefreshToken.html" title="class in org.apache.cxf.rs.security.oauth2.tokens.refresh">RefreshToken</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getRefreshTokens-org.apache.cxf.rs.security.oauth2.common.Client-org.apache.cxf.rs.security.oauth2.common.UserSubject-">getRefreshTokens</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject)</code> |
| <div class="block">Return all refresh tokens associated with a given client</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#refreshAccessToken-org.apache.cxf.rs.security.oauth2.common.Client-java.lang.String-java.util.List-">refreshAccessToken</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> refreshToken, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes)</code> |
| <div class="block">Refresh access token</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#revokeToken-org.apache.cxf.rs.security.oauth2.common.Client-java.lang.String-java.lang.String-">revokeToken</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenTypeHint)</code> |
| <div class="block">Revokes a refresh or access token</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getClient-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClient</h4> |
| <pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> getClient(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Returns the previously registered third-party <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common"><code>Client</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clientId</code> - the client id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Client</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAccessToken-org.apache.cxf.rs.security.oauth2.common.AccessTokenRegistration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAccessToken</h4> |
| <pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a> createAccessToken(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.common">AccessTokenRegistration</a> accessToken) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Create access token</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>accessToken</code> - the token registration info</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>AccessToken</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccessToken-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessToken</h4> |
| <pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a> getAccessToken(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Get access token</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>accessToken</code> - the token key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>AccessToken</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPreauthorizedToken-org.apache.cxf.rs.security.oauth2.common.Client-java.util.List-org.apache.cxf.rs.security.oauth2.common.UserSubject-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPreauthorizedToken</h4> |
| <pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a> getPreauthorizedToken(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> grantType) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Get preauthorized access token</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - Client</dd> |
| <dd><code>requestedScopes</code> - the scopes requested by the client</dd> |
| <dd><code>subject</code> - End User subject</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>AccessToken access token</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAccessToken-org.apache.cxf.rs.security.oauth2.common.Client-java.lang.String-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAccessToken</h4> |
| <pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a> refreshAccessToken(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> refreshToken, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Refresh access token</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the client</dd> |
| <dd><code>refreshToken</code> - refresh token key</dd> |
| <dd><code>requestedScopes</code> - the scopes requested by the client</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>AccessToken</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccessTokens-org.apache.cxf.rs.security.oauth2.common.Client-org.apache.cxf.rs.security.oauth2.common.UserSubject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessTokens</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ServerAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ServerAccessToken</a>> getAccessTokens(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Return all access tokens associated with a given client</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the client</dd> |
| <dd><code>subject</code> - the user subject, can be null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of access tokens</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRefreshTokens-org.apache.cxf.rs.security.oauth2.common.Client-org.apache.cxf.rs.security.oauth2.common.UserSubject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRefreshTokens</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/tokens/refresh/RefreshToken.html" title="class in org.apache.cxf.rs.security.oauth2.tokens.refresh">RefreshToken</a>> getRefreshTokens(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a> subject) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Return all refresh tokens associated with a given client</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the client</dd> |
| <dd><code>subject</code> - the user subject, can be null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of refresh tokens</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="revokeToken-org.apache.cxf.rs.security.oauth2.common.Client-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>revokeToken</h4> |
| <pre>void revokeToken(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenTypeHint) |
| throws <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></pre> |
| <div class="block">Revokes a refresh or access token</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the client</dd> |
| <dd><code>tokenId</code> - token identifier</dd> |
| <dd><code>tokenTypeHint</code> - can be access_token or refresh_token or null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthServiceException.html" title="class in org.apache.cxf.rs.security.oauth2.provider">OAuthServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertScopeToPermissions-org.apache.cxf.rs.security.oauth2.common.Client-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertScopeToPermissions</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthPermission.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthPermission</a>> convertScopeToPermissions(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html" title="class in org.apache.cxf.rs.security.oauth2.common">Client</a> client, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> requestedScopes)</pre> |
| <div class="block">Converts the requested scopes to the list of permissions. |
| The scopes are extracted from OAuth2 'scope' property which |
| if set may contain one or more space separated scope values</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestedScopes</code> - the scopes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of permissions</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/OAuthDataProvider.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><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthContextProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthJoseJwtConsumer.html" title="class in org.apache.cxf.rs.security.oauth2.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" target="_top">Frames</a></li> |
| <li><a href="OAuthDataProvider.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |