blob: fc4db89e8fc34b91aa5a4e4042cda8e19b638f02 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>AuthorizationRequestService (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="AuthorizationRequestService (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/AuthorizationRequestService.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/oauth/services/AuthorizationRequestHandler.html" title="class in org.apache.cxf.rs.security.oauth.services"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/OAuthDefaultServices.html" title="class in org.apache.cxf.rs.security.oauth.services"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html" target="_top">Frames</a></li>
<li><a href="AuthorizationRequestService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cxf.rs.security.oauth.services</div>
<h2 title="Class AuthorizationRequestService" class="title">Class AuthorizationRequestService</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><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html" title="class in org.apache.cxf.rs.security.oauth.services">org.apache.cxf.rs.security.oauth.services.AbstractOAuthService</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cxf.rs.security.oauth.services.AuthorizationRequestService</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Path(value="/authorize")
public class <span class="strong">AuthorizationRequestService</span>
extends <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html" title="class in org.apache.cxf.rs.security.oauth.services">AbstractOAuthService</a></pre>
<div class="block">This resource handles the End User authorising
or denying the Client to access its resources.
If End User approves the access this resource will
redirect End User back to the Client, supplying
a request token verifier (aka authorization code)</div>
</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">&nbsp;</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/oauth/services/AuthorizationRequestService.html#AuthorizationRequestService()">AuthorizationRequestService</a></strong>()</code>&nbsp;</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">&nbsp;</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>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html#authorize()">authorize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html#authorizeDecision()">authorizeDecision</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html#authorizeDecisionForm()">authorizeDecisionForm</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html#setAuthorizationRequestHandler(org.apache.cxf.rs.security.oauth.services.AuthorizationRequestHandler)">setAuthorizationRequestHandler</a></strong>(<a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestHandler.html" title="class in org.apache.cxf.rs.security.oauth.services">AuthorizationRequestHandler</a>&nbsp;h)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.rs.security.oauth.services.AbstractOAuthService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cxf.rs.security.oauth.services.<a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html" title="class in org.apache.cxf.rs.security.oauth.services">AbstractOAuthService</a></h3>
<code><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#getDataProvider()">getDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#getMessageContext()">getMessageContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#getValidator()">getValidator</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#setDataProvider(org.apache.cxf.rs.security.oauth.provider.OAuthDataProvider)">setDataProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#setMessageContext(org.apache.cxf.jaxrs.ext.MessageContext)">setMessageContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AbstractOAuthService.html#setValidator(net.oauth.OAuthValidator)">setValidator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/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="AuthorizationRequestService()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AuthorizationRequestService</h4>
<pre>public&nbsp;AuthorizationRequestService()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setAuthorizationRequestHandler(org.apache.cxf.rs.security.oauth.services.AuthorizationRequestHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthorizationRequestHandler</h4>
<pre>public&nbsp;void&nbsp;setAuthorizationRequestHandler(<a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/AuthorizationRequestHandler.html" title="class in org.apache.cxf.rs.security.oauth.services">AuthorizationRequestHandler</a>&nbsp;h)</pre>
</li>
</ul>
<a name="authorize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authorize</h4>
<pre>@GET
@Produces(value={"application/xhtml+xml","text/html","application/xml","application/json"})
public&nbsp;javax.ws.rs.core.Response&nbsp;authorize()</pre>
</li>
</ul>
<a name="authorizeDecision()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authorizeDecision</h4>
<pre>@GET
@Path(value="/decision")
@Produces(value={"application/xhtml+xml","text/html","application/xml;qs=0.9","application/json;qs=0.9","application/x-www-form-urlencoded"})
public&nbsp;javax.ws.rs.core.Response&nbsp;authorizeDecision()</pre>
</li>
</ul>
<a name="authorizeDecisionForm()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>authorizeDecisionForm</h4>
<pre>@POST
@Path(value="/decision")
@Consumes(value="application/x-www-form-urlencoded")
@Produces(value={"application/xhtml+xml","text/html","application/xml;qs=0.9","application/json;qs=0.9","application/x-www-form-urlencoded"})
public&nbsp;javax.ws.rs.core.Response&nbsp;authorizeDecisionForm()</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/AuthorizationRequestService.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/oauth/services/AuthorizationRequestHandler.html" title="class in org.apache.cxf.rs.security.oauth.services"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/oauth/services/OAuthDefaultServices.html" title="class in org.apache.cxf.rs.security.oauth.services"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/oauth/services/AuthorizationRequestService.html" target="_top">Frames</a></li>
<li><a href="AuthorizationRequestService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Apache CXF</small></p>
</body>
</html>