/usr/share/doc/libasync-http-client-java/api/com/ning/http/client/BodyDeferringAsyncHandler.html is in libasync-http-client-java-doc 1.6.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sat Dec 03 01:24:03 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
BodyDeferringAsyncHandler (Asynchronous Http Client 1.6.5 API)
</TITLE>
<META NAME="date" CONTENT="2011-12-03">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BodyDeferringAsyncHandler (Asynchronous Http Client 1.6.5 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BodyDeferringAsyncHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/ning/http/client/BodyConsumer.html" title="interface in com.ning.http.client"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.BodyDeferringInputStream.html" title="class in com.ning.http.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/ning/http/client/BodyDeferringAsyncHandler.html" target="_top"><B>FRAMES</B></A>
<A HREF="BodyDeferringAsyncHandler.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.ning.http.client</FONT>
<BR>
Class BodyDeferringAsyncHandler</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.ning.http.client.BodyDeferringAsyncHandler</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>BodyDeferringAsyncHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></DL>
</PRE>
<P>
An AsyncHandler that returns Response (without body, so status code and
headers only) as fast as possible for inspection, but leaves you the option
to defer body consumption.
<p>
This class introduces new call: getResponse(), that blocks caller thread as
long as headers are received, and return Response as soon as possible, but
still pouring response body into supplied output stream. This handler is
meant for situations when the "recommended" way (using
<code>client.prepareGet("http://foo.com/aResource").execute().get()</code>
would not work for you, since a potentially large response body is about to
be GETted, but you need headers first, or you don't know yet (depending on
some logic, maybe coming from headers) where to save the body, or you just
want to leave body stream to some other component to consume it.
<p>
All these above means that this AsyncHandler needs a bit of different
handling than "recommended" way. Some examples:
<pre>
FileOutputStream fos = ...
BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(fos);
// client executes async
Future<Response> fr = client.prepareGet("http://foo.com/aresource").execute(
bdah);
// main thread will block here until headers are available
Response response = bdah.getResponse();
// you can continue examine headers while actual body download happens
// in separate thread
// ...
// finally "join" the download
fr.get();
</pre>
<pre>
PipedOutputStream pout = new PipedOutputStream();
BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pout);
// client executes async
Future<Response> fr = client.prepareGet("http://foo.com/aresource").execute(bdah);
// main thread will block here until headers are available
Response response = bdah.getResponse();
if (response.getStatusCode() == 200) {
InputStream pin = new BodyDeferringInputStream(fr,new PipedInputStream(pout));
// consume InputStream
...
} else {
// handle unexpected response status code
...
}
</pre>
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.BodyDeferringInputStream.html" title="class in com.ning.http.client">BodyDeferringAsyncHandler.BodyDeferringInputStream</A></B></CODE>
<BR>
A simple helper class that is used to perform automatic "join" for async
download and the error checking of the Future of the request.</TD>
</TR>
</TABLE>
<A NAME="nested_classes_inherited_from_class_com.ning.http.client.AsyncHandler"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.ning.http.client.<A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#BodyDeferringAsyncHandler(java.io.OutputStream)">BodyDeferringAsyncHandler</A></B>(java.io.OutputStream os)</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#closeOut()">closeOut</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#getResponse()">getResponse</A></B>()</CODE>
<BR>
This method -- unlike Future<Reponse>.get() -- will block only as long,
as headers arrive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart)">onBodyPartReceived</A></B>(<A HREF="../../../../com/ning/http/client/HttpResponseBodyPart.html" title="class in com.ning.http.client">HttpResponseBodyPart</A> bodyPart)</CODE>
<BR>
Invoked as soon as some response body part are received.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#onCompleted()">onCompleted</A></B>()</CODE>
<BR>
Invoked once the HTTP response processing is finished.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#onHeadersReceived(com.ning.http.client.HttpResponseHeaders)">onHeadersReceived</A></B>(<A HREF="../../../../com/ning/http/client/HttpResponseHeaders.html" title="class in com.ning.http.client">HttpResponseHeaders</A> headers)</CODE>
<BR>
Invoked as soon as the HTTP headers has been received.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#onStatusReceived(com.ning.http.client.HttpResponseStatus)">onStatusReceived</A></B>(<A HREF="../../../../com/ning/http/client/HttpResponseStatus.html" title="class in com.ning.http.client">HttpResponseStatus</A> responseStatus)</CODE>
<BR>
Invoked as soon as the HTTP status line has been received</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.html#onThrowable(java.lang.Throwable)">onThrowable</A></B>(java.lang.Throwable t)</CODE>
<BR>
Invoked when an unexpected exception occurs during the processing of the response.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="BodyDeferringAsyncHandler(java.io.OutputStream)"><!-- --></A><H3>
BodyDeferringAsyncHandler</H3>
<PRE>
public <B>BodyDeferringAsyncHandler</B>(java.io.OutputStream os)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="onThrowable(java.lang.Throwable)"><!-- --></A><H3>
onThrowable</H3>
<PRE>
public void <B>onThrowable</B>(java.lang.Throwable t)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onThrowable(java.lang.Throwable)">AsyncHandler</A></CODE></B></DD>
<DD>Invoked when an unexpected exception occurs during the processing of the response. The exception may have been
produced by implementation of onXXXReceived method invokation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onThrowable(java.lang.Throwable)">onThrowable</A></CODE> in interface <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>t</CODE> - a <CODE>Throwable</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="onStatusReceived(com.ning.http.client.HttpResponseStatus)"><!-- --></A><H3>
onStatusReceived</H3>
<PRE>
public <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A> <B>onStatusReceived</B>(<A HREF="../../../../com/ning/http/client/HttpResponseStatus.html" title="class in com.ning.http.client">HttpResponseStatus</A> responseStatus)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onStatusReceived(com.ning.http.client.HttpResponseStatus)">AsyncHandler</A></CODE></B></DD>
<DD>Invoked as soon as the HTTP status line has been received
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onStatusReceived(com.ning.http.client.HttpResponseStatus)">onStatusReceived</A></CODE> in interface <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>responseStatus</CODE> - the status code and test of the response
<DT><B>Returns:</B><DD>a <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client"><CODE>AsyncHandler.STATE</CODE></A> telling to CONTINUE or ABORT the current processing.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if something wrong happens</DL>
</DD>
</DL>
<HR>
<A NAME="onHeadersReceived(com.ning.http.client.HttpResponseHeaders)"><!-- --></A><H3>
onHeadersReceived</H3>
<PRE>
public <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A> <B>onHeadersReceived</B>(<A HREF="../../../../com/ning/http/client/HttpResponseHeaders.html" title="class in com.ning.http.client">HttpResponseHeaders</A> headers)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onHeadersReceived(com.ning.http.client.HttpResponseHeaders)">AsyncHandler</A></CODE></B></DD>
<DD>Invoked as soon as the HTTP headers has been received. Can potentially be invoked morethan once if a broken server
sent trailling headers.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onHeadersReceived(com.ning.http.client.HttpResponseHeaders)">onHeadersReceived</A></CODE> in interface <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>headers</CODE> - the HTTP headers.
<DT><B>Returns:</B><DD>a <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client"><CODE>AsyncHandler.STATE</CODE></A> telling to CONTINUE or ABORT the current processing.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if something wrong happens</DL>
</DD>
</DL>
<HR>
<A NAME="onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart)"><!-- --></A><H3>
onBodyPartReceived</H3>
<PRE>
public <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client">AsyncHandler.STATE</A> <B>onBodyPartReceived</B>(<A HREF="../../../../com/ning/http/client/HttpResponseBodyPart.html" title="class in com.ning.http.client">HttpResponseBodyPart</A> bodyPart)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart)">AsyncHandler</A></CODE></B></DD>
<DD>Invoked as soon as some response body part are received. Could be invoked many times.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart)">onBodyPartReceived</A></CODE> in interface <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bodyPart</CODE> - response's body part.
<DT><B>Returns:</B><DD>a <A HREF="../../../../com/ning/http/client/AsyncHandler.STATE.html" title="enum in com.ning.http.client"><CODE>AsyncHandler.STATE</CODE></A> telling to CONTINUE or ABORT the current processing.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if something wrong happens</DL>
</DD>
</DL>
<HR>
<A NAME="closeOut()"><!-- --></A><H3>
closeOut</H3>
<PRE>
protected void <B>closeOut</B>()
throws java.io.IOException</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="onCompleted()"><!-- --></A><H3>
onCompleted</H3>
<PRE>
public <A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A> <B>onCompleted</B>()
throws java.io.IOException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onCompleted()">AsyncHandler</A></CODE></B></DD>
<DD>Invoked once the HTTP response processing is finished.
<p/>
Gets always invoked as last callback method.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html#onCompleted()">onCompleted</A></CODE> in interface <CODE><A HREF="../../../../com/ning/http/client/AsyncHandler.html" title="interface in com.ning.http.client">AsyncHandler</A><<A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>T Value that will be returned by the associated <CODE>Future</CODE>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getResponse()"><!-- --></A><H3>
getResponse</H3>
<PRE>
public <A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client">Response</A> <B>getResponse</B>()
throws java.lang.InterruptedException,
java.io.IOException</PRE>
<DL>
<DD>This method -- unlike Future<Reponse>.get() -- will block only as long,
as headers arrive. This is useful for large transfers, to examine headers
ASAP, and defer body streaming to it's fine destination and prevent
unneeded bandwidth consumption. The response here will contain the very
1st response from server, so status code and headers, but it might be
incomplete in case of broken servers sending trailing headers. In that
case, the "usual" Future<Response>.get() method will return complete
headers, but multiple invocations of getResponse() will always return the
1st cached, probably incomplete one. Note: the response returned by this
method will contain everything <em>except</em> the response body itself,
so invoking any method like Response.getResponseBodyXXX() will result in
error! Also, please not that this method might return <code>null</code>
in case of some errors.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a <A HREF="../../../../com/ning/http/client/Response.html" title="interface in com.ning.http.client"><CODE>Response</CODE></A>
<DT><B>Throws:</B>
<DD><CODE>java.lang.InterruptedException</CODE>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BodyDeferringAsyncHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/ning/http/client/BodyConsumer.html" title="interface in com.ning.http.client"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ning/http/client/BodyDeferringAsyncHandler.BodyDeferringInputStream.html" title="class in com.ning.http.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/ning/http/client/BodyDeferringAsyncHandler.html" target="_top"><B>FRAMES</B></A>
<A HREF="BodyDeferringAsyncHandler.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2011. All Rights Reserved.
</BODY>
</HTML>
|