Google Git
Sign in
apache / cxf-site / refs/heads/asf-staging / . / content / javadoc / latest-3.2.x / org / apache / cxf / rs / security / oauth2 / utils / OAuthContextUtils.html
blob: 3eea39690d397ab391754e66bcaf2136c2784c2c [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OAuthContextUtils (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="OAuthContextUtils (Apache CXF JavaDoc 3.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/OAuthContextUtils.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/utils/OAuthConstants.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthUtils.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html" target="_top">Frames</a></li>
<li><a href="OAuthContextUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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.utils</div>
<h2 title="Class OAuthContextUtils" class="title">Class OAuthContextUtils</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.rs.security.oauth2.utils.OAuthContextUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">OAuthContextUtils</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></pre>
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#assertClient-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">assertClient</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;client)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#assertRole-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">assertRole</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;role)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthContext.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#getContext-org.apache.cxf.jaxrs.ext.MessageContext-">getContext</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#isUserInRole-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">isUserInRole</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;role)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <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/rs/security/oauth2/utils/OAuthContextUtils.html#resolveClient-org.apache.cxf.jaxrs.ext.MessageContext-">resolveClient</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthPermission.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthPermission</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolvePermissions-org.apache.cxf.jaxrs.ext.MessageContext-">resolvePermissions</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <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/rs/security/oauth2/utils/OAuthContextUtils.html#resolveTokenKey-org.apache.cxf.jaxrs.ext.MessageContext-">resolveTokenKey</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <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/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserId-org.apache.cxf.jaxrs.ext.MessageContext-">resolveUserId</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <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/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserName-org.apache.cxf.jaxrs.ext.MessageContext-">resolveUserName</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserRoles-org.apache.cxf.jaxrs.ext.MessageContext-">resolveUserRoles</a></span>(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="resolveUserId-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveUserId</h4>
<pre>public static&nbsp;<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>&nbsp;resolveUserId(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of the UserSubject of the logged in user or resource owner</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="resolveUserName-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveUserName</h4>
<pre>public static&nbsp;<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>&nbsp;resolveUserName(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the UserSubject of the logged in user or resource owner</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="resolveUserRoles-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveUserRoles</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;resolveUserRoles(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of roles of the logged in user or resource owner</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="isUserInRole-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUserInRole</h4>
<pre>public static&nbsp;boolean&nbsp;isUserInRole(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;role)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dd><code>role</code> - the user role to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if user has given role; false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="assertRole-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertRole</h4>
<pre>public static&nbsp;void&nbsp;assertRole(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;role)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dd><code>role</code> - the role to check</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
<dd><code>WebApplicationException</code> - with Status 403 if user doesn't have needed role</dd>
</dl>
</li>
</ul>
<a name="resolvePermissions-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolvePermissions</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthPermission.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthPermission</a>&gt;&nbsp;resolvePermissions(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of permissions of the used access token</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="resolveTokenKey-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveTokenKey</h4>
<pre>public static&nbsp;<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>&nbsp;resolveTokenKey(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the token key used to access</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="resolveClient-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveClient</h4>
<pre>public static&nbsp;<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>&nbsp;resolveClient(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the client registration id</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</dd>
</dl>
</li>
</ul>
<a name="assertClient-org.apache.cxf.jaxrs.ext.MessageContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertClient</h4>
<pre>public static&nbsp;void&nbsp;assertClient(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc,
<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>&nbsp;client)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dd><code>client</code> - the desired client registration id</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 403 if the current client id is not valid</dd>
</dl>
</li>
</ul>
<a name="getContext-org.apache.cxf.jaxrs.ext.MessageContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContext</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthContext.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthContext</a>&nbsp;getContext(<a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</a>&nbsp;mc)</pre>
<dl>
<dt><span class="paramLabel">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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthContext.html" title="class in org.apache.cxf.rs.security.oauth2.common"><code>OAuthContext</code></a> of the given <a href="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext"><code>MessageContext</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>WebApplicationException</code> - with Status 401 if not authenticated</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/OAuthContextUtils.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/utils/OAuthConstants.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthUtils.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html" target="_top">Frames</a></li>
<li><a href="OAuthContextUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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>