Package com.yahoo.container.jdisc

Class ThreadedHttpRequestHandler

java.lang.Object

com.yahoo.jdisc.AbstractResource

com.yahoo.jdisc.handler.AbstractRequestHandler

com.yahoo.container.jdisc.ThreadedRequestHandler

com.yahoo.container.jdisc.ThreadedHttpRequestHandler

All Implemented Interfaces:

HttpRequestHandler, RequestHandler, SharedResource

Direct Known Subclasses:

AccessLogRequestHandler, FilterBackingRequestHandler, HttpHandlerBase, LoggingRequestHandler, LogHandler, RestApiRequestHandler, VipStatusHandler

public abstract class ThreadedHttpRequestHandler
extends ThreadedRequestHandler
implements HttpRequestHandler

A simple HTTP request handler, using the HttpRequest and HttpResponse classes. Users need to override the handle(HttpRequest) method in this class and the HttpResponse.render(java.io.OutputStream) method.

Author:

hmusum, Steinar Knutsen, bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThreadedHttpRequestHandler.Context
static class	ThreadedHttpRequestHandler.LazyContentChannel	A content channel which will return the header and create the proper channel the first time content data needs to be written to it.

Nested classes/interfaces inherited from interface com.yahoo.jdisc.SharedResource

SharedResource.Debug

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
protected final Logger	log	Logger for subclasses

Fields inherited from class com.yahoo.container.jdisc.ThreadedRequestHandler

metric, metricUtil

Fields inherited from interface com.yahoo.jdisc.SharedResource

DEBUG, SYSTEM_PROPERTY_NAME_DEBUG

Constructor Summary

Constructors

Constructor	Description
ThreadedHttpRequestHandler(ContainerThreadPool pool, Metric metric)
ThreadedHttpRequestHandler(ThreadedHttpRequestHandler.Context context)
ThreadedHttpRequestHandler(Executor executor)
ThreadedHttpRequestHandler(Executor executor, Metric metric)
ThreadedHttpRequestHandler(Executor executor, Metric metric, boolean allowAsyncResponse)

Method Summary

Modifier and Type	Method	Description
protected void	addDateHeader(HttpResponse httpResponse, long startTime)
protected HttpRequest	asHttpRequest(Request request)
protected LoggingCompletionHandler	createLoggingCompletionHandler(long startTime, long renderStartTime, HttpResponse response, HttpRequest httpRequest, ContentChannelOutputStream rendererWiring)	Override this to implement custom access logging.
abstract HttpResponse	handle(HttpRequest request)	Override this to implement a synchronous style handler.
HttpResponse	handle(HttpRequest request, ContentChannel channel)	Override this rather than handle(request) to be able to write to the channel before returning from this method.
final void	handleRequest(Request request, BufferedContentChannel requestContent, ResponseHandler responseHandler)
static ThreadedHttpRequestHandler.Context	testContext()

Methods inherited from class com.yahoo.container.jdisc.ThreadedRequestHandler

executor, getRequestType, getTimeout, handleRequest, writeErrorResponseOnOverload

Methods inherited from class com.yahoo.jdisc.handler.AbstractRequestHandler

handleTimeout

Methods inherited from class com.yahoo.jdisc.AbstractResource

currentState, destroy, refer, refer, release, retainCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.container.jdisc.HttpRequestHandler

requestHandlerSpec

Methods inherited from interface com.yahoo.jdisc.handler.RequestHandler

handleRequest, handleTimeout

Methods inherited from interface com.yahoo.jdisc.SharedResource

refer, refer, release

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

log

protected final Logger log

Logger for subclasses

Constructor Details

ThreadedHttpRequestHandler

public ThreadedHttpRequestHandler(Executor executor)

ThreadedHttpRequestHandler

public ThreadedHttpRequestHandler(Executor executor,
 Metric metric)

ThreadedHttpRequestHandler

@Inject
public ThreadedHttpRequestHandler(ContainerThreadPool pool,
 Metric metric)

ThreadedHttpRequestHandler

public ThreadedHttpRequestHandler(ThreadedHttpRequestHandler.Context context)

ThreadedHttpRequestHandler

public ThreadedHttpRequestHandler(Executor executor,
 Metric metric,
 boolean allowAsyncResponse)

Method Details

handle

public abstract HttpResponse handle(HttpRequest request)

Override this to implement a synchronous style handler.

Parameters:

request - incoming HTTP request

Returns:

a valid HTTP response for presentation to the user

handle

public HttpResponse handle(HttpRequest request,
 ContentChannel channel)

Override this rather than handle(request) to be able to write to the channel before returning from this method. This default implementation calls handle(request)

handleRequest

public final void handleRequest(Request request,
 BufferedContentChannel requestContent,
 ResponseHandler responseHandler)

Specified by:

handleRequest in class ThreadedRequestHandler

addDateHeader

protected void addDateHeader(HttpResponse httpResponse,
 long startTime)

createLoggingCompletionHandler

protected LoggingCompletionHandler createLoggingCompletionHandler(long startTime,
 long renderStartTime,
 HttpResponse response,
 HttpRequest httpRequest,
 ContentChannelOutputStream rendererWiring)

Override this to implement custom access logging.

Parameters:

startTime - execution start

renderStartTime - start of output rendering

response - the response which the log entry regards

httpRequest - the incoming HTTP request

rendererWiring - the stream the rendered response is written to, used for fetching length of rendered response

asHttpRequest

protected HttpRequest asHttpRequest(Request request)

testContext

public static ThreadedHttpRequestHandler.Context testContext()