| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>CodeAuthSupplier (Apache CXF JavaDoc 3.1.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CodeAuthSupplier (Apache CXF JavaDoc 3.1.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CodeAuthSupplier.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/ClientTokenContextProvider.html" title="class in org.apache.cxf.rs.security.oauth2.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html" target="_top">Frames</a></li> |
| <li><a href="CodeAuthSupplier.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cxf.rs.security.oauth2.client</div> |
| <h2 title="Class CodeAuthSupplier" class="title">Class CodeAuthSupplier</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.rs.security.oauth2.client.CodeAuthSupplier</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html" title="interface in org.apache.cxf.transport.http.auth">HttpAuthSupplier</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">CodeAuthSupplier</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html" title="interface in org.apache.cxf.transport.http.auth">HttpAuthSupplier</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#CodeAuthSupplier()">CodeAuthSupplier</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#getAuthorization(org.apache.cxf.configuration.security.AuthorizationPolicy,%20java.net.URI,%20org.apache.cxf.message.Message,%20java.lang.String)">getAuthorization</a></strong>(<a href="../../../../../../../org/apache/cxf/configuration/security/AuthorizationPolicy.html" title="class in org.apache.cxf.configuration.security">AuthorizationPolicy</a> authPolicy, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> currentURI, |
| <a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fullHeader)</code> |
| <div class="block">The HTTPConduit makes a call to this method to obtain |
| an Authentication token for http authentication.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#requiresRequestCaching()">requiresRequestCaching</a></strong>()</code> |
| <div class="block">If the supplier requires the request to be cached to be resent, return true</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#setAccessTokenServiceUri(java.lang.String)">setAccessTokenServiceUri</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#setCode(java.lang.String)">setCode</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> code)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#setConsumer(org.apache.cxf.rs.security.oauth2.client.Consumer)">setConsumer</a></strong>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">Consumer</a> consumer)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html#setRefreshEarly(boolean)">setRefreshEarly</a></strong>(boolean refreshEarly)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CodeAuthSupplier()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CodeAuthSupplier</h4> |
| <pre>public CodeAuthSupplier()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="requiresRequestCaching()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresRequestCaching</h4> |
| <pre>public boolean requiresRequestCaching()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html#requiresRequestCaching()">HttpAuthSupplier</a></code></strong></div> |
| <div class="block">If the supplier requires the request to be cached to be resent, return true</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html#requiresRequestCaching()">requiresRequestCaching</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html" title="interface in org.apache.cxf.transport.http.auth">HttpAuthSupplier</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthorization(org.apache.cxf.configuration.security.AuthorizationPolicy, java.net.URI, org.apache.cxf.message.Message, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthorization</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAuthorization(<a href="../../../../../../../org/apache/cxf/configuration/security/AuthorizationPolicy.html" title="class in org.apache.cxf.configuration.security">AuthorizationPolicy</a> authPolicy, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> currentURI, |
| <a href="../../../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fullHeader)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html#getAuthorization(org.apache.cxf.configuration.security.AuthorizationPolicy,%20java.net.URI,%20org.apache.cxf.message.Message,%20java.lang.String)">HttpAuthSupplier</a></code></strong></div> |
| <div class="block">The HTTPConduit makes a call to this method to obtain |
| an Authentication token for http authentication.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html#getAuthorization(org.apache.cxf.configuration.security.AuthorizationPolicy,%20java.net.URI,%20org.apache.cxf.message.Message,%20java.lang.String)">getAuthorization</a></code> in interface <code><a href="../../../../../../../org/apache/cxf/transport/http/auth/HttpAuthSupplier.html" title="interface in org.apache.cxf.transport.http.auth">HttpAuthSupplier</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>authPolicy</code> - credentials for the authentication</dd><dd><code>message</code> - The CXF Message</dd><dd><code>fullHeader</code> - The full WWW-Authenticate header or null if preemptive auth</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>token for Authenticate string or null if authentication is not possible</dd></dl> |
| </li> |
| </ul> |
| <a name="setCode(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCode</h4> |
| <pre>public void setCode(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> code)</pre> |
| </li> |
| </ul> |
| <a name="setRefreshEarly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRefreshEarly</h4> |
| <pre>public void setRefreshEarly(boolean refreshEarly)</pre> |
| </li> |
| </ul> |
| <a name="setAccessTokenServiceUri(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessTokenServiceUri</h4> |
| <pre>public void setAccessTokenServiceUri(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)</pre> |
| </li> |
| </ul> |
| <a name="setConsumer(org.apache.cxf.rs.security.oauth2.client.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setConsumer</h4> |
| <pre>public void setConsumer(<a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client">Consumer</a> consumer)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CodeAuthSupplier.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/ClientTokenContextProvider.html" title="class in org.apache.cxf.rs.security.oauth2.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/rs/security/oauth2/client/Consumer.html" title="class in org.apache.cxf.rs.security.oauth2.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/client/CodeAuthSupplier.html" target="_top">Frames</a></li> |
| <li><a href="CodeAuthSupplier.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Apache CXF</small></p> |
| </body> |
| </html> |
