## Uses of Interface
org.apache.http.HttpEntity

- Packages that use HttpEntity
  Package | Description
  --- | ---
  org.apache.http | Core HTTP components based on the blocking I/O model.
  org.apache.http.entity | Common HTTP entity implementations.
  org.apache.http.impl | Default implementations for interfaces in `org.apache.http`.
  org.apache.http.impl.entity | Default implementations for interfaces in `org.apache.http.entity` and provides utility classes for serialization and deserialization of HTTP content entities.
  org.apache.http.impl.nio | Default implementations for interfaces in `org.apache.http.nio`.
  org.apache.http.message | Basic HTTP message implementations.
  org.apache.http.nio.entity | Common HTTP entity implementations with extensions for asynchronous (non-blocking) data transfer.
  org.apache.http.nio.protocol | Asynchronous HTTP protocol handlers based on the non-blocking I/O model.
  org.apache.http.util | Resizable `byte` and `char` arrays and various utility classes with static helper methods.

- - ### Uses of HttpEntity in org.apache.http

    Methods in org.apache.http that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | HttpResponse.`getEntity()` Obtains the message entity of this response, if any.
    `HttpEntity` | HttpEntityEnclosingRequest.`getEntity()` Returns the entity associated with this request.

    Methods in org.apache.http with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `void` | HttpResponse.`setEntity(HttpEntity entity)` Associates a response entity with this response.
    `void` | HttpEntityEnclosingRequest.`setEntity(HttpEntity entity)` Associates the entity with this request.

  - ### Uses of HttpEntity in org.apache.http.entity

    Classes in org.apache.http.entity that implement HttpEntity
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractHttpEntity` Abstract base class for entities.
    `class` | `BasicHttpEntity` A generic streamed, non-repeatable entity that obtains its content from an `InputStream`.
    `class` | `BufferedHttpEntity` A wrapping entity that buffers it content if necessary.
    `class` | `ByteArrayEntity` A self contained, repeatable entity that obtains its content from a byte array.
    `class` | `EntityTemplate` Entity that delegates the process of content generation to a `ContentProducer`.
    `class` | `FileEntity` A self contained, repeatable entity that obtains its content from a file.
    `class` | `HttpEntityWrapper` Base class for wrapping entities.
    `class` | `InputStreamEntity` A streamed, non-repeatable entity that obtains its content from an `InputStream`.
    `class` | `SerializableEntity` A streamed entity that obtains its content from a `Serializable`.
    `class` | `StringEntity` A self contained, repeatable entity that obtains its content from a `String`.

    Fields in org.apache.http.entity declared as HttpEntity
    Modifier and Type | Field and Description
    --- | ---
    `protected HttpEntity` | HttpEntityWrapper.`wrappedEntity` The wrapped entity.

    Methods in org.apache.http.entity with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `static ContentType` | ContentType.`get(HttpEntity entity)` Extracts `Content-Type` value from `HttpEntity` exactly as specified by the `Content-Type` header of the entity.
    `static ContentType` | ContentType.`getOrDefault(HttpEntity entity)` Extracts `Content-Type` value from `HttpEntity` or returns the default value `ContentType.DEFAULT_TEXT` if not explicitly specified.

    Constructors in org.apache.http.entity with parameters of type HttpEntity
    Constructor and Description
    `BufferedHttpEntity(HttpEntity entity)` Creates a new buffered entity wrapper.
    `HttpEntityWrapper(HttpEntity wrappedEntity)` Creates a new entity wrapper.

  - ### Uses of HttpEntity in org.apache.http.impl

    Methods in org.apache.http.impl that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `protected HttpEntity` | BHttpConnectionBase.`prepareInput(HttpMessage message)`

  - ### Uses of HttpEntity in org.apache.http.impl.entity

    Methods in org.apache.http.impl.entity that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | EntityDeserializer.`deserialize(SessionInputBuffer inbuffer, HttpMessage message)` Deprecated. Creates an `HttpEntity` based on properties of the given message.

    Methods in org.apache.http.impl.entity with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntitySerializer.`serialize(SessionOutputBuffer outbuffer, HttpMessage message, HttpEntity entity)` Deprecated. Writes out the content of the given HTTP entity to the session output buffer based on properties of the given HTTP message.

  - ### Uses of HttpEntity in org.apache.http.impl.nio

    Methods in org.apache.http.impl.nio that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `protected HttpEntity` | NHttpConnectionBase.`prepareDecoder(HttpMessage message)` Initializes a specific `ContentDecoder` implementation based on the properties of the given `HttpMessage` and generates an instance of `HttpEntity` matching the properties of the content decoder.

  - ### Uses of HttpEntity in org.apache.http.message

    Methods in org.apache.http.message that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | BasicHttpResponse.`getEntity()`
    `HttpEntity` | BasicHttpEntityEnclosingRequest.`getEntity()`

    Methods in org.apache.http.message with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `void` | BasicHttpResponse.`setEntity(HttpEntity entity)`
    `void` | BasicHttpEntityEnclosingRequest.`setEntity(HttpEntity entity)`

  - ### Uses of HttpEntity in org.apache.http.nio.entity

    Subinterfaces of HttpEntity in org.apache.http.nio.entity
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ConsumingNHttpEntity` Deprecated. use (4.2) `BasicAsyncRequestProducer` or `BasicAsyncResponseProducer`
    `interface` | `ProducingNHttpEntity` Deprecated. use (4.2) `BasicAsyncRequestProducer` or `BasicAsyncResponseProducer`

    Classes in org.apache.http.nio.entity that implement HttpEntity
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BufferingNHttpEntity` Deprecated. use (4.2) `BasicAsyncRequestProducer` or `BasicAsyncResponseProducer`
    `class` | `ConsumingNHttpEntityTemplate` Deprecated. use (4.2) `BasicAsyncRequestProducer` or `BasicAsyncResponseProducer`
    `class` | `ContentBufferEntity` HTTP entity wrapper whose content is provided by a `ContentInputBuffer`.
    `class` | `NByteArrayEntity` A simple self contained, repeatable non-blocking entity that retrieves its content from a byte array.
    `class` | `NFileEntity` A self contained, repeatable non-blocking entity that retrieves its content from a file.
    `class` | `NHttpEntityWrapper` Deprecated. (4.2) use `EntityAsyncContentProducer`
    `class` | `NStringEntity` A simple, self contained, repeatable non-blocking entity that retrieves its content from a `String` object.

    Constructors in org.apache.http.nio.entity with parameters of type HttpEntity
    Constructor and Description
    `BufferingNHttpEntity(HttpEntity httpEntity, ByteBufferAllocator allocator)` Deprecated.
    `ConsumingNHttpEntityTemplate(HttpEntity httpEntity, ContentListener contentListener)` Deprecated.
    `ContentBufferEntity(HttpEntity entity, ContentInputBuffer buffer)` Creates new instance of ContentBufferEntity.
    `EntityAsyncContentProducer(HttpEntity entity)`
    `NHttpEntityWrapper(HttpEntity httpEntity)` Deprecated.

  - ### Uses of HttpEntity in org.apache.http.nio.protocol

    Methods in org.apache.http.nio.protocol with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract void` | AbstractAsyncResponseConsumer.`onEntityEnclosed(HttpEntity entity, ContentType contentType)` Invoked if the response message encloses a content entity.
    `protected void` | BasicAsyncResponseConsumer.`onEntityEnclosed(HttpEntity entity, ContentType contentType)`
    `protected void` | BasicAsyncRequestConsumer.`onEntityEnclosed(HttpEntity entity, ContentType contentType)`
    `protected abstract void` | AbstractAsyncRequestConsumer.`onEntityEnclosed(HttpEntity entity, ContentType contentType)` Invoked if the request message encloses a content entity.

  - ### Uses of HttpEntity in org.apache.http.util

    Methods in org.apache.http.util with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `static void` | EntityUtils.`consume(HttpEntity entity)` Ensures that the entity content is fully consumed and the content stream, if exists, is closed.
    `static void` | EntityUtils.`consumeQuietly(HttpEntity entity)` Ensures that the entity content is fully consumed and the content stream, if exists, is closed.
    `static String` | EntityUtils.`getContentCharSet(HttpEntity entity)` Deprecated. (4.1.3) use `ContentType.getOrDefault(HttpEntity)`
    `static String` | EntityUtils.`getContentMimeType(HttpEntity entity)` Deprecated. (4.1.3) use `ContentType.getOrDefault(HttpEntity)`
    `static byte[]` | EntityUtils.`toByteArray(HttpEntity entity)` Read the contents of an entity and return it as a byte array.
    `static String` | EntityUtils.`toString(HttpEntity entity)` Read the contents of an entity and return it as a String.
    `static String` | EntityUtils.`toString(HttpEntity entity, Charset defaultCharset)` Get the entity content as a String, using the provided default character set if none is found in the entity.
    `static String` | EntityUtils.`toString(HttpEntity entity, String defaultCharset)` Get the entity content as a String, using the provided default character set if none is found in the entity.
    `static void` | EntityUtils.`updateEntity(HttpResponse response, HttpEntity entity)` Updates an entity in a response by first consuming an existing entity, then setting the new one.

Copyright © 2005–2013 The Apache Software Foundation. All rights reserved.