Package org.glassfish.jersey.server

Class ApplicationHandler.FutureResponseWriter

java.lang.Object

java.util.concurrent.CompletableFuture<ContainerResponse>

org.glassfish.jersey.server.ApplicationHandler.FutureResponseWriter

All Implemented Interfaces:

CompletionStage<ContainerResponse>, Future<ContainerResponse>, ContainerResponseWriter

Enclosing class:

ApplicationHandler

private static class ApplicationHandler.FutureResponseWriter
extends CompletableFuture<ContainerResponse>
implements ContainerResponseWriter

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Nested classes/interfaces inherited from interface org.glassfish.jersey.server.spi.ContainerResponseWriter

ContainerResponseWriter.TimeoutHandler

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
private final OutputStream	outputStream
private final String	requestMethodName
private final JerseyRequestTimeoutHandler	requestTimeoutHandler
private ContainerResponse	response

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FutureResponseWriter(String requestMethodName, OutputStream outputStream, ScheduledExecutorService backgroundScheduler)

Method Summary

Modifier and Type	Method	Description
void	commit()	Commit the response invalid input: '&' close the container response writer.
boolean	enableResponseBuffering()	Return true if the entity buffering should be enabled in Jersey.
void	failure(Throwable error)	Propagate an unhandled error to the I/O container.
void	setSuspendTimeout(long time, TimeUnit unit)	Set the suspend timeout.
boolean	suspend(long time, TimeUnit unit, ContainerResponseWriter.TimeoutHandler handler)	Suspend the request/response processing.
OutputStream	writeResponseStatusAndHeaders(long contentLength, ContainerResponse response)	Write the status and headers of the response and return an output stream for the web application to write the entity of the response.

Methods inherited from class java.util.concurrent.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 java.lang.Object

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

Field Details

response

private ContainerResponse response

requestMethodName

private final String requestMethodName

outputStream

private final OutputStream outputStream

requestTimeoutHandler

private final JerseyRequestTimeoutHandler requestTimeoutHandler

Constructor Details

FutureResponseWriter

private FutureResponseWriter(String requestMethodName,
 OutputStream outputStream,
 ScheduledExecutorService backgroundScheduler)

Method Details

writeResponseStatusAndHeaders

public OutputStream writeResponseStatusAndHeaders(long contentLength,
 ContainerResponse response)

Description copied from interface: ContainerResponseWriter

Write the status and headers of the response and return an output stream for the web application to write the entity of the response.

If the response content length is declared to be greater or equal to 0, it means that the content length in bytes of the entity to be written is known, otherwise -1. I/O containers may use this value to determine whether the "Content-Length" header can be set or utilize chunked transfer encoding.

Specified by:

writeResponseStatusAndHeaders in interface ContainerResponseWriter

Parameters:

contentLength - greater or equal to 0 if the content length in bytes of the entity to be written is known, otherwise -1. Containers may use this value to determine whether the "Content-Length" header can be set or utilize chunked transfer encoding.

response - the JAX-RS response to be written. The status and headers are obtained from the response.

Returns:

the output stream to write the entity (if any).

suspend

public boolean suspend(long time,
 TimeUnit unit,
 ContainerResponseWriter.TimeoutHandler handler)

Description copied from interface: ContainerResponseWriter

Suspend the request/response processing. The method returns true to indicate the response writer was suspended successfully. In case the provider has already been suspended earlier, the method returns false.

I/O container must not automatically commit the response writer when the processing on the I/O container thread is finished and the thread is released. Instead, the Jersey runtime will make sure to manually close the container response writer instance by explicitly calling the ContainerResponseWriter.commit() or ContainerResponseWriter.failure(Throwable) method at some later point in time.

Once suspended, the specified suspend timeout can be further updated using ContainerResponseWriter.setSuspendTimeout(long, java.util.concurrent.TimeUnit) method.

Specified by:

suspend in interface ContainerResponseWriter

Parameters:

time - time-out value. Value less or equal to 0, indicates that the processing is suspended indefinitely.

unit - time-out time unit.

handler - time-out handler to process a time-out event if it occurs.

Returns:

true if the suspend operation completed successfully, false otherwise.

See Also:

• ContainerResponseWriter.setSuspendTimeout(long, TimeUnit)
• ContainerResponseWriter.commit()

setSuspendTimeout

public void setSuspendTimeout(long time,
 TimeUnit unit)

Description copied from interface: ContainerResponseWriter

Set the suspend timeout. Once the container response writer is suspended, the suspend timeout value can be further updated by the method.

Specified by:

setSuspendTimeout in interface ContainerResponseWriter

Parameters:

time - time-out value. Value less or equal to 0, indicates that the processing is suspended indefinitely.

unit - time-out time unit.

commit

public void commit()

Description copied from interface: ContainerResponseWriter

Commit the response invalid input: '&' close the container response writer. Indicates to the I/O container that request has been fully processed and response has been fully written. This signals the I/O container to finish the request/response processing, clean up any state, flush any streams, release resources etc.

Specified by:

commit in interface ContainerResponseWriter

See Also:

• ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler)
• ContainerResponseWriter.failure(Throwable)

failure

public void failure(Throwable error)

Description copied from interface: ContainerResponseWriter

Propagate an unhandled error to the I/O container. Indicates to the I/O container that the request processing has finished with an error that could not be processed by the Jersey runtime. The I/O container is expected to process the exception in a container-specific way. This method also signals the I/O container to finish the request/response processing, clean up any state, flush any streams, release resources etc.

Specified by:

failure in interface ContainerResponseWriter

Parameters:

error - unhandled request processing error.

See Also:

• ContainerResponseWriter.suspend(long, TimeUnit, TimeoutHandler)
• ContainerResponseWriter.commit()

enableResponseBuffering

public boolean enableResponseBuffering()

Description copied from interface: ContainerResponseWriter

Return true if the entity buffering should be enabled in Jersey. If enabled, the outbound entity is buffered by Jersey runtime up to a configured amount of bytes prior to being written to the output stream to determine its size that may be used to set the value of HTTP "Content-Length" header.

Containers that provide it's own solution for determining the message payload size may decide to return false to prevent Jersey from buffering message entities unnecessarily.

Specified by:

enableResponseBuffering in interface ContainerResponseWriter

Returns:

true to enable entity buffering to be done by Jersey runtime, false otherwise.