Package org.apache.hc.client5.http.async.methods

Class DeflatingBrotliEntityProducer

java.lang.Object

org.apache.hc.client5.http.async.methods.DeflatingBrotliEntityProducer

All Implemented Interfaces:

org.apache.hc.core5.http.EntityDetails, org.apache.hc.core5.http.nio.AsyncDataProducer, org.apache.hc.core5.http.nio.AsyncEntityProducer, org.apache.hc.core5.http.nio.ResourceHolder

public final class DeflatingBrotliEntityProducer
extends java.lang.Object
implements org.apache.hc.core5.http.nio.AsyncEntityProducer

AsyncEntityProducer that Brotli-compresses bytes from an upstream producer on the fly and writes the compressed stream to the target DataStreamChannel.

Purely async/streaming: no InputStream/OutputStream. Back-pressure is honored via available() and the I/O reactor’s calls into produce(DataStreamChannel). Trailers from the upstream producer are preserved and emitted once the compressed output has been fully drained.

Content metadata

Returns Content-Encoding: br, Content-Length: -1 and chunked=true. Repeatability matches the upstream producer.

Implementation notes

Uses Brotli4j’s EncoderJNI.Wrapper. JNI-owned output buffers are written directly when possible; if the channel applies back-pressure, the unwritten tail is copied into small pooled direct ByteBuffers to reduce allocation churn. Native resources are released in releaseResources().

Ensure Brotli4jLoader.ensureAvailability() has been called once at startup; this class also invokes it in a static initializer as a safeguard.

Since:

5.6

See Also:

AsyncEntityProducer, DataStreamChannel, EncoderJNI

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DeflatingBrotliEntityProducer.State

Field Summary

Fields

Modifier and Type	Field	Description
private com.aayushatharva.brotli4j.encoder.EncoderJNI.Wrapper	encoder
private java.nio.ByteBuffer	pendingOut
private java.util.List<? extends org.apache.hc.core5.http.Header>	pendingTrailers
private DeflatingBrotliEntityProducer.State	state
private org.apache.hc.core5.http.nio.AsyncEntityProducer	upstream

Constructor Summary

Constructors

Constructor	Description
DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream)	Create a producer with sensible defaults (quality=5, lgwin=22, GENERIC).
DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream, int quality, int lgwin, int modeInt)	Convenience constructor mapping 0=GENERIC, 1=TEXT, 2=FONT.
DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream, int quality, int lgwin, com.aayushatharva.brotli4j.encoder.Encoder.Mode mode)	Create a producer with explicit Brotli params.

Method Summary

Modifier and Type	Method	Description
int	available()
private boolean	drainEncoder(org.apache.hc.core5.http.nio.DataStreamChannel channel)
void	failed(java.lang.Exception cause)
private boolean	flushPending(org.apache.hc.core5.http.nio.DataStreamChannel channel)
java.lang.String	getContentEncoding()
long	getContentLength()
java.lang.String	getContentType()
java.util.Set<java.lang.String>	getTrailerNames()
boolean	isChunked()
boolean	isRepeatable()
void	produce(org.apache.hc.core5.http.nio.DataStreamChannel channel)
void	releaseResources()

Methods inherited from class java.lang.Object

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

Field Detail

upstream

private final org.apache.hc.core5.http.nio.AsyncEntityProducer upstream

encoder

private final com.aayushatharva.brotli4j.encoder.EncoderJNI.Wrapper encoder

pendingOut

private java.nio.ByteBuffer pendingOut

pendingTrailers

private java.util.List<? extends org.apache.hc.core5.http.Header> pendingTrailers

state

private DeflatingBrotliEntityProducer.State state

Constructor Detail

DeflatingBrotliEntityProducer

public DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream,
                                     int quality,
                                     int lgwin,
                                     com.aayushatharva.brotli4j.encoder.Encoder.Mode mode)
                              throws java.io.IOException

Create a producer with explicit Brotli params.

Parameters:

upstream - upstream entity producer whose bytes will be compressed

quality - Brotli quality level (see brotli4j documentation)

lgwin - Brotli window size log2 (see brotli4j documentation)

mode - Brotli mode hint (GENERIC/TEXT/FONT)

Throws:

java.io.IOException - if the native encoder cannot be created

Since:

5.6

DeflatingBrotliEntityProducer

public DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream,
                                     int quality,
                                     int lgwin,
                                     int modeInt)
                              throws java.io.IOException

Convenience constructor mapping 0=GENERIC, 1=TEXT, 2=FONT.

Throws:

java.io.IOException

Since:

5.6

DeflatingBrotliEntityProducer

public DeflatingBrotliEntityProducer(org.apache.hc.core5.http.nio.AsyncEntityProducer upstream)
                              throws java.io.IOException

Create a producer with sensible defaults (quality=5, lgwin=22, GENERIC).

Throws:

java.io.IOException

Since:

5.6

Method Detail

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface org.apache.hc.core5.http.EntityDetails

getContentEncoding

public java.lang.String getContentEncoding()

Specified by:

getContentEncoding in interface org.apache.hc.core5.http.EntityDetails

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface org.apache.hc.core5.http.EntityDetails

isChunked

public boolean isChunked()

Specified by:

isChunked in interface org.apache.hc.core5.http.EntityDetails

getTrailerNames

public java.util.Set<java.lang.String> getTrailerNames()

Specified by:

getTrailerNames in interface org.apache.hc.core5.http.EntityDetails

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface org.apache.hc.core5.http.nio.AsyncEntityProducer

available

public int available()

Specified by:

available in interface org.apache.hc.core5.http.nio.AsyncDataProducer

produce

public void produce(org.apache.hc.core5.http.nio.DataStreamChannel channel)
             throws java.io.IOException

Specified by:

produce in interface org.apache.hc.core5.http.nio.AsyncDataProducer

Throws:

java.io.IOException

failed

public void failed(java.lang.Exception cause)

Specified by:

failed in interface org.apache.hc.core5.http.nio.AsyncEntityProducer

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface org.apache.hc.core5.http.nio.ResourceHolder

flushPending

private boolean flushPending(org.apache.hc.core5.http.nio.DataStreamChannel channel)
                      throws java.io.IOException

Throws:

java.io.IOException

drainEncoder

private boolean drainEncoder(org.apache.hc.core5.http.nio.DataStreamChannel channel)
                      throws java.io.IOException

Throws:

java.io.IOException