You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/03/17 02:14:46 UTC
[23/51] [partial] incubator-juneau-website git commit: New files.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/rest/RestCallHandler.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/rest/RestCallHandler.html b/content/site/apidocs/org/apache/juneau/rest/RestCallHandler.html
new file mode 100644
index 0000000..454c133
--- /dev/null
+++ b/content/site/apidocs/org/apache/juneau/rest/RestCallHandler.html
@@ -0,0 +1,612 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>RestCallHandler (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title>
+<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
+<script type="text/javascript" src="../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="RestCallHandler (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<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="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>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/juneau/rest/RestCallHandler.html" target="_top">Frames</a></li>
+<li><a href="RestCallHandler.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.juneau.rest</div>
+<h2 title="Class RestCallHandler" class="title">Class RestCallHandler</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.juneau.rest.RestCallHandler</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.40">RestCallHandler</a>
+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></pre>
+<div class="block">Class that handles the basic lifecycle of an HTTP REST call.
+ <p>
+ Subclasses can override these methods to tailor how HTTP REST calls are handled.
+ Subclasses MUST implement a public constructor that takes in a <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> object.
+ <p>
+ RestCallHandlers are associated with servlets/resources in one of the following ways:
+ <ul>
+ <li>The <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#callHandler--"><code>@RestResource.callHandler()</code></a> annotation.
+ <li>The <a href="../../../../org/apache/juneau/rest/RestConfig.html#setCallHandler-java.lang.Class-"><code>RestConfig.setCallHandler(Class)</code></a> method.
+ </ul></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#RestCallHandler-org.apache.juneau.rest.RestContext-">RestCallHandler</a></span>(<a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> context)</code>
+<div class="block">Constructor.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#createRequest-javax.servlet.http.HttpServletRequest-">createRequest</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req)</code>
+<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> object.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#createResponse-org.apache.juneau.rest.RestRequest-javax.servlet.http.HttpServletResponse-">createResponse</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res)</code>
+<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletResponse</code></a> object
+ and the request returned by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#createRequest-javax.servlet.http.HttpServletRequest-"><code>createRequest(HttpServletRequest)</code></a>.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-">getSessionObjects</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code>
+<div class="block">Returns the session objects for the specified request.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#handleError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">handleError</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res,
+ <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code>
+<div class="block">Method for handling response errors.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#handleNotFound-int-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">handleNotFound</a></span>(int rc,
+ <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)</code>
+<div class="block">Handle the case where a matching method was not found.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#handleResponse-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-java.lang.Object-">handleResponse</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res,
+ <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> output)</code>
+<div class="block">The main method for serializing POJOs passed in through the <a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>RestResponse.setOutput(Object)</code></a> method or returned by
+ the Java method.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#onPostCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPostCall</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)</code>
+<div class="block">Callback method that gets invoked right after the REST Java method is invoked, but before
+ the serializer is invoked.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#onPreCall-org.apache.juneau.rest.RestRequest-">onPreCall</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code>
+<div class="block">Callback method that gets invoked right before the REST Java method is invoked.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#onSuccess-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-long-">onSuccess</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res,
+ long time)</code>
+<div class="block">Callback method for listening for successful completion of requests.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#renderError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">renderError</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res,
+ <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code>
+<div class="block">Method for rendering response errors.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestCallHandler.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">service</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> r1,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> r2)</code>
+<div class="block">The main service method.</div>
+</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-int-" 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="RestCallHandler-org.apache.juneau.rest.RestContext-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>RestCallHandler</h4>
+<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.51">RestCallHandler</a>(<a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> context)</pre>
+<div class="block">Constructor.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>context</code> - The resource context.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="createRequest-javax.servlet.http.HttpServletRequest-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createRequest</h4>
+<pre>protected <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.67">createRequest</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req)
+ throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a></pre>
+<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> object.
+ <p>
+ Subclasses may choose to override this method to provide a specialized request object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The request object from the <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"><code>service(HttpServletRequest, HttpServletResponse)</code></a> method.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The wrapped request object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a></code> - If any errors occur trying to interpret the request.</dd>
+</dl>
+</li>
+</ul>
+<a name="createResponse-org.apache.juneau.rest.RestRequest-javax.servlet.http.HttpServletResponse-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createResponse</h4>
+<pre>protected <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.82">createResponse</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res)
+ throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a></pre>
+<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletResponse</code></a> object
+ and the request returned by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#createRequest-javax.servlet.http.HttpServletRequest-"><code>createRequest(HttpServletRequest)</code></a>.
+ <p>
+ Subclasses may choose to override this method to provide a specialized response object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The request object returned by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#createRequest-javax.servlet.http.HttpServletRequest-"><code>createRequest(HttpServletRequest)</code></a>.</dd>
+<dd><code>res</code> - The response object from the <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"><code>service(HttpServletRequest, HttpServletResponse)</code></a> method.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The wrapped response object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a></code> - If any errors occur trying to interpret the request or response.</dd>
+</dl>
+</li>
+</ul>
+<a name="service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>service</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.96">service</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> r1,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> r2)
+ throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a>,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">The main service method.
+ <p>
+ Subclasses can optionally override this method if they want to tailor the behavior of requests.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>r1</code> - The incoming HTTP servlet request object.</dd>
+<dd><code>r2</code> - The incoming HTTP servlet response object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true" title="class or interface in javax.servlet">ServletException</a></code></dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="handleResponse-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>handleResponse</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.202">handleResponse</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res,
+ <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> output)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
+ <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></pre>
+<div class="block">The main method for serializing POJOs passed in through the <a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>RestResponse.setOutput(Object)</code></a> method or returned by
+ the Java method.
+ <p>
+ Subclasses may override this method if they wish to modify the way the output is rendered or support
+ other output formats.
+ <p>
+ The default implementation simply iterates through the response handlers on this resource
+ looking for the first one whose <a href="../../../../org/apache/juneau/rest/ResponseHandler.html#handle-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-java.lang.Object-"><code>ResponseHandler.handle(RestRequest, RestResponse, Object)</code></a> method returns <jk>true</jk>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The HTTP request.</dd>
+<dd><code>res</code> - The HTTP response.</dd>
+<dd><code>output</code> - The output to serialize in the response.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
+<dd><code><a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="handleNotFound-int-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>handleNotFound</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.221">handleNotFound</a>(int rc,
+ <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Handle the case where a matching method was not found.
+ <p>
+ Subclasses can override this method to provide a 2nd-chance for specifying a response.
+ The default implementation will simply throw an exception with an appropriate message.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>rc</code> - The HTTP response code.</dd>
+<dd><code>req</code> - The HTTP request.</dd>
+<dd><code>res</code> - The HTTP response.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="handleError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>handleError</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.247">handleError</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res,
+ <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Method for handling response errors.
+ <p>
+ The default implementation logs the error and calls <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#renderError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-"><code>renderError(HttpServletRequest,HttpServletResponse,RestException)</code></a>.
+ <p>
+ Subclasses can override this method to provide their own custom error response handling.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The servlet request.</dd>
+<dd><code>res</code> - The servlet response.</dd>
+<dd><code>e</code> - The exception that occurred.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Can be thrown if a problem occurred trying to write to the output stream.</dd>
+</dl>
+</li>
+</ul>
+<a name="renderError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>renderError</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.266">renderError</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a> req,
+ <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</a> res,
+ <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Method for rendering response errors.
+ <p>
+ The default implementation renders a plain text English message, optionally with a stack trace
+ if <a href="../../../../org/apache/juneau/rest/RestContext.html#REST_renderResponseStackTraces"><code>RestContext.REST_renderResponseStackTraces</code></a> is enabled.
+ <p>
+ Subclasses can override this method to provide their own custom error response handling.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The servlet request.</dd>
+<dd><code>res</code> - The servlet response.</dd>
+<dd><code>e</code> - The exception that occurred.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Can be thrown if a problem occurred trying to write to the output stream.</dd>
+</dl>
+</li>
+</ul>
+<a name="onSuccess-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>onSuccess</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.300">onSuccess</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res,
+ long time)</pre>
+<div class="block">Callback method for listening for successful completion of requests.
+ <p>
+ Subclasses can override this method for gathering performance statistics.
+ <p>
+ The default implementation does nothing.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The HTTP request.</dd>
+<dd><code>res</code> - The HTTP response.</dd>
+<dd><code>time</code> - The time in milliseconds it took to process the request.</dd>
+</dl>
+</li>
+</ul>
+<a name="onPreCall-org.apache.juneau.rest.RestRequest-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>onPreCall</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.314">onPreCall</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)
+ throws <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></pre>
+<div class="block">Callback method that gets invoked right before the REST Java method is invoked.
+ <p>
+ Subclasses can override this method to override request headers or set request-duration properties
+ before the Java method is invoked.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The HTTP servlet request object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></code> - If any error occurs.</dd>
+</dl>
+</li>
+</ul>
+<a name="onPostCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>onPostCall</h4>
+<pre>protected void <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.330">onPostCall</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req,
+ <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)
+ throws <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></pre>
+<div class="block">Callback method that gets invoked right after the REST Java method is invoked, but before
+ the serializer is invoked.
+ <p>
+ Subclasses can override this method to override request and response headers, or
+ set/override properties used by the serializer.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The HTTP servlet request object.</dd>
+<dd><code>res</code> - The HTTP servlet response object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a></code> - If any error occurs.</dd>
+</dl>
+</li>
+</ul>
+<a name="getSessionObjects-org.apache.juneau.rest.RestRequest-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getSessionObjects</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestCallHandler.html#line.343">getSessionObjects</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre>
+<div class="block">Returns the session objects for the specified request.
+ <p>
+ The default implementation simply returns a single map containing <code>{'req':req}</code>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The REST request.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The session objects for that request.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<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="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>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/juneau/rest/RestCallHandler.html" target="_top">Frames</a></li>
+<li><a href="RestCallHandler.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>Copyright © 2017 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p>
+</body>
+</html>