Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.io.entity.EntityUtils

Modifier and Type	Field and Description
private static final Map<String, ContentType>	CONTENT_TYPE_MAP
private static final int	DEFAULT_BYTE_BUFFER_SIZE
private static final int	DEFAULT_CHAR_BUFFER_SIZE
private static final Charset	DEFAULT_CHARSET
private static final int	DEFAULT_ENTITY_RETURN_MAX_LENGTH

Access	Constructor and Description
private	EntityUtils()

Method Summary

Modifier and Type	Method and Description
pack-priv static long	checkContentLength(final EntityDetails entityDetails)
public static void	consume(final HttpEntity the entity to consume. entity) Ensures that the entity content is fully consumed and the content stream, if exists, is closed.
public static void	consumeQuietly(final HttpEntity the entity to consume. entity) Ensures that the entity content is fully consumed and the content stream, if exists, is closed.
public static List<NameValuePair>	Returns: a list of `NameValuePair` as built from the URI's query portion. parse(final HttpEntity The entity to parse entity) Returns a list of `NameValuePairs` as parsed from an `HttpEntity`.
public static List<NameValuePair>	Returns: a list of `NameValuePair` as built from the URI's query portion. parse(final HttpEntity The entity to parse entity, final int The maximum size of the stream to read; use it to guard against unreasonable or malicious processing. maxStreamLength) Returns a list of `NameValuePairs` as parsed from an `HttpEntity`.
public static byte[]	Returns: byte array containing the entity content. May be null if `HttpEntity#getContent()` is null. toByteArray(final HttpEntity the entity to read from= entity) Reads the contents of an entity and return it as a byte array.
public static byte[]	Returns: byte array containing the entity content. May be null if `HttpEntity#getContent()` is null. toByteArray(final HttpEntity the entity to read from= entity, final int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. maxResultLength) Reads the contents of an entity and return it as a byte array.
private static CharArrayBuffer	toCharArrayBuffer(final InputStream inStream, final int contentLength, final Charset charset, final int maxResultLength)
private static int	Returns: The given content length or 4096 if it is < 0. toContentLength(final int an integer. contentLength) Gets a usable content length value for the given candidate.
private static String	toString(final HttpEntity entity, final ContentType contentType, final int maxResultLength)
public static String	Returns: the entity content as a String. May be null if `HttpEntity#getContent()` is null. toString(final HttpEntity must not be null entity, final Charset character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available. defaultCharset) Gets the entity content as a String, using the provided default character set if none is found in the entity.
public static String	Returns: the entity content as a String. May be null if `HttpEntity#getContent()` is null. toString(final HttpEntity must not be null entity, final Charset character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available. defaultCharset, final int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. maxResultLength) Gets the entity content as a String, using the provided default character set if none is found in the entity.
public static String	Returns: the entity content as a String. May be null if `HttpEntity#getContent()` is null. toString(final HttpEntity must not be null entity, final String character set to be applied if none found in the entity defaultCharset) Gets the entity content as a String, using the provided default character set if none is found in the entity.
public static String	Returns: the entity content as a String. May be null if `HttpEntity#getContent()` is null. toString(final HttpEntity must not be null entity, final String character set to be applied if none found in the entity defaultCharset, final int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. maxResultLength) Gets the entity content as a String, using the provided default character set if none is found in the entity.
public static String	Returns: String containing the content. toString(final HttpEntity the entity to convert to a string; must not be null entity) Reads the contents of an entity and return it as a String.
public static String	Returns: String containing the content. toString(final HttpEntity the entity to convert to a string; must not be null entity, final int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. maxResultLength) Reads the contents of an entity and return it as a String.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CONTENT_TYPE_MAP	back to summary
private static final Map<String, ContentType> CONTENT_TYPE_MAP

DEFAULT_BYTE_BUFFER_SIZE	back to summary
private static final int DEFAULT_BYTE_BUFFER_SIZE

DEFAULT_CHAR_BUFFER_SIZE	back to summary
private static final int DEFAULT_CHAR_BUFFER_SIZE

DEFAULT_CHARSET	back to summary
private static final Charset DEFAULT_CHARSET

DEFAULT_ENTITY_RETURN_MAX_LENGTH	back to summary
private static final int DEFAULT_ENTITY_RETURN_MAX_LENGTH

EntityUtils	back to summary
private EntityUtils()

Method Detail

checkContentLength	back to summary
pack-priv static long checkContentLength(final EntityDetails entityDetails)

consume	back to summary
public static void consume(final HttpEntity entity) throws IOException Ensures that the entity content is fully consumed and the content stream, if exists, is closed. Parameters entity:HttpEntity the entity to consume. Exceptions IOException: if an error occurs reading the input stream Since 4.1

consume

back to summary

public static void consume(final HttpEntity entity) throws IOException

Ensures that the entity content is fully consumed and the content stream, if exists, is closed.

Parameters

entity:HttpEntity: the entity to consume.

Exceptions

IOException:: if an error occurs reading the input stream

Since

4.1

consumeQuietly	back to summary
public static void consumeQuietly(final HttpEntity entity) Ensures that the entity content is fully consumed and the content stream, if exists, is closed. The process is done, quietly , without throwing any IOException. Parameters entity:HttpEntity the entity to consume. Since 4.2

consumeQuietly

back to summary

public static void consumeQuietly(final HttpEntity entity)

Ensures that the entity content is fully consumed and the content stream, if exists, is closed. The process is done, quietly , without throwing any IOException.

Parameters

entity:HttpEntity: the entity to consume.

Since

4.2

parse back to summary

parse	back to summary
public static List<NameValuePair> parse(final HttpEntity entity) throws IOException Returns a list of `NameValuePairs` as parsed from an `HttpEntity`. The encoding is taken from the entity's Content-Encoding header. This is typically used while parsing an HTTP POST. Parameters entity:HttpEntity The entity to parse Returns:List<NameValuePair> a list of `NameValuePair` as built from the URI's query portion. Exceptions IOException: If there was an exception getting the entity's data.

public static List<NameValuePair> parse(final HttpEntity entity) throws IOException

Returns a list of NameValuePairs as parsed from an HttpEntity. The encoding is taken from the entity's Content-Encoding header.

This is typically used while parsing an HTTP POST.

Parameters

entity:HttpEntity: The entity to parse

Returns:List<NameValuePair>

a list of NameValuePair as built from the URI's query portion.

Exceptions

IOException:: If there was an exception getting the entity's data.

parse back to summary

parse	back to summary
public static List<NameValuePair> parse(final HttpEntity entity, final int maxStreamLength) throws IOException Returns a list of `NameValuePairs` as parsed from an `HttpEntity`. The encoding is taken from the entity's Content-Encoding header. This is typically used while parsing an HTTP POST. Parameters entity:HttpEntity The entity to parse maxStreamLength:int The maximum size of the stream to read; use it to guard against unreasonable or malicious processing. Returns:List<NameValuePair> a list of `NameValuePair` as built from the URI's query portion. Exceptions IOException: If there was an exception getting the entity's data.

public static List<NameValuePair> parse(final HttpEntity entity, final int maxStreamLength) throws IOException

Returns a list of NameValuePairs as parsed from an HttpEntity. The encoding is taken from the entity's Content-Encoding header.

This is typically used while parsing an HTTP POST.

Parameters

entity:HttpEntity: The entity to parse
maxStreamLength:int: The maximum size of the stream to read; use it to guard against unreasonable or malicious processing.

Returns:List<NameValuePair>

a list of NameValuePair as built from the URI's query portion.

Exceptions

IOException:: If there was an exception getting the entity's data.

toByteArray back to summary

toByteArray	back to summary
public static byte[] toByteArray(final HttpEntity entity) throws IOException Reads the contents of an entity and return it as a byte array. Parameters entity:HttpEntity the entity to read from= Returns:byte[] byte array containing the entity content. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE

public static byte[] toByteArray(final HttpEntity entity) throws IOException

Reads the contents of an entity and return it as a byte array.

Parameters

entity:HttpEntity: the entity to read from=

Returns:byte[]

byte array containing the entity content. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE

toByteArray back to summary

toByteArray	back to summary
public static byte[] toByteArray(final HttpEntity entity, final int maxResultLength) throws IOException Reads the contents of an entity and return it as a byte array. Parameters entity:HttpEntity the entity to read from= maxResultLength:int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. Returns:byte[] byte array containing the entity content. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE

public static byte[] toByteArray(final HttpEntity entity, final int maxResultLength) throws IOException

Reads the contents of an entity and return it as a byte array.

Parameters

entity:HttpEntity: the entity to read from=
maxResultLength:int: The maximum size of the String to return; use it to guard against unreasonable or malicious processing.

Returns:byte[]

byte array containing the entity content. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE

toCharArrayBuffer	back to summary
private static CharArrayBuffer toCharArrayBuffer(final InputStream inStream, final int contentLength, final Charset charset, final int maxResultLength) throws IOException

toContentLength	back to summary
private static int toContentLength(final int contentLength) Gets a usable content length value for the given candidate. Parameters contentLength:int an integer. Returns:int The given content length or 4096 if it is < 0.

toContentLength

back to summary

private static int toContentLength(final int contentLength)

Gets a usable content length value for the given candidate.

Parameters

contentLength:int: an integer.

Returns:int

The given content length or 4096 if it is < 0.

toString	back to summary
private static String toString(final HttpEntity entity, final ContentType contentType, final int maxResultLength) throws IOException

toString back to summary

toString	back to summary
public static String toString(final HttpEntity entity, final Charset defaultCharset) throws IOException, ParseException Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used. Parameters entity:HttpEntity must not be null defaultCharset:Charset character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available. Returns:String the entity content as a String. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named entity's charset is not available in this instance of the Java virtual machine and no defaultCharset is provided.

public static String toString(final HttpEntity entity, final Charset defaultCharset) throws IOException, ParseException

Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used.

Parameters

entity:HttpEntity: must not be null
defaultCharset:Charset: character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available.

Returns:String

the entity content as a String. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named entity's charset is not available in this instance of the Java virtual machine and no defaultCharset is provided.

toString back to summary

toString	back to summary
public static String toString(final HttpEntity entity, final Charset defaultCharset, final int maxResultLength) throws IOException, ParseException Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used. Parameters entity:HttpEntity must not be null defaultCharset:Charset character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available. maxResultLength:int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. Returns:String the entity content as a String. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named entity's charset is not available in this instance of the Java virtual machine and no defaultCharset is provided.

public static String toString(final HttpEntity entity, final Charset defaultCharset, final int maxResultLength) throws IOException, ParseException

Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used.

Parameters

entity:HttpEntity: must not be null
defaultCharset:Charset: character set to be applied if none found in the entity, or if the entity provided charset is invalid or not available.
maxResultLength:int: The maximum size of the String to return; use it to guard against unreasonable or malicious processing.

Returns:String

the entity content as a String. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named entity's charset is not available in this instance of the Java virtual machine and no defaultCharset is provided.

toString back to summary

toString	back to summary
public static String toString(final HttpEntity entity, final String defaultCharset) throws IOException, ParseException Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used. Parameters entity:HttpEntity must not be null defaultCharset:String character set to be applied if none found in the entity Returns:String the entity content as a String. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named charset is not available in this instance of the Java virtual machine

public static String toString(final HttpEntity entity, final String defaultCharset) throws IOException, ParseException

Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used.

Parameters

entity:HttpEntity: must not be null
defaultCharset:String: character set to be applied if none found in the entity

Returns:String

the entity content as a String. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named charset is not available in this instance of the Java virtual machine

toString back to summary

toString	back to summary
public static String toString(final HttpEntity entity, final String defaultCharset, final int maxResultLength) throws IOException, ParseException Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used. Parameters entity:HttpEntity must not be null defaultCharset:String character set to be applied if none found in the entity maxResultLength:int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. Returns:String the entity content as a String. May be null if `HttpEntity#getContent()` is null. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named charset is not available in this instance of the Java virtual machine

public static String toString(final HttpEntity entity, final String defaultCharset, final int maxResultLength) throws IOException, ParseException

Gets the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used.

Parameters

entity:HttpEntity: must not be null
defaultCharset:String: character set to be applied if none found in the entity
maxResultLength:int: The maximum size of the String to return; use it to guard against unreasonable or malicious processing.

Returns:String

the entity content as a String. May be null if HttpEntity#getContent() is null.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named charset is not available in this instance of the Java virtual machine

toString	back to summary
public static String toString(final HttpEntity entity) throws IOException, ParseException Reads the contents of an entity and return it as a String. The content is converted using the character set from the entity (if any), failing that, "ISO-8859-1" is used. Parameters entity:HttpEntity the entity to convert to a string; must not be null Returns:String String containing the content. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named charset is not available in this instance of the Java virtual machine

toString

back to summary

public static String toString(final HttpEntity entity) throws IOException, ParseException

Reads the contents of an entity and return it as a String. The content is converted using the character set from the entity (if any), failing that, "ISO-8859-1" is used.

Parameters

entity:HttpEntity: the entity to convert to a string; must not be null

Returns:String

String containing the content.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named charset is not available in this instance of the Java virtual machine

toString	back to summary
public static String toString(final HttpEntity entity, final int maxResultLength) throws IOException, ParseException Reads the contents of an entity and return it as a String. The content is converted using the character set from the entity (if any), failing that, "ISO-8859-1" is used. Parameters entity:HttpEntity the entity to convert to a string; must not be null maxResultLength:int The maximum size of the String to return; use it to guard against unreasonable or malicious processing. Returns:String String containing the content. Exceptions IOException: if an error occurs reading the input stream ParseException: if header elements cannot be parsed IllegalArgumentException: if entity is null or if content length > Integer.MAX_VALUE UnsupportedCharsetException: Thrown when the named charset is not available in this instance of the Java virtual machine

toString

back to summary

public static String toString(final HttpEntity entity, final int maxResultLength) throws IOException, ParseException

Reads the contents of an entity and return it as a String. The content is converted using the character set from the entity (if any), failing that, "ISO-8859-1" is used.

Parameters

entity:HttpEntity: the entity to convert to a string; must not be null
maxResultLength:int: The maximum size of the String to return; use it to guard against unreasonable or malicious processing.

Returns:String

String containing the content.

Exceptions

IOException:: if an error occurs reading the input stream
ParseException:: if header elements cannot be parsed
IllegalArgumentException:: if entity is null or if content length > Integer.MAX_VALUE
UnsupportedCharsetException:: Thrown when the named charset is not available in this instance of the Java virtual machine

public final Class EntityUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail