Package org.apache.juneau.http

Class HttpEntities

java.lang.Object

org.apache.juneau.http.HttpEntities

public class HttpEntities
extends Object

Standard predefined HTTP entities.

See Also:

• juneau-rest-common Basics

Constructor Summary

Constructors

Constructor	Description
HttpEntities()

Method Summary

Modifier and Type	Method	Description
static final ByteArrayEntity	byteArrayEntity(byte[] content)	Creates a new ByteArrayEntity builder.
static final ByteArrayEntity	byteArrayEntity(byte[] content, ContentType contentType)	Creates a new ByteArrayEntity builder.
static final ByteArrayEntity	byteArrayEntity(Supplier<byte[]> content)	Creates a new ByteArrayEntity builder.
static final ByteArrayEntity	byteArrayEntity(Supplier<byte[]> content, ContentType contentType)	Creates a new ByteArrayEntity builder.
static final FileEntity	fileEntity(File content)	Creates a new FileEntity builder.
static final FileEntity	fileEntity(File content, ContentType contentType)	Creates a new FileEntity builder.
static final ReaderEntity	readerEntity(Reader content)	Creates a new ReaderEntity builder.
static final ReaderEntity	readerEntity(Reader content, ContentType contentType)	Creates a new ReaderEntity builder.
static final SerializedEntity	serializedEntity(Object content, Serializer serializer)	Creates a new SerializedEntity object.
static final SerializedEntity	serializedEntity(Object content, Serializer serializer, HttpPartSchema schema)	Creates a new SerializedEntity object.
static final SerializedEntity	serializedEntity(Supplier<?> content, Serializer serializer)	Creates a new SerializedEntity object.
static final SerializedEntity	serializedEntity(Supplier<?> content, Serializer serializer, HttpPartSchema schema)	Creates a new SerializedEntity object.
static final StreamEntity	streamEntity(InputStream content)	Creates a new StreamEntity builder.
static final StreamEntity	streamEntity(InputStream content, long length, ContentType contentType)	Creates a new StreamEntity builder.
static final StringEntity	stringEntity(String content)	Creates a new builder for a StringEntity builder.
static final StringEntity	stringEntity(String content, ContentType contentType)	Creates a new builder for a StringEntity builder.
static final StringEntity	stringEntity(Supplier<String> content)	Creates a new builder for a StringEntity builder.
static final StringEntity	stringEntity(Supplier<String> content, ContentType contentType)	Creates a new builder for a StringEntity builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpEntities

public HttpEntities()

Method Details

byteArrayEntity

public static final ByteArrayEntity byteArrayEntity(byte[] content)

Creates a new ByteArrayEntity builder.

Assumes no content type.

Parameters:

content - The entity content. Can be null.

Returns:

A new ByteArrayEntity builder.

byteArrayEntity

public static final ByteArrayEntity byteArrayEntity(byte[] content,
 ContentType contentType)

Creates a new ByteArrayEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new ByteArrayEntity builder.

byteArrayEntity

public static final ByteArrayEntity byteArrayEntity(Supplier<byte[]> content)

Creates a new ByteArrayEntity builder.

Assumes no content type.

Parameters:

content - The entity content supplier. Can be null.

Returns:

A new ByteArrayEntity builder.

byteArrayEntity

public static final ByteArrayEntity byteArrayEntity(Supplier<byte[]> content,
 ContentType contentType)

Creates a new ByteArrayEntity builder.

Parameters:

content - The entity content supplier. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new ByteArrayEntity builder.

fileEntity

public static final FileEntity fileEntity(File content)

Creates a new FileEntity builder.

Assumes no content type.

Parameters:

content - The entity content. Can be null.

Returns:

A new FileEntity builder.

fileEntity

public static final FileEntity fileEntity(File content,
 ContentType contentType)

Creates a new FileEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new FileEntity builder.

readerEntity

public static final ReaderEntity readerEntity(Reader content)

Creates a new ReaderEntity builder.

Parameters:

content - The entity content. Can be null.

Returns:

A new ReaderEntity builder.

readerEntity

public static final ReaderEntity readerEntity(Reader content,
 ContentType contentType)

Creates a new ReaderEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new ReaderEntity builder.

serializedEntity

public static final SerializedEntity serializedEntity(Object content,
 Serializer serializer)

Creates a new SerializedEntity object.

Parameters:

content - The Java POJO representing the content.
Can be null.

serializer - The serializer to use to serialize the POJO.
If null, POJO will be converted to a string using Object.toString().

Returns:

A new SerializedEntity object.

serializedEntity

public static final SerializedEntity serializedEntity(Object content,
 Serializer serializer,
 HttpPartSchema schema)

Creates a new SerializedEntity object.

Parameters:

content - The Java POJO representing the content.
Can be null.

serializer - The serializer to use to serialize the POJO.
If null, POJO will be converted to a string using Object.toString().

schema - Optional HTTP-part schema for providing instructionst to the serializer on the format of the entity.

Returns:

A new SerializedEntity object.

serializedEntity

public static final SerializedEntity serializedEntity(Supplier<?> content,
 Serializer serializer)

Creates a new SerializedEntity object.

Parameters:

content - The supplier of a Java POJO representing the content.
Can be null.

serializer - The serializer to use to serialize the POJO.
If null, POJO will be converted to a string using Object.toString().

Returns:

A new SerializedEntity object.

serializedEntity

public static final SerializedEntity serializedEntity(Supplier<?> content,
 Serializer serializer,
 HttpPartSchema schema)

Creates a new SerializedEntity object.

Parameters:

content - The supplier of a Java POJO representing the content.
Can be null.

serializer - The serializer to use to serialize the POJO.
If null, POJO will be converted to a string using Object.toString().

schema - Optional HTTP-part schema for providing instructionst to the serializer on the format of the entity.

Returns:

A new SerializedEntity object.

streamEntity

public static final StreamEntity streamEntity(InputStream content)

Creates a new StreamEntity builder.

Assumes no content type.

Parameters:

content - The entity content. Can be null.

Returns:

A new StreamEntity builder.

streamEntity

public static final StreamEntity streamEntity(InputStream content,
 long length,
 ContentType contentType)

Creates a new StreamEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

length - The content length, or -1 if not known.

Returns:

A new StreamEntity builder.

stringEntity

public static final StringEntity stringEntity(String content)

Creates a new builder for a StringEntity builder.

Parameters:

content - The entity content. Can be null.

Returns:

A new StringEntity builder.

stringEntity

public static final StringEntity stringEntity(String content,
 ContentType contentType)

Creates a new builder for a StringEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new StringEntity builder.

stringEntity

public static final StringEntity stringEntity(Supplier<String> content)

Creates a new builder for a StringEntity builder.

Parameters:

content - The entity content. Can be null.

Returns:

A new StringEntity builder.

stringEntity

public static final StringEntity stringEntity(Supplier<String> content,
 ContentType contentType)

Creates a new builder for a StringEntity builder.

Parameters:

content - The entity content. Can be null.

contentType - The entity content type, or null if not specified.

Returns:

A new StringEntity builder.