blob: 512b98c905e3683fb8e8e0ca7b9ade9899746ce3 [file] [log] [blame]
<!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>AccessTokenGrant (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="AccessTokenGrant (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/AccessTokenGrant.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><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.common"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" target="_top">Frames</a></li>
<li><a href="AccessTokenGrant.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.common</div>
<h2 title="Interface AccessTokenGrant" class="title">Interface AccessTokenGrant</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/AbstractGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants">AbstractGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/jwt/AbstractJwtBearerGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.jwt">AbstractJwtBearerGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/saml/AbstractSaml2BearerGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.saml">AbstractSaml2BearerGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">AuthorizationCodeGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/clientcred/ClientCredentialsGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.clientcred">ClientCredentialsGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/jwt/JwtBearerClientCredentialsGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.jwt">JwtBearerClientCredentialsGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/jwt/JwtBearerGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.jwt">JwtBearerGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/JwtRequestCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">JwtRequestCodeGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/refresh/RefreshTokenGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.refresh">RefreshTokenGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/owner/ResourceOwnerGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.owner">ResourceOwnerGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/saml/Saml2BearerGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.saml">Saml2BearerGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/saml/SamlBearerClientCredentialsGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.saml">SamlBearerClientCredentialsGrant</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/ServerAuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">ServerAuthorizationCodeGrant</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">AccessTokenGrant</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Access Token Grant</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</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><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></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html#getType()">getType</a></strong>()</code>
<div class="block">Returns the token grant type, example, "authorization_code"</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.MultivaluedMap&lt;<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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html#toMap()">toMap</a></strong>()</code>
<div class="block">Returns the map containing public grant parameters;
can be used by clients requesting the access tokens.</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="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><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>&nbsp;getType()</pre>
<div class="block">Returns the token grant type, example, "authorization_code"</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the grant type</dd></dl>
</li>
</ul>
<a name="toMap()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toMap</h4>
<pre>javax.ws.rs.core.MultivaluedMap&lt;<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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;toMap()</pre>
<div class="block">Returns the map containing public grant parameters;
can be used by clients requesting the access tokens.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the grant parameters</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/AccessTokenGrant.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><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.common"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" target="_top">Frames</a></li>
<li><a href="AccessTokenGrant.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>