Package com.yahoo.container.jdisc

Class LoggingRequestHandler

java.lang.Object

com.yahoo.jdisc.AbstractResource

com.yahoo.jdisc.handler.AbstractRequestHandler

com.yahoo.container.jdisc.ThreadedRequestHandler

com.yahoo.container.jdisc.ThreadedHttpRequestHandler

com.yahoo.container.jdisc.LoggingRequestHandler

All Implemented Interfaces:

HttpRequestHandler, com.yahoo.jdisc.handler.RequestHandler, com.yahoo.jdisc.SharedResource

Direct Known Subclasses:

AbstractProcessingHandler, MockService, RestApiRequestHandler

public abstract class LoggingRequestHandler
extends ThreadedHttpRequestHandler

A request handler base class extending the features of ThreadedHttpRequestHandler with access logging.

Author:

Steinar Knutsen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoggingRequestHandler.Context

Nested classes/interfaces inherited from class com.yahoo.container.jdisc.ThreadedHttpRequestHandler

ThreadedHttpRequestHandler.LazyContentChannel

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

com.yahoo.jdisc.SharedResource.Debug

Field Summary

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

CONTENT_TYPE, log

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

metric

Fields inherited from interface com.yahoo.jdisc.SharedResource

DEBUG, SYSTEM_PROPERTY_NAME_DEBUG

Constructor Summary

Constructors

Constructor	Description
LoggingRequestHandler(LoggingRequestHandler.Context ctx)
LoggingRequestHandler(LoggingRequestHandler.Context ctx, boolean allowAsyncResponse)
LoggingRequestHandler(Executor executor)
LoggingRequestHandler(Executor executor, AccessLog ignored)	Deprecated, for removal: This API element is subject to removal in a future version. Use LoggingRequestHandler(Executor) instead
LoggingRequestHandler(Executor executor, AccessLog ignored, com.yahoo.jdisc.Metric metric)	Deprecated, for removal: This API element is subject to removal in a future version. Use LoggingRequestHandler(Executor, Metric) instead
LoggingRequestHandler(Executor executor, AccessLog ignored, com.yahoo.jdisc.Metric metric, boolean allowAsyncResponse)	Deprecated, for removal: This API element is subject to removal in a future version. Use LoggingRequestHandler(Executor, Metric, boolean) instead
LoggingRequestHandler(Executor executor, com.yahoo.jdisc.Metric metric)
LoggingRequestHandler(Executor executor, com.yahoo.jdisc.Metric metric, boolean allowAsyncResponse)

Method Summary

Modifier and Type	Method	Description
protected LoggingCompletionHandler	createLoggingCompletionHandler(long startTime, long renderStartTime, HttpResponse response, HttpRequest httpRequest, ContentChannelOutputStream rendererWiring)	Override this to implement custom access logging.
static LoggingRequestHandler.Context	testOnlyContext()

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

addDateHeader, asHttpRequest, handle, handle, handleRequest

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

Constructor Detail

LoggingRequestHandler

@Inject
public LoggingRequestHandler(LoggingRequestHandler.Context ctx)

LoggingRequestHandler

@Deprecated(forRemoval=true,
            since="7")
public LoggingRequestHandler(Executor executor,
                             AccessLog ignored)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LoggingRequestHandler(Executor) instead

LoggingRequestHandler

public LoggingRequestHandler(Executor executor)

LoggingRequestHandler

public LoggingRequestHandler(LoggingRequestHandler.Context ctx,
                             boolean allowAsyncResponse)

LoggingRequestHandler

public LoggingRequestHandler(Executor executor,
                             com.yahoo.jdisc.Metric metric)

LoggingRequestHandler

@Deprecated(forRemoval=true,
            since="7")
public LoggingRequestHandler(Executor executor,
                             AccessLog ignored,
                             com.yahoo.jdisc.Metric metric)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LoggingRequestHandler(Executor, Metric) instead

LoggingRequestHandler

@Deprecated(forRemoval=true,
            since="7")
public LoggingRequestHandler(Executor executor,
                             AccessLog ignored,
                             com.yahoo.jdisc.Metric metric,
                             boolean allowAsyncResponse)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LoggingRequestHandler(Executor, Metric, boolean) instead

LoggingRequestHandler

public LoggingRequestHandler(Executor executor,
                             com.yahoo.jdisc.Metric metric,
                             boolean allowAsyncResponse)

Method Detail

testOnlyContext

public static LoggingRequestHandler.Context testOnlyContext()

createLoggingCompletionHandler

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

Description copied from class: ThreadedHttpRequestHandler

Override this to implement custom access logging.

Overrides:

createLoggingCompletionHandler in class ThreadedHttpRequestHandler

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