Package io.camunda.client.impl.http

Class TypedApiEntityConsumer.JsonApiEntityConsumer<T>

java.lang.Object

io.camunda.client.impl.http.TypedApiEntityConsumer.JsonApiEntityConsumer<T>

All Implemented Interfaces:

TypedApiEntityConsumer<T>

Enclosing interface:

TypedApiEntityConsumer<T>

public static class TypedApiEntityConsumer.JsonApiEntityConsumer<T>
extends Object
implements TypedApiEntityConsumer<T>

A TypedApiEntityConsumer implementation for handling JSON data. This consumer uses Jackson's non-blocking parser to incrementally parse JSON data as it is streamed.

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.impl.http.TypedApiEntityConsumer

TypedApiEntityConsumer.JsonApiEntityConsumer<T>, TypedApiEntityConsumer.RawApiEntityConsumer<T>

Constructor Summary

Constructors

Constructor	Description
JsonApiEntityConsumer(com.fasterxml.jackson.databind.ObjectMapper json, Class<T> type, boolean isResponse)

Method Summary

Modifier and Type	Method	Description
void	consumeData(ByteBuffer src, boolean endOfStream)	Consumes data from the provided ByteBuffer.
ApiEntity<T>	generateContent()	Generates the final content after all data has been consumed.
int	getBufferedBytes()	Returns the number of bytes currently buffered by this consumer.
void	releaseResources()	Releases any resources associated with this consumer.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonApiEntityConsumer

public JsonApiEntityConsumer(com.fasterxml.jackson.databind.ObjectMapper json,
 Class<T> type,
 boolean isResponse)
                      throws IOException

Throws:

IOException

Method Details

generateContent

public ApiEntity<T> generateContent()
                             throws IOException

Description copied from interface: TypedApiEntityConsumer

Generates the final content after all data has been consumed.

Specified by:

generateContent in interface TypedApiEntityConsumer<T>

Returns:

an ApiEntity containing the deserialized content, or null if no data was consumed

Throws:

IOException

consumeData

public void consumeData(ByteBuffer src,
 boolean endOfStream)
                 throws IOException

Description copied from interface: TypedApiEntityConsumer

Consumes data from the provided ByteBuffer. This method is called as data becomes available and can be invoked multiple times as more data is streamed.

Specified by:

consumeData in interface TypedApiEntityConsumer<T>

Parameters:

src - the ByteBuffer containing the data to be consumed

endOfStream - a flag indicating whether this is the last chunk of data

Throws:

IOException

releaseResources

public void releaseResources()

Description copied from interface: TypedApiEntityConsumer

Releases any resources associated with this consumer. This method should be called once the consumer is no longer needed, such as after the response has been fully processed.

Specified by:

releaseResources in interface TypedApiEntityConsumer<T>

getBufferedBytes

public int getBufferedBytes()

Description copied from interface: TypedApiEntityConsumer

Returns the number of bytes currently buffered by this consumer.

Specified by:

getBufferedBytes in interface TypedApiEntityConsumer<T>

Returns:

the number of buffered bytes