| <!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> |
| OAuthClientUtils (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="OAuthClientUtils (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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OAuthClientUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/HttpRequestProperties.html" title="class in org.apache.cxf.rs.security.oauth2.client"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><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/client/OAuthClientUtils.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OAuthClientUtils.html" target="_top"><B>NO FRAMES</B></A> |
| <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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.client</FONT> |
| <BR> |
| Class OAuthClientUtils</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.client.OAuthClientUtils</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <B>OAuthClientUtils</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> |
| The utility class for simplifying working with OAuth servers |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A></B></CODE> |
| |
| <BR> |
| Simple consumer representation</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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 <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/client/OAuthClientUtils.html#createAuthorizationHeader(org.apache.cxf.rs.security.oauth2.common.ClientAccessToken)">createAuthorizationHeader</A></B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> accessToken)</CODE> |
| |
| <BR> |
| Creates OAuth Authorization header with Bearer scheme</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>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></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#createAuthorizationHeader(org.apache.cxf.rs.security.oauth2.common.ClientAccessToken, org.apache.cxf.rs.security.oauth2.client.HttpRequestProperties)">createAuthorizationHeader</A></B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> accessToken, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/HttpRequestProperties.html" title="class in org.apache.cxf.rs.security.oauth2.client">HttpRequestProperties</A> httpProps)</CODE> |
| |
| <BR> |
| Creates OAuth Authorization header with the scheme that |
| may require an access to the current HTTP request properties</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#fromMapToClientToken(java.util.Map)">fromMapToClientToken</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> map)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#fromMapToClientToken(java.util.Map, java.lang.String)">fromMapToClientToken</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> map, |
| <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> defaultTokenType)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(java.lang.String, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, boolean)">getAccessToken</A></B>(<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> accessTokenServiceUri, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| boolean setAuthorizationHeader)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, boolean)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| boolean setAuthorizationHeader)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map, boolean)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams, |
| boolean setAuthorizationHeader)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map, java.lang.String, boolean)">getAccessToken</A></B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams, |
| <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> defaultTokenType, |
| boolean setAuthorizationHeader)</CODE> |
| |
| <BR> |
| Obtains the access token from OAuth AccessToken Service |
| using the initialized web client</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAuthorizationURI(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getAuthorizationURI</A></B>(<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> authorizationServiceURI, |
| <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> clientId, |
| <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> redirectUri, |
| <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> state, |
| <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> scope)</CODE> |
| |
| <BR> |
| Builds a complete URI for redirecting to OAuth Authorization Service</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.ws.rs.core.UriBuilder</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.html#getAuthorizationURIBuilder(java.lang.String, java.lang.String, java.lang.String)">getAuthorizationURIBuilder</A></B>(<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> authorizationServiceURI, |
| <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> clientId, |
| <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> scope)</CODE> |
| |
| <BR> |
| Creates the builder for building OAuth AuthorizationService URIs</TD> |
| </TR> |
| </TABLE> |
| <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> |
| |
| <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="getAuthorizationURI(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getAuthorizationURI</H3> |
| <PRE> |
| public static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> <B>getAuthorizationURI</B>(<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> authorizationServiceURI, |
| <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> clientId, |
| <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> redirectUri, |
| <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> state, |
| <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> scope)</PRE> |
| <DL> |
| <DD>Builds a complete URI for redirecting to OAuth Authorization Service |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authorizationServiceURI</CODE> - the service endpoint address<DD><CODE>clientId</CODE> - client registration id<DD><CODE>redirectUri</CODE> - the uri the authorization code will be posted to<DD><CODE>state</CODE> - the client state, example the key or the encrypted token |
| representing the info about the current end user's request |
| <DT><B>Returns:</B><DD>authorization service URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthorizationURIBuilder(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getAuthorizationURIBuilder</H3> |
| <PRE> |
| public static javax.ws.rs.core.UriBuilder <B>getAuthorizationURIBuilder</B>(<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> authorizationServiceURI, |
| <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> clientId, |
| <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> scope)</PRE> |
| <DL> |
| <DD>Creates the builder for building OAuth AuthorizationService URIs |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authorizationServiceURI</CODE> - the service endpoint address<DD><CODE>clientId</CODE> - client registration id<DD><CODE>scope</CODE> - the optional scope; if not specified then the authorization |
| service will allocate the default scope |
| <DT><B>Returns:</B><DD>the builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant) |
| 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>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>consumer</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><CODE>OAuthClientUtils.Consumer</CODE></A> representing the registered client<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(java.lang.String, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, boolean)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<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> accessTokenServiceUri, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| boolean setAuthorizationHeader) |
| 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>Obtains the access token from OAuth AccessToken Service |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenServiceUri</CODE> - the AccessToken endpoint address<DD><CODE>consumer</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><CODE>OAuthClientUtils.Consumer</CODE></A> representing the registered client<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>setAuthorizationHeader</CODE> - if set to true then HTTP Basic scheme |
| will be used to pass client id and secret, otherwise they will |
| be passed in the form payload |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, boolean)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| boolean setAuthorizationHeader)</PRE> |
| <DL> |
| <DD>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>consumer</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><CODE>OAuthClientUtils.Consumer</CODE></A> representing the registered client.<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>setAuthorizationHeader</CODE> - if set to true then HTTP Basic scheme |
| will be used to pass client id and secret, otherwise they will |
| be passed in the form payload |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant) |
| 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>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>extraParams</CODE> - extra parameters |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams) |
| 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>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>extraParams</CODE> - extra parameters |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map, boolean)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams, |
| boolean setAuthorizationHeader) |
| 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>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>consumer</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><CODE>OAuthClientUtils.Consumer</CODE></A> representing the registered client.<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>extraParams</CODE> - extra parameters<DD><CODE>setAuthorizationHeader</CODE> - if set to true then HTTP Basic scheme |
| will be used to pass client id and secret, otherwise they will |
| be passed in the form payload |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessToken(org.apache.cxf.jaxrs.client.WebClient, org.apache.cxf.rs.security.oauth2.client.OAuthClientUtils.Consumer, org.apache.cxf.rs.security.oauth2.common.AccessTokenGrant, java.util.Map, java.lang.String, boolean)"><!-- --></A><H3> |
| getAccessToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>getAccessToken</B>(<A HREF="../../../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</A> accessTokenService, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">OAuthClientUtils.Consumer</A> consumer, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common">AccessTokenGrant</A> grant, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> extraParams, |
| <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> defaultTokenType, |
| boolean setAuthorizationHeader) |
| 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>Obtains the access token from OAuth AccessToken Service |
| using the initialized web client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessTokenService</CODE> - the AccessToken client<DD><CODE>consumer</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><CODE>OAuthClientUtils.Consumer</CODE></A> representing the registered client.<DD><CODE>grant</CODE> - <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenGrant.html" title="interface in org.apache.cxf.rs.security.oauth2.common"><CODE>AccessTokenGrant</CODE></A> grant<DD><CODE>extraParams</CODE> - extra parameters<DD><CODE>defaultTokenType</CODE> - default expected token type - some early |
| well-known OAuth2 services do not return a required token_type parameter<DD><CODE>setAuthorizationHeader</CODE> - if set to true then HTTP Basic scheme |
| will be used to pass client id and secret, otherwise they will |
| be passed in the form payload |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>ClientAccessToken</CODE></A> access token |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fromMapToClientToken(java.util.Map)"><!-- --></A><H3> |
| fromMapToClientToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>fromMapToClientToken</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> map)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fromMapToClientToken(java.util.Map, java.lang.String)"><!-- --></A><H3> |
| fromMapToClientToken</H3> |
| <PRE> |
| public static <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> <B>fromMapToClientToken</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<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>> map, |
| <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> defaultTokenType)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createAuthorizationHeader(org.apache.cxf.rs.security.oauth2.common.ClientAccessToken)"><!-- --></A><H3> |
| createAuthorizationHeader</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>createAuthorizationHeader</B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> accessToken) |
| 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 OAuth Authorization header with Bearer scheme |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessToken</CODE> - the access token |
| <DT><B>Returns:</B><DD>the header value |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createAuthorizationHeader(org.apache.cxf.rs.security.oauth2.common.ClientAccessToken, org.apache.cxf.rs.security.oauth2.client.HttpRequestProperties)"><!-- --></A><H3> |
| createAuthorizationHeader</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>createAuthorizationHeader</B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common">ClientAccessToken</A> accessToken, |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/HttpRequestProperties.html" title="class in org.apache.cxf.rs.security.oauth2.client">HttpRequestProperties</A> httpProps) |
| 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 OAuth Authorization header with the scheme that |
| may require an access to the current HTTP request properties |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>accessToken</CODE> - the access token<DD><CODE>httpProps</CODE> - http request properties, can be null for Bearer tokens |
| <DT><B>Returns:</B><DD>the header value |
| <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></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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OAuthClientUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/HttpRequestProperties.html" title="class in org.apache.cxf.rs.security.oauth2.client"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/client/OAuthClientUtils.Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><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/client/OAuthClientUtils.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OAuthClientUtils.html" target="_top"><B>NO FRAMES</B></A> |
| <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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |