Class ServerRequestEntity

java.lang.Object

io.helidon.http.media.ReadableEntityBase

io.helidon.webserver.http.ServerRequestEntity

All Implemented Interfaces:

ReadableEntity

public final class ServerRequestEntity
extends ReadableEntityBase
implements ReadableEntity

Server request 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 ServerRequestEntity	create(Consumer<Boolean> entityRequestedCallback, UnaryOperator<InputStream> streamFilter, ContentDecoder decoder, Function<Integer, BufferData> readEntityFunction, Runnable entityProcessedRunnable, ServerRequestHeaders requestHeaders, MediaContext mediaContext, long maxBufferedEntitySize)	Deprecated. use create(Consumer, UnaryOperator, ContentDecoder, Function, Runnable, ServerRequestHeaders, MediaContext, long, long) instead
static ServerRequestEntity	create(Consumer<Boolean> entityRequestedCallback, UnaryOperator<InputStream> streamFilter, ContentDecoder decoder, Function<Integer, BufferData> readEntityFunction, Runnable entityProcessedRunnable, ServerRequestHeaders requestHeaders, MediaContext mediaContext, long maxPayloadSize, long maxBufferedEntitySize)	Create a new entity.
protected <T> T	entityAs(GenericType<T> type)	Read entity as a specific generic type.
InputStream	inputStream()	Input stream to read bytes of the entity.

Methods inherited from class ReadableEntityBase

as, as, asOptional, asOptional, buffer, consume, consumed, empty, entityProcessedRunnable, hasEntity, 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.
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

@Deprecated(since="4.4.2")
public static ServerRequestEntity create(Consumer<Boolean> entityRequestedCallback,
 UnaryOperator<InputStream> streamFilter,
 ContentDecoder decoder,
 Function<Integer, BufferData> readEntityFunction,
 Runnable entityProcessedRunnable,
 ServerRequestHeaders requestHeaders,
 MediaContext mediaContext,
 long maxBufferedEntitySize)

Deprecated.

use create(Consumer, UnaryOperator, ContentDecoder, Function, Runnable, ServerRequestHeaders, MediaContext, long, long) instead

Create a new entity.

Parameters:

entityRequestedCallback - callback invoked when entity data are requested for the first time

streamFilter - stream filter to apply, provided by user

decoder - content decoder

readEntityFunction - function to read buffer from entity (int is an estimated number of bytes needed, buffer will contain at least 1 byte)

entityProcessedRunnable - runnable to run once the entity is fully read

requestHeaders - request headers

mediaContext - media context to map to correct types

maxBufferedEntitySize - maximum size of a buffered entity

Returns:

a new entity

create

public static ServerRequestEntity create(Consumer<Boolean> entityRequestedCallback,
 UnaryOperator<InputStream> streamFilter,
 ContentDecoder decoder,
 Function<Integer, BufferData> readEntityFunction,
 Runnable entityProcessedRunnable,
 ServerRequestHeaders requestHeaders,
 MediaContext mediaContext,
 long maxPayloadSize,
 long maxBufferedEntitySize)

Create a new entity.

Parameters:

entityRequestedCallback - callback invoked when entity data are requested for the first time

streamFilter - stream filter to apply, provided by user

decoder - content decoder

readEntityFunction - function to read buffer from entity (int is an estimated number of bytes needed, buffer will contain at least 1 byte)

entityProcessedRunnable - runnable to run once the entity is fully read

requestHeaders - request headers

mediaContext - media context to map to correct types

maxPayloadSize - maximum size of a decoded entity

maxBufferedEntitySize - maximum size of a buffered entity

Returns:

a new 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

inputStream

public InputStream inputStream()

Description copied from interface: ReadableEntity

Input stream to read bytes of the entity. Cannot be combined with methods ReadableEntity.as(Class) or ReadableEntity.as(io.helidon.common.GenericType) If there is no entity, returns input stream on empty byte array.

Specified by:

inputStream in interface ReadableEntity

Overrides:

inputStream in class ReadableEntityBase

Returns:

input stream to entity bytes

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