| <!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.5.0_22) on Tue Sep 18 20:44:13 GMT+01:00 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| HttpEntity (HttpComponents Core 4.2.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.http.HttpEntity interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="HttpEntity (HttpComponents Core 4.2.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/HttpEntity.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="../../../org/apache/http/HttpConnectionMetrics.html" title="interface in org.apache.http"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/http/HttpEntityEnclosingRequest.html" title="interface in org.apache.http"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/http/HttpEntity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="HttpEntity.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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"> |
| org.apache.http</FONT> |
| <BR> |
| Interface HttpEntity</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/apache/http/nio/entity/ConsumingNHttpEntity.html" title="interface in org.apache.http.nio.entity">ConsumingNHttpEntity</A>, <A HREF="../../../org/apache/http/nio/entity/ProducingNHttpEntity.html" title="interface in org.apache.http.nio.entity">ProducingNHttpEntity</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/http/entity/AbstractHttpEntity.html" title="class in org.apache.http.entity">AbstractHttpEntity</A>, <A HREF="../../../org/apache/http/entity/BasicHttpEntity.html" title="class in org.apache.http.entity">BasicHttpEntity</A>, <A HREF="../../../org/apache/http/entity/BufferedHttpEntity.html" title="class in org.apache.http.entity">BufferedHttpEntity</A>, <A HREF="../../../org/apache/http/nio/entity/BufferingNHttpEntity.html" title="class in org.apache.http.nio.entity">BufferingNHttpEntity</A>, <A HREF="../../../org/apache/http/entity/ByteArrayEntity.html" title="class in org.apache.http.entity">ByteArrayEntity</A>, <A HREF="../../../org/apache/http/nio/entity/ConsumingNHttpEntityTemplate.html" title="class in org.apache.http.nio.entity">ConsumingNHttpEntityTemplate</A>, <A HREF="../../../org/apache/http/nio/entity/ContentBufferEntity.html" title="class in org.apache.http.nio.entity">ContentBufferEntity</A>, <A HREF="../../../org/apache/http/entity/EntityTemplate.html" title="class in org.apache.http.entity">EntityTemplate</A>, <A HREF="../../../org/apache/http/entity/FileEntity.html" title="class in org.apache.http.entity">FileEntity</A>, <A HREF="../../../org/apache/http/entity/HttpEntityWrapper.html" title="class in org.apache.http.entity">HttpEntityWrapper</A>, <A HREF="../../../org/apache/http/entity/InputStreamEntity.html" title="class in org.apache.http.entity">InputStreamEntity</A>, <A HREF="../../../org/apache/http/nio/entity/NByteArrayEntity.html" title="class in org.apache.http.nio.entity">NByteArrayEntity</A>, <A HREF="../../../org/apache/http/nio/entity/NFileEntity.html" title="class in org.apache.http.nio.entity">NFileEntity</A>, <A HREF="../../../org/apache/http/nio/entity/NHttpEntityWrapper.html" title="class in org.apache.http.nio.entity">NHttpEntityWrapper</A>, <A HREF="../../../org/apache/http/nio/entity/NStringEntity.html" title="class in org.apache.http.nio.entity">NStringEntity</A>, <A HREF="../../../org/apache/http/entity/SerializableEntity.html" title="class in org.apache.http.entity">SerializableEntity</A>, <A HREF="../../../org/apache/http/entity/StringEntity.html" title="class in org.apache.http.entity">StringEntity</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>HttpEntity</B></DL> |
| </PRE> |
| |
| <P> |
| An entity that can be sent or received with an HTTP message. |
| Entities can be found in some |
| <A HREF="../../../org/apache/http/HttpEntityEnclosingRequest.html" title="interface in org.apache.http"><CODE>requests</CODE></A> and in |
| <A HREF="../../../org/apache/http/HttpResponse.html" title="interface in org.apache.http"><CODE>responses</CODE></A>, where they are optional. |
| <p> |
| There are three distinct types of entities in HttpCore, |
| depending on where their <A HREF="../../../org/apache/http/HttpEntity.html#getContent()"><CODE>content</CODE></A> originates: |
| <ul> |
| <li><b>streamed</b>: The content is received from a stream, or |
| generated on the fly. In particular, this category includes |
| entities being received from a <A HREF="../../../org/apache/http/HttpConnection.html" title="interface in org.apache.http"><CODE>connection</CODE></A>. |
| <A HREF="../../../org/apache/http/HttpEntity.html#isStreaming()"><CODE>Streamed</CODE></A> entities are generally not |
| <A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()"><CODE>repeatable</CODE></A>. |
| </li> |
| <li><b>self-contained</b>: The content is in memory or obtained by |
| means that are independent from a connection or other entity. |
| Self-contained entities are generally <A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()"><CODE>repeatable</CODE></A>. |
| </li> |
| <li><b>wrapping</b>: The content is obtained from another entity. |
| </li> |
| </ul> |
| This distinction is important for connection management with incoming |
| entities. For entities that are created by an application and only sent |
| using the HTTP components framework, the difference between streamed |
| and self-contained is of little importance. In that case, it is suggested |
| to consider non-repeatable entities as streamed, and those that are |
| repeatable (without a huge effort) as self-contained. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>4.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#consumeContent()">consumeContent</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>(4.1) Use <A HREF="../../../org/apache/http/util/EntityUtils.html#consume(org.apache.http.HttpEntity)"><CODE>EntityUtils.consume(HttpEntity)</CODE></A></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#getContent()">getContent</A></B>()</CODE> |
| |
| <BR> |
| Returns a content stream of the entity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/http/Header.html" title="interface in org.apache.http">Header</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#getContentEncoding()">getContentEncoding</A></B>()</CODE> |
| |
| <BR> |
| Obtains the Content-Encoding header, if known.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#getContentLength()">getContentLength</A></B>()</CODE> |
| |
| <BR> |
| Tells the length of the content, if known.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/http/Header.html" title="interface in org.apache.http">Header</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#getContentType()">getContentType</A></B>()</CODE> |
| |
| <BR> |
| Obtains the Content-Type header, if known.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#isChunked()">isChunked</A></B>()</CODE> |
| |
| <BR> |
| Tells about chunked encoding for this entity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()">isRepeatable</A></B>()</CODE> |
| |
| <BR> |
| Tells if the entity is capable of producing its data more than once.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/http/HttpEntity.html#isStreaming()">isStreaming</A></B>()</CODE> |
| |
| <BR> |
| Tells whether this entity depends on an underlying stream.</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="../../../org/apache/http/HttpEntity.html#writeTo(java.io.OutputStream)">writeTo</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> outstream)</CODE> |
| |
| <BR> |
| Writes the entity content out to the output stream.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="isRepeatable()"><!-- --></A><H3> |
| isRepeatable</H3> |
| <PRE> |
| boolean <B>isRepeatable</B>()</PRE> |
| <DL> |
| <DD>Tells if the entity is capable of producing its data more than once. |
| A repeatable entity's getContent() and writeTo(OutputStream) methods |
| can be called more than once whereas a non-repeatable entity's can not. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the entity is repeatable, false otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isChunked()"><!-- --></A><H3> |
| isChunked</H3> |
| <PRE> |
| boolean <B>isChunked</B>()</PRE> |
| <DL> |
| <DD>Tells about chunked encoding for this entity. |
| The primary purpose of this method is to indicate whether |
| chunked encoding should be used when the entity is sent. |
| For entities that are received, it can also indicate whether |
| the entity was received with chunked encoding. |
| <br/> |
| The behavior of wrapping entities is implementation dependent, |
| but should respect the primary purpose. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if chunked encoding is preferred for this |
| entity, or <code>false</code> if it is not</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentLength()"><!-- --></A><H3> |
| getContentLength</H3> |
| <PRE> |
| long <B>getContentLength</B>()</PRE> |
| <DL> |
| <DD>Tells the length of the content, if known. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the number of bytes of the content, or |
| a negative number if unknown. If the content length is known |
| but exceeds <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Long.html#MAX_VALUE" title="class or interface in java.lang"><CODE>Long.MAX_VALUE</CODE></A>, |
| a negative number is returned.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentType()"><!-- --></A><H3> |
| getContentType</H3> |
| <PRE> |
| <A HREF="../../../org/apache/http/Header.html" title="interface in org.apache.http">Header</A> <B>getContentType</B>()</PRE> |
| <DL> |
| <DD>Obtains the Content-Type header, if known. |
| This is the header that should be used when sending the entity, |
| or the one that was received with the entity. It can include a |
| charset attribute. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Content-Type header for this entity, or |
| <code>null</code> if the content type is unknown</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentEncoding()"><!-- --></A><H3> |
| getContentEncoding</H3> |
| <PRE> |
| <A HREF="../../../org/apache/http/Header.html" title="interface in org.apache.http">Header</A> <B>getContentEncoding</B>()</PRE> |
| <DL> |
| <DD>Obtains the Content-Encoding header, if known. |
| This is the header that should be used when sending the entity, |
| or the one that was received with the entity. |
| Wrapping entities that modify the content encoding should |
| adjust this header accordingly. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Content-Encoding header for this entity, or |
| <code>null</code> if the content encoding is unknown</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContent()"><!-- --></A><H3> |
| getContent</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> <B>getContent</B>() |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE> |
| <DL> |
| <DD>Returns a content stream of the entity. |
| <A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()"><CODE>Repeatable</CODE></A> entities are expected |
| to create a new instance of <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io"><CODE>InputStream</CODE></A> for each invocation |
| of this method and therefore can be consumed multiple times. |
| Entities that are not <A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()"><CODE>repeatable</CODE></A> are expected |
| to return the same <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io"><CODE>InputStream</CODE></A> instance and therefore |
| may not be consumed more than once. |
| <p> |
| IMPORTANT: Please note all entity implementations must ensure that |
| all allocated resources are properly deallocated after |
| the <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html#close()" title="class or interface in java.io"><CODE>InputStream.close()</CODE></A> method is invoked. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>content stream of the entity. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if the stream could not be created |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if content stream cannot be created.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/http/HttpEntity.html#isRepeatable()"><CODE>isRepeatable()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="writeTo(java.io.OutputStream)"><!-- --></A><H3> |
| writeTo</H3> |
| <PRE> |
| void <B>writeTo</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> outstream) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Writes the entity content out to the output stream. |
| <p> |
| <p> |
| IMPORTANT: Please note all entity implementations must ensure that |
| all allocated resources are properly deallocated when this method |
| returns. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>outstream</CODE> - the output stream to write entity content to |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isStreaming()"><!-- --></A><H3> |
| isStreaming</H3> |
| <PRE> |
| boolean <B>isStreaming</B>()</PRE> |
| <DL> |
| <DD>Tells whether this entity depends on an underlying stream. |
| Streamed entities that read data directly from the socket should |
| return <code>true</code>. Self-contained entities should return |
| <code>false</code>. Wrapping entities should delegate this call |
| to the wrapped entity. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if the entity content is streamed, |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="consumeContent()"><!-- --></A><H3> |
| consumeContent</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>void <B>consumeContent</B>() |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>(4.1) Use <A HREF="../../../org/apache/http/util/EntityUtils.html#consume(org.apache.http.HttpEntity)"><CODE>EntityUtils.consume(HttpEntity)</CODE></A></I> |
| <P> |
| <DD>This method is deprecated since version 4.1. Please use standard |
| java convention to ensure resource deallocation by calling |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html#close()" title="class or interface in java.io"><CODE>InputStream.close()</CODE></A> on the input stream returned by |
| <A HREF="../../../org/apache/http/HttpEntity.html#getContent()"><CODE>getContent()</CODE></A> |
| <p> |
| This method is called to indicate that the content of this entity |
| is no longer required. All entity implementations are expected to |
| release all allocated resources as a result of this method |
| invocation. Content streaming entities are also expected to |
| dispose of the remaining content, if any. Wrapping entities should |
| delegate this call to the wrapped entity. |
| <p> |
| This method is of particular importance for entities being |
| received from a <A HREF="../../../org/apache/http/HttpConnection.html" title="interface in org.apache.http"><CODE>connection</CODE></A>. The entity |
| needs to be consumed completely in order to re-use the connection |
| with keep-alive. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/http/HttpEntity.html#getContent()"><CODE>and #writeTo(OutputStream)</CODE></A></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/HttpEntity.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="../../../org/apache/http/HttpConnectionMetrics.html" title="interface in org.apache.http"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/http/HttpEntityEnclosingRequest.html" title="interface in org.apache.http"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/http/HttpEntity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="HttpEntity.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
