org.mule.runtime.http.api.domain.entity

Class InputStreamHttpEntity

java.lang.Object

org.mule.runtime.http.api.domain.entity.InputStreamHttpEntity

All Implemented Interfaces:

HttpEntity

@NoExtend
public class InputStreamHttpEntity
extends Object
implements HttpEntity

Representation of a stream HTTP body.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
InputStreamHttpEntity(InputStream inputStream)
InputStreamHttpEntity(InputStream inputStream, Long contentLength)

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Provides the entity's content as bytes.
InputStream	getContent() Provides the entity's content as a stream.
Optional<Long>	getLength() Provides the length (in bytes) of the HttpEntity, if known.
Collection<HttpPart>	getParts() Provides the entity's content parts.
boolean	isComposed() Tells whether or not this entity is composed of several parts, in which case they should be available through HttpEntity.getParts().
boolean	isStreaming() Tells whether this entity's content is stream based.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamHttpEntity

public InputStreamHttpEntity(InputStream inputStream)

InputStreamHttpEntity

public InputStreamHttpEntity(InputStream inputStream,
                             Long contentLength)

Method Detail

isStreaming

public boolean isStreaming()

Description copied from interface: HttpEntity

Tells whether this entity's content is stream based. Streamed entities can only provide their content once, regardless of the access method.

Specified by:

isStreaming in interface HttpEntity

Returns:

true if content is streamed, false otherwise

See Also:

HttpEntity.getContent()

isComposed

public boolean isComposed()

Description copied from interface: HttpEntity

Tells whether or not this entity is composed of several parts, in which case they should be available through HttpEntity.getParts().

Specified by:

isComposed in interface HttpEntity

Returns:

true if there are several content parts, false otherwise

getContent

public InputStream getContent()

Description copied from interface: HttpEntity

Provides the entity's content as a stream. All streaming entities should provide their stream.

Specified by:

getContent in interface HttpEntity

Returns:

an InputStream representing this entity's content or null if such representation is not possible

getBytes

public byte[] getBytes()
                throws IOException

Description copied from interface: HttpEntity

Provides the entity's content as bytes. If the entity is stream based, then the stream will be consumed as a consequence.

Specified by:

getBytes in interface HttpEntity

Returns:

a byte array representing this entity's content or null if such representation is not possible

Throws:

IOException - if an error occurs creating the byte array

getParts

public Collection<HttpPart> getParts()

Description copied from interface: HttpEntity

Provides the entity's content parts. If the entity is stream based, then the stream will be consumed as a consequence. Non composed entities should return an empty collection.

Specified by:

getParts in interface HttpEntity

Returns:

a collection of HttpParts representing this entity's content parts, if present

See Also:

HttpEntity.isComposed()

getLength

public Optional<Long> getLength()

Description copied from interface: HttpEntity

Provides the length (in bytes) of the HttpEntity, if known. For the most part, only received entities from HTTP messages that carried a 'Content-Length' header will return a length.

Specified by:

getLength in interface HttpEntity

Returns:

an Optional with the length (in bytes) or an empty one if unknown