Package io.micronaut.http.netty.body

Class NettyByteBodyFactory

java.lang.Object

io.micronaut.http.body.ByteBodyFactory

io.micronaut.http.netty.body.NettyByteBodyFactory

@Internal
public final class NettyByteBodyFactory
extends ByteBodyFactory

ByteBodyFactory implementation with netty-optimized bodies.

Since:

4.8.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Constructor	Description
NettyByteBodyFactory(@NonNull io.netty.channel.Channel channel)

Method Summary

Modifier and Type	Method	Description
@NonNull CloseableAvailableByteBody	adapt(byte @NonNull [] array)	Create a new CloseableAvailableByteBody from the given array.
@NonNull CloseableAvailableByteBody	adapt(@NonNull ByteBuffer<?> buffer)	Create a new CloseableAvailableByteBody from the given buffer.
<T extends Throwable> @NonNull CloseableAvailableByteBody	buffer(@NonNull ThrowingConsumer<? super OutputStream,T> writer)	Buffer any data written to an OutputStream and return it as a ByteBody.
@NonNull CloseableAvailableByteBody	copyOf(@NonNull InputStream stream)	Copy the data of the given InputStream into an available ByteBody.
@NonNull CloseableAvailableByteBody	copyOf(@NonNull CharSequence cs, @NonNull Charset charset)	Encode the given CharSequence and create a ByteBody from it.
@NonNull CloseableAvailableByteBody	createEmpty()	Create an empty body.

Methods inherited from class io.micronaut.http.body.ByteBodyFactory

byteBufferFactory, createDefault

Methods inherited from class java.lang.Object

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

Constructor Details

NettyByteBodyFactory

public NettyByteBodyFactory(@NonNull
 @NonNull io.netty.channel.Channel channel)

Method Details

adapt

@NonNull
public @NonNull CloseableAvailableByteBody adapt(@NonNull
 @NonNull ByteBuffer<?> buffer)

Description copied from class: ByteBodyFactory

Create a new CloseableAvailableByteBody from the given buffer. Ownership of the buffer is transferred to this method; the original buffer may be copied or used as-is depending on implementation. If the buffer is ReferenceCounted, release ownership is also transferred to this method.

Overrides:

adapt in class ByteBodyFactory

Parameters:

buffer - The buffer

Returns:

A ByteBody with the same content as the buffer

adapt

@NonNull
public @NonNull CloseableAvailableByteBody adapt(byte @NonNull [] array)

Description copied from class: ByteBodyFactory

Create a new CloseableAvailableByteBody from the given array. Ownership of the array is transferred to this method; the array may be copied or used as-is, so do not modify the array after passing it to this method.

Overrides:

adapt in class ByteBodyFactory

Parameters:

array - The array

Returns:

A ByteBody with the same content as the array

buffer

@NonNull
public <T extends Throwable>
@NonNull CloseableAvailableByteBody buffer(@NonNull
 @NonNull ThrowingConsumer<? super OutputStream,T> writer)
                                    throws T

Description copied from class: ByteBodyFactory

Buffer any data written to an OutputStream and return it as a ByteBody.

Overrides:

buffer in class ByteBodyFactory

Type Parameters:

T - Exception type thrown by the consumer

Parameters:

writer - The function that will write to the OutputStream

Returns:

The data written to the stream

Throws:

T - Exception thrown by the consumer

createEmpty

@NonNull
public @NonNull CloseableAvailableByteBody createEmpty()

Description copied from class: ByteBodyFactory

Create an empty body.

Overrides:

createEmpty in class ByteBodyFactory

Returns:

The empty body

copyOf

@NonNull
public @NonNull CloseableAvailableByteBody copyOf(@NonNull
 @NonNull CharSequence cs,
 @NonNull
 @NonNull Charset charset)

Description copied from class: ByteBodyFactory

Encode the given CharSequence and create a ByteBody from it.

Overrides:

copyOf in class ByteBodyFactory

Parameters:

cs - The input string

charset - The charset to use for encoding

Returns:

The encoded body

copyOf

@NonNull
public @NonNull CloseableAvailableByteBody copyOf(@NonNull
 @NonNull InputStream stream)
                                           throws IOException

Description copied from class: ByteBodyFactory

Copy the data of the given InputStream into an available ByteBody. If the input is blocking, this method will also block.

Overrides:

copyOf in class ByteBodyFactory

Parameters:

stream - The input to copy

Returns:

A body containing the data read from the input

Throws:

IOException - Any exception thrown by the InputStream read methods