Google Git
Sign in
apache / cxf-site / refs/heads/asf-staging / . / content / javadoc / latest-3.1.x / org / apache / cxf / rs / security / oauth2 / provider / SessionAuthenticityTokenProvider.html
blob: 96f36da7d63ed364f209aa3a692b484c4221561e [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>SessionAuthenticityTokenProvider (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="SessionAuthenticityTokenProvider (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/SessionAuthenticityTokenProvider.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/provider/ResourceOwnerNameProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/SubjectCreator.html" title="interface in org.apache.cxf.rs.security.oauth2.provider"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.html" target="_top">Frames</a></li>
<li><a href="SessionAuthenticityTokenProvider.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.provider</div>
<h2 title="Interface SessionAuthenticityTokenProvider" class="title">Interface SessionAuthenticityTokenProvider</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/JoseSessionTokenProvider.html" title="class in org.apache.cxf.rs.security.oauth2.provider">JoseSessionTokenProvider</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SessionAuthenticityTokenProvider</span></pre>
<div class="block">SessionAuthenticityTokenProvider responsible for storing and retrieving tokens
to validate the authenticity of request sessions</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/provider/SessionAuthenticityTokenProvider.html#createSessionToken(org.apache.cxf.jaxrs.ext.MessageContext,%20javax.ws.rs.core.MultivaluedMap,%20org.apache.cxf.rs.security.oauth2.common.UserSubject,%20org.apache.cxf.rs.security.oauth2.common.OAuthRedirectionState)">createSessionToken</a></strong>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthRedirectionState.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthRedirectionState</a>&nbsp;secData)</code>
<div class="block">Create a new session token and stores it</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthRedirectionState.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthRedirectionState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.html#getSessionState(org.apache.cxf.jaxrs.ext.MessageContext,%20java.lang.String,%20org.apache.cxf.rs.security.oauth2.common.UserSubject)">getSessionState</a></strong>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;messageContext,
<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;sessionToken,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</code>
<div class="block">Expand the session token</div>
</td>
</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/provider/SessionAuthenticityTokenProvider.html#getSessionToken(org.apache.cxf.jaxrs.ext.MessageContext,%20javax.ws.rs.core.MultivaluedMap,%20org.apache.cxf.rs.security.oauth2.common.UserSubject)">getSessionToken</a></strong>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</code>
<div class="block">Retrieve the stored session token</div>
</td>
</tr>
<tr class="rowColor">
<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/provider/SessionAuthenticityTokenProvider.html#removeSessionToken(org.apache.cxf.jaxrs.ext.MessageContext,%20javax.ws.rs.core.MultivaluedMap,%20org.apache.cxf.rs.security.oauth2.common.UserSubject)">removeSessionToken</a></strong>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</code>
<div class="block">Remove the stored session 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="createSessionToken(org.apache.cxf.jaxrs.ext.MessageContext, javax.ws.rs.core.MultivaluedMap, org.apache.cxf.rs.security.oauth2.common.UserSubject, org.apache.cxf.rs.security.oauth2.common.OAuthRedirectionState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSessionToken</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;createSessionToken(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthRedirectionState.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthRedirectionState</a>&nbsp;secData)</pre>
<div class="block">Create a new session token and stores it</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mc</code> - the <a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext"><code>MessageContext</code></a> of this request</dd><dd><code>params</code> - redirection-based grant request parameters</dd><dd><code>subject</code> - authenticated end user</dd><dd><code>secData</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the created session token</dd></dl>
</li>
</ul>
<a name="getSessionToken(org.apache.cxf.jaxrs.ext.MessageContext, javax.ws.rs.core.MultivaluedMap, org.apache.cxf.rs.security.oauth2.common.UserSubject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionToken</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;getSessionToken(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</pre>
<div class="block">Retrieve the stored session token</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mc</code> - the <a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext"><code>MessageContext</code></a> of this request</dd><dd><code>params</code> - grant authorization parameters</dd><dd><code>subject</code> - authenticated end user</dd>
<dt><span class="strong">Returns:</span></dt><dd>the stored token</dd></dl>
</li>
</ul>
<a name="removeSessionToken(org.apache.cxf.jaxrs.ext.MessageContext, javax.ws.rs.core.MultivaluedMap, org.apache.cxf.rs.security.oauth2.common.UserSubject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSessionToken</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;removeSessionToken(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
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;params,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</pre>
<div class="block">Remove the stored session token</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mc</code> - the <a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext"><code>MessageContext</code></a> of this request</dd><dd><code>params</code> - grant authorization parameters</dd><dd><code>subject</code> - authenticated end user</dd></dl>
</li>
</ul>
<a name="getSessionState(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String, org.apache.cxf.rs.security.oauth2.common.UserSubject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSessionState</h4>
<pre><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthRedirectionState.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthRedirectionState</a>&nbsp;getSessionState(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;messageContext,
<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;sessionToken,
<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</a>&nbsp;subject)</pre>
<div class="block">Expand the session token</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mc</code> - the <a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext"><code>MessageContext</code></a> of this request</dd><dd><code>sessionToken</code> - the token</dd><dd><code>subject</code> - authenticated end user</dd>
<dt><span class="strong">Returns:</span></dt><dd>the expanded token or null</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/SessionAuthenticityTokenProvider.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/provider/ResourceOwnerNameProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/provider/SubjectCreator.html" title="interface in org.apache.cxf.rs.security.oauth2.provider"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.html" target="_top">Frames</a></li>
<li><a href="SessionAuthenticityTokenProvider.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>