Google Git
Sign in
apache / cxf-site / refs/heads/asf-staging / . / content / javadoc / latest-2.6.x / org / apache / cxf / rs / security / oauth2 / grants / code / AuthorizationCodeDataProvider.html
blob: d6370fe7bccc386a60e7a3a7ca72e53e78fb1135 [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>
AuthorizationCodeDataProvider (Apache CXF Bundle Jar 2.6.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeDataProvider interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AuthorizationCodeDataProvider (Apache CXF Bundle Jar 2.6.3 API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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/AuthorizationCodeDataProvider.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><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/grants/code/AuthorizationCodeDataProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AuthorizationCodeDataProvider.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.grants.code</FONT>
<BR>
Interface AuthorizationCodeDataProvider</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider">OAuthDataProvider</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>AuthorizationCodeDataProvider</B><DT>extends <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider">OAuthDataProvider</A></DL>
</PRE>
<P>
AuthorizationCodeDataProvider is the <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider"><CODE>OAuthDataProvider</CODE></A> which
can additionally persist the authorization code grant information
<P>
<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>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.html#createCodeGrant(org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeRegistration)">createCodeGrant</A></B>(<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">AuthorizationCodeRegistration</A>&nbsp;reg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a temporarily code grant which will capture the
information about the <CODE>Client</CODE> requesting the access to
the resource owner's resources</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.html#removeCodeGrant(java.lang.String)">removeCodeGrant</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;code)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the previously registered <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/ServerAuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><CODE>ServerAuthorizationCodeGrant</CODE></A></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.cxf.rs.security.oauth2.provider.<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html" title="interface in org.apache.cxf.rs.security.oauth2.provider">OAuthDataProvider</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><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>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#createAccessToken(org.apache.cxf.rs.security.oauth2.common.AccessTokenRegistration)">createAccessToken</A>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getAccessToken(java.lang.String)">getAccessToken</A>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getClient(java.lang.String)">getClient</A>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#getPreauthorizedToken(org.apache.cxf.rs.security.oauth2.common.Client, org.apache.cxf.rs.security.oauth2.common.UserSubject, java.lang.String)">getPreauthorizedToken</A>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#refreshAccessToken(java.lang.String, java.lang.String)">refreshAccessToken</A>, <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.html#removeAccessToken(org.apache.cxf.rs.security.oauth2.common.ServerAccessToken)">removeAccessToken</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="createCodeGrant(org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeRegistration)"><!-- --></A><H3>
createCodeGrant</H3>
<PRE>
<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> <B>createCodeGrant</B>(<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code">AuthorizationCodeRegistration</A>&nbsp;reg)
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>
<DL>
<DD>Creates a temporarily code grant which will capture the
information about the <CODE>Client</CODE> requesting the access to
the resource owner's resources
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reg</CODE> - information about the client code grant request
<DT><B>Returns:</B><DD>new code grant
<DT><B>Throws:</B>
<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><DT><B>See Also:</B><DD><A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeRegistration.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><CODE>AuthorizationCodeRegistration</CODE></A>,
<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/ServerAuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><CODE>ServerAuthorizationCodeGrant</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="removeCodeGrant(java.lang.String)"><!-- --></A><H3>
removeCodeGrant</H3>
<PRE>
<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> <B>removeCodeGrant</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;code)
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>
<DL>
<DD>Returns the previously registered <A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/ServerAuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><CODE>ServerAuthorizationCodeGrant</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>code</CODE> - the code grant
<DT><B>Returns:</B><DD>the grant
<DT><B>Throws:</B>
<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> - if no grant with this code is available<DT><B>See Also:</B><DD><A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/ServerAuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><CODE>ServerAuthorizationCodeGrant</CODE></A></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/AuthorizationCodeDataProvider.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../../../org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeGrant.html" title="class in org.apache.cxf.rs.security.oauth2.grants.code"><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/grants/code/AuthorizationCodeDataProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AuthorizationCodeDataProvider.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>