Google Git
Sign in
apache / cxf-site / refs/heads/asf-staging / . / content / javadoc / latest-3.0.x / org / apache / cxf / rs / security / oauth2 / utils / OAuthContextUtils.html
blob: 41dbfd468de7516141a899a57dba69dde2cdc630 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
OAuthContextUtils (Apache CXF JavaDoc 3.0.0 API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OAuthContextUtils (Apache CXF JavaDoc 3.0.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OAuthContextUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Apache CXF API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthConstants.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthUtils.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="OAuthContextUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.cxf.rs.security.oauth2.utils</FONT>
<BR>
Class OAuthContextUtils</H2>
<PRE>
<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cxf.rs.security.oauth2.utils.OAuthContextUtils</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>OAuthContextUtils</B><DT>extends <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#assertClient(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)">assertClient</A></B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;client)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#assertRole(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)">assertRole</A></B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;role)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#getContext(org.apache.cxf.jaxrs.ext.MessageContext)">getContext</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#isUserInRole(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)">isUserInRole</A></B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;role)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveClient(org.apache.cxf.jaxrs.ext.MessageContext)">resolveClient</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/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></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolvePermissions(org.apache.cxf.jaxrs.ext.MessageContext)">resolvePermissions</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveTokenKey(org.apache.cxf.jaxrs.ext.MessageContext)">resolveTokenKey</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserId(org.apache.cxf.jaxrs.ext.MessageContext)">resolveUserId</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserName(org.apache.cxf.jaxrs.ext.MessageContext)">resolveUserName</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html#resolveUserRoles(org.apache.cxf.jaxrs.ext.MessageContext)">resolveUserRoles</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="resolveUserId(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolveUserId</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>resolveUserId</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the id of the UserSubject of the logged in user or resource owner
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="resolveUserName(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolveUserName</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>resolveUserName</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the name of the UserSubject of the logged in user or resource owner
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="resolveUserRoles(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolveUserRoles</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>resolveUserRoles</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the list of roles of the logged in user or resource owner
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="isUserInRole(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)"><!-- --></A><H3>
isUserInRole</H3>
<PRE>
public static boolean <B>isUserInRole</B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;role)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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><CODE>role</CODE> - the user role to check
<DT><B>Returns:</B><DD>true if user has given role; false otherwise
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="assertRole(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)"><!-- --></A><H3>
assertRole</H3>
<PRE>
public static void <B>assertRole</B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;role)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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><CODE>role</CODE> - the role to check
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated
<DD><CODE>WebApplicationException</CODE> - with Status 403 if user doesn't have needed role</DL>
</DD>
</DL>
<HR>
<A NAME="resolvePermissions(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolvePermissions</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/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; <B>resolvePermissions</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the list of permissions of the used access token
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="resolveTokenKey(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolveTokenKey</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>resolveTokenKey</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the token key used to access
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="resolveClient(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
resolveClient</H3>
<PRE>
public static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>resolveClient</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><DD>the client registration id
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<HR>
<A NAME="assertClient(org.apache.cxf.jaxrs.ext.MessageContext, java.lang.String)"><!-- --></A><H3>
assertClient</H3>
<PRE>
public static void <B>assertClient</B>(<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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;client)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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><CODE>client</CODE> - the desired client registration id
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 403 if the current client id is not valid</DL>
</DD>
</DL>
<HR>
<A NAME="getContext(org.apache.cxf.jaxrs.ext.MessageContext)"><!-- --></A><H3>
getContext</H3>
<PRE>
public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/OAuthContext.html" title="class in org.apache.cxf.rs.security.oauth2.common">OAuthContext</A> <B>getContext</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/ext/MessageContext.html" title="interface in org.apache.cxf.jaxrs.ext">MessageContext</A>&nbsp;mc)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><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>
<DT><B>Returns:</B><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>
<DT><B>Throws:</B>
<DD><CODE>WebApplicationException</CODE> - with Status 401 if not authenticated</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OAuthContextUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Apache CXF API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthConstants.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/utils/OAuthUtils.html" title="class in org.apache.cxf.rs.security.oauth2.utils"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/utils/OAuthContextUtils.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="OAuthContextUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Apache CXF
</BODY>
</HTML>