http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/client/RestCallException.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/client/RestCallException.html b/content/api-documentation/org/apache/juneau/client/RestCallException.html new file mode 100644 index 0000000..52819a9 --- /dev/null +++ b/content/api-documentation/org/apache/juneau/client/RestCallException.html @@ -0,0 +1,500 @@ +<!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 --> +<title>RestCallException (Juneau)</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="RestCallException (Juneau)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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="class-use/RestCallException.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallException.html" target="_top">Frames</a></li> +<li><a href="RestCallException.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.client</div> +<h2 title="Class RestCallException" class="title">Class RestCallException</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">java.io.IOException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.client.RestCallException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.31">RestCallException</a> +extends <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">Exception representing a <code>400+</code> HTTP response code against a remote resource.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Bognar ([email protected])</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.juneau.client.RestCallException">Serialized Form</a></dd> +</dl> +</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/client/RestCallException.html#RestCallException-java.lang.Exception-">RestCallException</a></span>(<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> e)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#RestCallException-int-java.lang.String-java.lang.String-java.net.URI-java.lang.String-">RestCallException</a></span>(int responseCode, + <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> responseMsg, + <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> method, + <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> url, + <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> response)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#RestCallException-java.lang.String-">RestCallException</a></span>(<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> msg)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#RestCallException-java.lang.String-org.apache.http.HttpResponse-">RestCallException</a></span>(<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> msg, + org.apache.http.HttpResponse response)</code> +<div class="block">Create an exception with a simple message and the status code and body of the specified response.</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>org.apache.http.HttpResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#getHttpResponse--">getHttpResponse</a></span>()</code> +<div class="block">Returns the HTTP response object that caused this exception.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#getResponseCode--">getResponseCode</a></span>()</code> +<div class="block">Returns the HTTP response status code.</div> +</td> +</tr> +<tr id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#getResponseMessage--">getResponseMessage</a></span>()</code> +<div class="block">Returns the HTTP response message body text.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#getResponseStatusMessage--">getResponseStatusMessage</a></span>()</code> +<div class="block">Returns the response status message as a plain string.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#initCause-java.lang.Throwable-">initCause</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<div class="block">Sets the inner cause for this exception.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallException.html#setHttpResponse-org.apache.http.HttpResponse-">setHttpResponse</a></span>(org.apache.http.HttpResponse httpResponse)</code> +<div class="block">Sets the HTTP response object that caused this exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-"; title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7 /docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</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 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#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="RestCallException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RestCallException</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.46">RestCallException</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> msg)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - The exception message.</dd> +</dl> +</li> +</ul> +<a name="RestCallException-java.lang.Exception-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RestCallException</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.55">RestCallException</a>(<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> e)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>e</code> - The inner cause of the exception.</dd> +</dl> +</li> +</ul> +<a name="RestCallException-java.lang.String-org.apache.http.HttpResponse-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RestCallException</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.76">RestCallException</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> msg, + org.apache.http.HttpResponse response) + throws org.apache.http.ParseException, + <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">Create an exception with a simple message and the status code and body of the specified response.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - The exception message.</dd> +<dd><code>response</code> - The HTTP response object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.http.ParseException</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="RestCallException-int-java.lang.String-java.lang.String-java.net.URI-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RestCallException</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.89">RestCallException</a>(int responseCode, + <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> responseMsg, + <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> method, + <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> url, + <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> response)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>responseCode</code> - The response code.</dd> +<dd><code>responseMsg</code> - The response message.</dd> +<dd><code>method</code> - The HTTP method (for message purposes).</dd> +<dd><code>url</code> - The HTTP URL (for message purposes).</dd> +<dd><code>response</code> - The reponse from the server.</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="setHttpResponse-org.apache.http.HttpResponse-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHttpResponse</h4> +<pre>protected <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a> <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.102">setHttpResponse</a>(org.apache.http.HttpResponse httpResponse)</pre> +<div class="block">Sets the HTTP response object that caused this exception.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>httpResponse</code> - The HTTP respose object.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getHttpResponse--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHttpResponse</h4> +<pre>public org.apache.http.HttpResponse <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.112">getHttpResponse</a>()</pre> +<div class="block">Returns the HTTP response object that caused this exception.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The HTTP response object that caused this exception, or <jk>null</jk> if no response was created yet when the exception was thrown.</dd> +</dl> +</li> +</ul> +<a name="getResponseCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseCode</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.121">getResponseCode</a>()</pre> +<div class="block">Returns the HTTP response status code.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The response status code. If a connection could not be made at all, returns <code>0</code>.</dd> +</dl> +</li> +</ul> +<a name="getResponseMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseMessage</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> <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.130">getResponseMessage</a>()</pre> +<div class="block">Returns the HTTP response message body text.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The response message body text.</dd> +</dl> +</li> +</ul> +<a name="getResponseStatusMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResponseStatusMessage</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> <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.139">getResponseStatusMessage</a>()</pre> +<div class="block">Returns the response status message as a plain string.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The response status message.</dd> +</dl> +</li> +</ul> +<a name="initCause-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>initCause</h4> +<pre>public <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a> <a href="../../../../src-html/org/apache/juneau/client/RestCallException.html#line.149">initCause</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<div class="block">Sets the inner cause for this exception.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cause</code> - The inner cause.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</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="class-use/RestCallException.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallException.html" target="_top">Frames</a></li> +<li><a href="RestCallException.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 ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/client/RestCallInterceptor.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/client/RestCallInterceptor.html b/content/api-documentation/org/apache/juneau/client/RestCallInterceptor.html new file mode 100644 index 0000000..15223ae --- /dev/null +++ b/content/api-documentation/org/apache/juneau/client/RestCallInterceptor.html @@ -0,0 +1,369 @@ +<!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 --> +<title>RestCallInterceptor (Juneau)</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="RestCallInterceptor (Juneau)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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="class-use/RestCallInterceptor.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestCallLogger.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallInterceptor.html" target="_top">Frames</a></li> +<li><a href="RestCallInterceptor.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.client</div> +<h2 title="Class RestCallInterceptor" class="title">Class RestCallInterceptor</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.client.RestCallInterceptor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/juneau/client/RestCallLogger.html" title="class in org.apache.juneau.client">RestCallLogger</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.23">RestCallInterceptor</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">Used to intercept http connection responses to allow modification of that response before processing + and for listening for call lifecycle events. + <p> + Useful if you want to prevent <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallExceptions</code></a> from being thrown on error conditions.</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/client/RestCallInterceptor.html#RestCallInterceptor--">RestCallInterceptor</a></span>()</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="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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onClose-org.apache.juneau.client.RestCall-">onClose</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</code> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>RestCall.close()</code></a> is called.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-">onConnect</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res)</code> +<div class="block">Called immediately after an HTTP response has been received.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onInit-org.apache.juneau.client.RestCall-">onInit</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</code> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> object is created.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-">onRetry</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res, + <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> ex)</code> +<div class="block">Called if retry is going to be attempted.</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="RestCallInterceptor--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RestCallInterceptor</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.23">RestCallInterceptor</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onInit-org.apache.juneau.client.RestCall-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onInit</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.30">onInit</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</pre> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> object is created.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +</dl> +</li> +</ul> +<a name="onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onConnect</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.40">onConnect</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res)</pre> +<div class="block">Called immediately after an HTTP response has been received.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>statusCode</code> - The HTTP status code received.</dd> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dd><code>req</code> - The HTTP request object.</dd> +<dd><code>res</code> - The HTTP response object.</dd> +</dl> +</li> +</ul> +<a name="onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onRetry</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.51">onRetry</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res, + <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> ex)</pre> +<div class="block">Called if retry is going to be attempted.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>statusCode</code> - The HTTP status code received.</dd> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dd><code>req</code> - The HTTP request object.</dd> +<dd><code>res</code> - The HTTP response object.</dd> +<dd><code>ex</code> - The exception thrown from the client.</dd> +</dl> +</li> +</ul> +<a name="onClose-org.apache.juneau.client.RestCall-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onClose</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallInterceptor.html#line.59">onClose</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall) + throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>RestCall.close()</code></a> is called.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code></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="class-use/RestCallInterceptor.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestCallLogger.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallInterceptor.html" target="_top">Frames</a></li> +<li><a href="RestCallInterceptor.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/client/RestCallLogger.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/client/RestCallLogger.html b/content/api-documentation/org/apache/juneau/client/RestCallLogger.html new file mode 100644 index 0000000..dca2b57 --- /dev/null +++ b/content/api-documentation/org/apache/juneau/client/RestCallLogger.html @@ -0,0 +1,398 @@ +<!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 --> +<title>RestCallLogger (Juneau)</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="RestCallLogger (Juneau)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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="class-use/RestCallLogger.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallLogger.html" target="_top">Frames</a></li> +<li><a href="RestCallLogger.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.client</div> +<h2 title="Class RestCallLogger" class="title">Class RestCallLogger</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/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">org.apache.juneau.client.RestCallInterceptor</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.client.RestCallLogger</li> +</ul> +</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/client/RestCallLogger.html#line.33">RestCallLogger</a> +extends <a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a></pre> +<div class="block">Specialized interceptor for logging calls to a log file. + <p> + Causes a log entry to be created that shows all the request and response headers and content + at the end of the request. + <p> + Use the <a href="../../../../org/apache/juneau/client/RestClient.html#logTo-java.util.logging.Level-java.util.logging.Logger-"><code>RestClient.logTo(Level, Logger)</code></a> and <a href="../../../../org/apache/juneau/client/RestCall.html#logTo-java.util.logging.Level-java.util.logging.Logger-"><code>RestCall.logTo(Level, Logger)</code></a> + <p> + methods to create instances of this class.</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallLogger.html#RestCallLogger-java.util.logging.Level-java.util.logging.Logger-">RestCallLogger</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true"; title="class or interface in java.util.logging">Level</a> level, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true"; title="class or interface in java.util.logging">Logger</a> log)</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallLogger.html#onClose-org.apache.juneau.client.RestCall-">onClose</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</code> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>RestCall.close()</code></a> is called.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallLogger.html#onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-">onConnect</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res)</code> +<div class="block">Called immediately after an HTTP response has been received.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallLogger.html#onInit-org.apache.juneau.client.RestCall-">onInit</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</code> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> object is created.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCallLogger.html#onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-">onRetry</a></span>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res, + <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> ex)</code> +<div class="block">Called if retry is going to be attempted.</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="RestCallLogger-java.util.logging.Level-java.util.logging.Logger-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RestCallLogger</h4> +<pre>protected <a href="../../../../src-html/org/apache/juneau/client/RestCallLogger.html#line.44">RestCallLogger</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true"; title="class or interface in java.util.logging">Level</a> level, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true"; title="class or interface in java.util.logging">Logger</a> log)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>level</code> - The log level to log messages at.</dd> +<dd><code>log</code> - The logger to log to.</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="onInit-org.apache.juneau.client.RestCall-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onInit</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallLogger.html#line.50">onInit</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onInit-org.apache.juneau.client.RestCall-">RestCallInterceptor</a></code></span></div> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client"><code>RestCall</code></a> object is created.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onInit-org.apache.juneau.client.RestCall-">onInit</a></code> in class <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +</dl> +</li> +</ul> +<a name="onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onConnect</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallLogger.html#line.56">onConnect</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-">RestCallInterceptor</a></code></span></div> +<div class="block">Called immediately after an HTTP response has been received.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onConnect-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-">onConnect</a></code> in class <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dd><code>statusCode</code> - The HTTP status code received.</dd> +<dd><code>req</code> - The HTTP request object.</dd> +<dd><code>res</code> - The HTTP response object.</dd> +</dl> +</li> +</ul> +<a name="onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onRetry</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallLogger.html#line.61">onRetry</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall, + int statusCode, + org.apache.http.HttpRequest req, + org.apache.http.HttpResponse res, + <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> ex)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-">RestCallInterceptor</a></code></span></div> +<div class="block">Called if retry is going to be attempted.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onRetry-org.apache.juneau.client.RestCall-int-org.apache.http.HttpRequest-org.apache.http.HttpResponse-java.lang.Exception-">onRetry</a></code> in class <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dd><code>statusCode</code> - The HTTP status code received.</dd> +<dd><code>req</code> - The HTTP request object.</dd> +<dd><code>res</code> - The HTTP response object.</dd> +<dd><code>ex</code> - The exception thrown from the client.</dd> +</dl> +</li> +</ul> +<a name="onClose-org.apache.juneau.client.RestCall-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onClose</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/client/RestCallLogger.html#line.71">onClose</a>(<a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> restCall) + throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onClose-org.apache.juneau.client.RestCall-">RestCallInterceptor</a></code></span></div> +<div class="block">Called when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>RestCall.close()</code></a> is called.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html#onClose-org.apache.juneau.client.RestCall-">onClose</a></code> in class <code><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>restCall</code> - The restCall object invoking this method.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code></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="class-use/RestCallLogger.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/client/RestCallLogger.html" target="_top">Frames</a></li> +<li><a href="RestCallLogger.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 ======= --> +</body> +</html>
