java.net.httpclient

Interface HttpRequest.BodyProcessor

Enclosing class:

HttpRequest

public static interface HttpRequest.BodyProcessor

A request processor which obtains the request body from some source. Implementations of this interface are provided which allow request bodies to be supplied from standard types, such as String, byte[], File, InputStream. Other implementations can be provided.

The methods of this interface may be called from multiple threads, but only one method is invoked at a time, and behaves as if called from one thread.

See HttpRequest for implementations that take request bodies from byte arrays, Strings, Paths etc.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
default void	onComplete() Called when the request body has been completely sent.
java.nio.ByteBuffer	onRequestBodyChunk(java.nio.ByteBuffer buffer) Called multiple times to send request body data.
default void	onRequestError(java.lang.Throwable t) Called if sending a request body fails.
long	onRequestStart(HttpRequest hr) Called before a request is sent.

Method Detail

onRequestStart

long onRequestStart(HttpRequest hr)
             throws java.io.IOException

Called before a request is sent. Is expected to return the content length of the request body. Zero means no content. Less than zero means an unknown positive content-length, and the body will be streamed.

Parameters:

hr - the request being sent

Returns:

request body content length

Throws:

java.io.IOException - if the request cannot be sent.

onRequestError

default void onRequestError(java.lang.Throwable t)

Called if sending a request body fails.

Parameters:

t - the Throwable that caused the failure

onRequestBodyChunk

java.nio.ByteBuffer onRequestBodyChunk(java.nio.ByteBuffer buffer)
                                throws java.io.IOException

Called multiple times to send request body data. The implementation must put the data to be sent into the provided buffer or else allocate its own buffer and put the data in that. In all cases, the returned buffer is the one used to write the data (from the buffer's position to its limit). When the processor has finished supplying data it must return null. If an exact content length was provided in onRequestStart(), then that number of bytes must be provided. Otherwise, the request will fail.

Parameters:

buffer - a ByteBuffer to write data into

Returns:

the ByteBuffer that actually contains the written data

Throws:

java.io.IOException - in case of I/O error

onComplete

default void onComplete()

Called when the request body has been completely sent.