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

- Packages that use HttpEntity
  Package | Description
  --- | ---
  org.apache.hc.core5.http | Core HTTP transport component APIs.
  org.apache.hc.core5.http.io.entity | HTTP message entity APIs based on the classic (blocking) I/O model.
  org.apache.hc.core5.http.io.support | Support classes for the classic (blocking) I/O model.
  org.apache.hc.core5.http.message | Core HTTP message components, message element parser and writer APIs and their default implementations.

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

    Methods in org.apache.hc.core5.http that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | HttpEntityContainer.`getEntity()` Obtains the message entity, if available.

    Methods in org.apache.hc.core5.http with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `void` | HttpEntityContainer.`setEntity(HttpEntity entity)` Sets an entity for this message.

  - ### Uses of HttpEntity in org.apache.hc.core5.http.io.entity

    Classes in org.apache.hc.core5.http.io.entity that implement HttpEntity
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractHttpEntity` Abstract base class for mutable 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` | `ByteBufferEntity` An entity that delivers the contents of a `ByteBuffer`.
    `class` | `EntityTemplate` Entity that delegates the process of content generation to a `IOCallback` with `OutputStream` as output sink.
    `class` | `FileEntity` A self contained, repeatable entity that obtains its content from a file.
    `class` | `HttpEntityWrapper` Base class for wrapping entities that delegates all calls to the wrapped entity.
    `class` | `InputStreamEntity` A streamed, non-repeatable entity that obtains its content from an `InputStream`.
    `class` | `NullEntity` An empty entity with no content-type.
    `class` | `PathEntity` A self contained, repeatable entity that obtains its content from a path.
    `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`.

    Methods in org.apache.hc.core5.http.io.entity that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `static HttpEntity` | HttpEntities.`create(byte[] content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(byte[] content, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(File content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(File content, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(IOCallback<OutputStream> callback, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(IOCallback<OutputStream> callback, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(Path content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(Path content, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(Serializable serializable, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(Serializable serializable, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(String content)`
    `static HttpEntity` | HttpEntities.`create(String content, Charset charset)`
    `static HttpEntity` | HttpEntities.`create(String content, Charset charset, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(String content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`create(String content, ContentType contentType, Header... trailers)`
    `static HttpEntity` | HttpEntities.`create(String content, Header... trailers)`
    `static HttpEntity` | HttpEntities.`createGzipped(byte[] content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createGzipped(File content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createGzipped(IOCallback<OutputStream> callback, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createGzipped(Path content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createGzipped(Serializable serializable, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createGzipped(String content)`
    `static HttpEntity` | HttpEntities.`createGzipped(String content, Charset charset)`
    `static HttpEntity` | HttpEntities.`createGzipped(String content, ContentType contentType)`
    `static HttpEntity` | HttpEntities.`createUrlEncoded(Iterable<? extends NameValuePair> parameters, Charset charset)`
    `static HttpEntity` | HttpEntities.`gzip(HttpEntity entity)`
    `static HttpEntity` | HttpEntities.`withTrailers(HttpEntity entity, Header... trailers)`

    Methods in org.apache.hc.core5.http.io.entity 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 HttpEntity` | HttpEntities.`gzip(HttpEntity entity)`
    `static List<NameValuePair>` | EntityUtils.`parse(HttpEntity entity)` Returns a list of `NameValuePairs` as parsed from an `HttpEntity`.
    `static List<NameValuePair>` | EntityUtils.`parse(HttpEntity entity, int maxStreamLength)` Returns a list of `NameValuePairs` as parsed from an `HttpEntity`.
    `static byte[]` | EntityUtils.`toByteArray(HttpEntity entity)` Reads the contents of an entity and return it as a byte array.
    `static byte[]` | EntityUtils.`toByteArray(HttpEntity entity, int maxResultLength)` Reads the contents of an entity and return it as a byte array.
    `static String` | EntityUtils.`toString(HttpEntity entity)` Reads the contents of an entity and return it as a String.
    `static String` | EntityUtils.`toString(HttpEntity entity, Charset defaultCharset)` Gets 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, Charset defaultCharset, int maxResultLength)` Gets 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, int maxResultLength)` Reads the contents of an entity and return it as a String.
    `static String` | EntityUtils.`toString(HttpEntity entity, String defaultCharset)` Gets 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, int maxResultLength)` Gets the entity content as a String, using the provided default character set if none is found in the entity.
    `static HttpEntity` | HttpEntities.`withTrailers(HttpEntity entity, Header... trailers)`
    `static void` | AbstractHttpEntity.`writeTo(HttpEntity entity, OutputStream outStream)`

    Constructors in org.apache.hc.core5.http.io.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.hc.core5.http.io.support

    Methods in org.apache.hc.core5.http.io.support that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `protected HttpEntity` | HttpServerExpectationFilter.`generateResponseContent(HttpResponse expectationFailed)` Generates response content entity for the final HTTP response with an error status representing the cause of expectation failure.
    `protected HttpEntity` | AbstractHttpServerAuthFilter.`generateResponseContent(HttpResponse unauthorized)` Generates response body for UNAUTHORIZED response.
    `HttpEntity` | ClassicRequestBuilder.`getEntity()`
    `HttpEntity` | ClassicResponseBuilder.`getEntity()`

    Methods in org.apache.hc.core5.http.io.support with parameters of type HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `ClassicRequestBuilder` | ClassicRequestBuilder.`setEntity(HttpEntity entity)`
    `ClassicResponseBuilder` | ClassicResponseBuilder.`setEntity(HttpEntity entity)`

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

    Methods in org.apache.hc.core5.http.message that return HttpEntity
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | BasicClassicHttpResponse.`getEntity()`
    `HttpEntity` | BasicClassicHttpRequest.`getEntity()`

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

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