Class ClientResponseEntity

java.lang.Object

io.helidon.http.media.ReadableEntityBase

io.helidon.webclient.api.ClientResponseEntity

All Implemented Interfaces:

ReadableEntity

public final class ClientResponseEntity
extends ReadableEntityBase
implements ReadableEntity

Client response entity.

Method Summary

Modifier and Type	Method	Description
ReadableEntity	copy(Runnable entityProcessedRunnable)	Copy this entity and add a new runnable to be executed after this entity is consumed.
static ClientResponseEntity	create(Function<Integer, BufferData> readEntityFunction, Runnable entityProcessedRunnable, ClientRequestHeaders requestHeaders, ClientResponseHeaders responseHeaders, MediaContext mediaContext, long maxBufferedEntitySize)	Create a new client response entity.
protected <T> T	entityAs(GenericType<T> type)	Read entity as a specific generic type.

Methods inherited from class ReadableEntityBase

as, as, asOptional, asOptional, buffer, consume, consumed, empty, entityProcessedRunnable, hasEntity, inputStream, maxBufferedEntitySize, readAllBytes, readEntityFunction

Modifier and Type	Method	Description
final <T> T	as(GenericType<T> type)	Get the entity as a specific type.
<T> T	as(Class<T> type)	Get the entity as a specific class.
<T> Optional<T>	asOptional(GenericType<T> type)	Get the entity as a specific type (optional).
<T> Optional<T>	asOptional(Class<T> type)	Get the entity as a specific class (optional).
void	buffer()	If called before ReadableEntity.inputStream(), it will buffer the entity and support multiple calls to ReadableEntity.inputStream() after that.
void	consume()	Consume the entity if not yet consumed.
boolean	consumed()	Whether this entity has been consumed already.
static ReadableEntity	empty()	Create a new empty readable entity (when there is no entity).
protected Runnable	entityProcessedRunnable()	Runnable to run once the entity is fully consumed.
boolean	hasEntity()	Whether an entity actually exists.
InputStream	inputStream()	Input stream to read bytes of the entity.
protected long	maxBufferedEntitySize()	Max entity length of a bufferable entity.
protected byte[]	readAllBytes()	Read all bytes of the entity into memory.
protected Function<Integer, BufferData>	readEntityFunction()	Function to request entity bytes.

Methods inherited from class Object

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

Method Details

create

public static ClientResponseEntity create(Function<Integer, BufferData> readEntityFunction,
 Runnable entityProcessedRunnable,
 ClientRequestHeaders requestHeaders,
 ClientResponseHeaders responseHeaders,
 MediaContext mediaContext,
 long maxBufferedEntitySize)

Create a new client response entity.

Parameters:

readEntityFunction - function to read bytes from entity based on suggested buffer length

entityProcessedRunnable - runnable to run when entity processing finishes

requestHeaders - request headers

responseHeaders - response headers

mediaContext - media context to read into specific types

maxBufferedEntitySize - maximum size of a buffered entity

Returns:

client response entity

copy

public ReadableEntity copy(Runnable entityProcessedRunnable)

Description copied from interface: ReadableEntity

Copy this entity and add a new runnable to be executed after this entity is consumed.

Specified by:

copy in interface ReadableEntity

Parameters:

entityProcessedRunnable - runnable to execute on consumed entity

Returns:

a new entity delegating to this entity

entityAs

protected <T> T entityAs(GenericType<T> type)

Description copied from class: ReadableEntityBase

Read entity as a specific generic type.

Specified by:

entityAs in class ReadableEntityBase

Type Parameters:

T - type of the entity

Parameters:

type - type the entity should be coerced into

Returns:

entity value