Module org.mule.sdk.api

Package org.mule.sdk.api.http.domain.entity

Interface FeedableHttpEntity

All Superinterfaces:

HttpEntity

@MinMuleVersion("4.11.0")
public interface FeedableHttpEntity
extends HttpEntity

An object that can be fed after it was created. Implementers can leverage it for non-blocking streaming and for trailers sending.

 
 Feedable feedable = new FeedableImpl();
 feedable.feed(firstFragment);
 feedable.feed(secondFragment);
 feedable.feed(thirdFragment);
 feedable.complete();
 
 

Since:

0.13

Method Summary

Modifier and Type	Method	Description
default void	complete()	After feed(java.nio.ByteBuffer)ing all the data fragments, user must complete the entity by calling this method or completeWithTrailers(org.mule.runtime.api.util.MultiMap<java.lang.String, java.lang.String>).
void	completeWithTrailers(org.mule.runtime.api.util.MultiMap<String,String> trailers)	After feed(java.nio.ByteBuffer)ing all the data fragments, user must complete the entity by calling this method or complete().
void	error(Exception exception)	Signals the entity with an error.
void	feed(ByteBuffer data)	Writes a fragment of the body to this entity abstraction.

Methods inherited from interface org.mule.sdk.api.http.domain.entity.HttpEntity

getBytes, getBytesLength, getContent, isReactive, isStreaming, onComplete, onData

Method Details

feed

void feed(ByteBuffer data)
   throws IOException

Writes a fragment of the body to this entity abstraction.

Parameters:

data - buffer containing the data.

Throws:

IOException - if an error occurs while writing the data. For example, when the entity was already completed, both normally or with an error.

error

void error(Exception exception)

Signals the entity with an error. If this method is called instead of completing normally (with complete()), implementors may discard the previously fed data. Future calls to feed(ByteBuffer) must fail.

Parameters:

exception - the error.

Throws:

IllegalStateException - if called after it was already completed, both normally or with an error.

complete

default void complete()
               throws IOException

After feed(java.nio.ByteBuffer)ing all the data fragments, user must complete the entity by calling this method or completeWithTrailers(org.mule.runtime.api.util.MultiMap<java.lang.String, java.lang.String>).

Throws:

IOException - if an error occurs during the completion of the entity.

IllegalStateException - if called after it was already completed, both normally or with an error.

completeWithTrailers

void completeWithTrailers(org.mule.runtime.api.util.MultiMap<String,String> trailers)
                   throws IOException

After feed(java.nio.ByteBuffer)ing all the data fragments, user must complete the entity by calling this method or complete().

Parameters:

trailers - the trailers.

Throws:

IOException - if an error occurs during the completion of the entity.

IllegalStateException - if called after it was already completed, both normally or with an error.