com.yahoo.jdisc.handler

Class FutureResponse

java.lang.Object

com.google.common.util.concurrent.AbstractFuture<Response>

com.yahoo.jdisc.handler.FutureResponse

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<Response>, ResponseHandler, Future<Response>

public final class FutureResponse
extends com.google.common.util.concurrent.AbstractFuture<Response>
implements ResponseHandler

This class provides an implementation of ResponseHandler that allows you to wait for a Response to be returned.

Author:

Simon Thoresen Hult

Constructor Summary

Constructors

Constructor and Description
FutureResponse() Constructs a new FutureResponse that returns a NullContent when handleResponse(Response) is invoked.
FutureResponse(ContentChannel content) Constructs a new FutureResponse that returns the given ContentChannel when handleResponse(Response) is invoked.
FutureResponse(ResponseHandler handler) Constructs a new FutureResponse that calls the given ResponseHandler when handleResponse(Response) is invoked.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
ContentChannel	handleResponse(Response response) This method will process the given Response and return a ContentChannel into which the caller can write the Response's content.
boolean	isCancelled()

Methods inherited from class com.google.common.util.concurrent.AbstractFuture

addListener, get, get, interruptTask, isDone, set, setException, wasInterrupted

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureResponse

public FutureResponse()

Constructs a new FutureResponse that returns a NullContent when handleResponse(Response) is invoked.

FutureResponse

public FutureResponse(ContentChannel content)

Constructs a new FutureResponse that returns the given ContentChannel when handleResponse(Response) is invoked.

Parameters:

content - The content channel for the Response.

FutureResponse

public FutureResponse(ResponseHandler handler)

Constructs a new FutureResponse that calls the given ResponseHandler when handleResponse(Response) is invoked.

Parameters:

handler - The ResponseHandler to invoke.

Method Detail

handleResponse

public ContentChannel handleResponse(Response response)

Description copied from interface: ResponseHandler

This method will process the given Response and return a ContentChannel into which the caller can write the Response's content.

Specified by:

handleResponse in interface ResponseHandler

Parameters:

response - The Response to handle.

Returns:

The ContentChannel to write the Response content to. Notice that the ContentChannel holds a Container reference, so failure to close this will prevent the Container from ever shutting down.

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Response>

Overrides:

cancel in class com.google.common.util.concurrent.AbstractFuture<Response>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface Future<Response>

Overrides:

isCancelled in class com.google.common.util.concurrent.AbstractFuture<Response>