Class PathResponseListener

java.lang.Object

java.util.concurrent.CompletableFuture<PathResponseListener.PathResponse>

org.eclipse.jetty.client.PathResponseListener

All Implemented Interfaces:

CompletionStage<PathResponseListener.PathResponse>, Future<PathResponseListener.PathResponse>, EventListener, Response.AsyncContentListener, Response.BeginListener, Response.CompleteListener, Response.ContentListener, Response.ContentSourceListener, Response.FailureListener, Response.HeaderListener, Response.HeadersListener, Response.Listener, Response.ResponseListener, Response.SuccessListener

public class PathResponseListener
extends CompletableFuture<PathResponseListener.PathResponse>
implements Response.Listener

Implementation of Response.ContentListener that saves the response content to a file Path, like curl <url> -o file.bin does.

Typical usage is:

// Typical usage.
httpClient.newRequest(host, port)
    .send(new PathResponseListener(Path.of("/tmp/file.bin")), overwriteExistingFile);

// Alternative usage.
var request = httpClient.newRequest(host, port);
CompletableFuture<PathResponse> completable = PathResponseListener.write(request, Path.of("/tmp/file.bin"), overwriteExistingFile);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PathResponseListener.PathResponse

Nested classes/interfaces inherited from class CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Nested classes/interfaces inherited from interface Future

Future.State

Constructor Summary

Constructors

Constructor	Description
PathResponseListener(Path path, boolean overwrite)

Method Summary

Modifier and Type	Method	Description
void	onComplete(Result result)	Callback method invoked when the request and the response have been processed, either successfully or not.
void	onContent(Response response, ByteBuffer content)	Callback method invoked when the response content has been received, parsed and there is demand.
void	onFailure(Response response, Throwable failure)	Callback method invoked when the response has failed in the process of being received
void	onHeaders(Response response)	Callback method invoked when all the response headers have been received and parsed.
void	onSuccess(Response response)	Callback method invoked when the whole response has been successfully received.
static CompletableFuture<PathResponseListener.PathResponse>	write(Request request, Path path, boolean overwrite)	Writes the response content to the given file Path.

Methods inherited from class CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, exceptionNow, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, resultNow, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, state, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class Object

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

Methods inherited from interface Response.AsyncContentListener

onContentSource

Methods inherited from interface Response.ContentListener

onContent

Methods inherited from interface Response.Listener

onBegin, onHeader

Constructor Details

PathResponseListener

public PathResponseListener(Path path,
 boolean overwrite)
                     throws IOException

Throws:

IOException

Method Details

onHeaders

public void onHeaders(Response response)

Description copied from interface: Response.HeadersListener

Callback method invoked when all the response headers have been received and parsed.

Specified by:

onHeaders in interface Response.HeadersListener

Specified by:

onHeaders in interface Response.Listener

Parameters:

response - the response containing the response line data and the headers

onContent

public void onContent(Response response,
 ByteBuffer content)

Description copied from interface: Response.ContentListener

Callback method invoked when the response content has been received, parsed and there is demand. This method may be invoked multiple times, and the content buffer must be consumed (or copied) before returning from this method. This method is also always invoked when content arrives as demand is automatically registered on return.

Specified by:

onContent in interface Response.ContentListener

Specified by:

onContent in interface Response.Listener

Parameters:

response - the response containing the response line data and the headers

content - the content bytes received

onSuccess

public void onSuccess(Response response)

Description copied from interface: Response.SuccessListener

Callback method invoked when the whole response has been successfully received.

Specified by:

onSuccess in interface Response.Listener

Specified by:

onSuccess in interface Response.SuccessListener

Parameters:

response - the response containing the response line data and the headers

onFailure

public void onFailure(Response response,
 Throwable failure)

Description copied from interface: Response.FailureListener

Callback method invoked when the response has failed in the process of being received

Specified by:

onFailure in interface Response.FailureListener

Specified by:

onFailure in interface Response.Listener

Parameters:

response - the response containing data up to the point the failure happened

failure - the failure happened

onComplete

public void onComplete(Result result)

Description copied from interface: Response.CompleteListener

Callback method invoked when the request and the response have been processed, either successfully or not.

The result parameter contains the request, the response, and eventual failures.

Requests may complete after response, for example in case of big uploads that are discarded or read asynchronously by the server. This method is always invoked after Response.SuccessListener.onSuccess(Response) or Response.FailureListener.onFailure(Response, Throwable), and only when request indicates that it is completed.

Specified by:

onComplete in interface Response.CompleteListener

Specified by:

onComplete in interface Response.Listener

Parameters:

result - the result of the request / response exchange

write

public static CompletableFuture<PathResponseListener.PathResponse> write(Request request,
 Path path,
 boolean overwrite)

Writes the response content to the given file Path.

Parameters:

request - the HTTP request

path - the path to write the response content to

overwrite - whether to overwrite an existing file

Returns:

a CompletableFuture that is completed when the exchange completes