Top Description Inners Fields Constructors Methods

io.undertow.server.handlers.accesslog

public Class AccessLogHandler

Class Inheritance

extends Object
implements HttpHandler

java.lang.Object
io.undertow.server.handlers.accesslog.AccessLogHandler

All Implemented Interfaces

io.undertow.server.HttpHandler

Imports

java.util.Collections, .HashMap, .Map, .Set, io.undertow.attribute.ExchangeAttribute, .ExchangeAttributes, .SubstituteEmptyWrapper, io.undertow.predicate.Predicate, .Predicates, io.undertow.server.ExchangeCompletionListener, .HandlerWrapper, .HttpHandler, .HttpServerExchange, io.undertow.server.handlers.builder.HandlerBuilder

Access log handler. This handler will generate access log messages based on the provided format string, and pass these messages into the provided AccessLogReceiver.

This handler can log any attribute that is provides via the io.undertow.attribute.ExchangeAttribute mechanism. A general guide to the most common attribute is provided before, however this mechanism is extensible.

This factory produces token handlers for the following patterns

%a - Remote IP address
%A - Local IP address
%b - Bytes sent, excluding HTTP headers, or '-' if no bytes were sent
%B - Bytes sent, excluding HTTP headers
%h - Remote host name
%H - Request protocol
%l - Remote logical username from identd (always returns '-')
%m - Request method
%o - Obfuscated remote IP address (IPv4: last byte removed, IPv6: cut off after second colon, ie. '1.2.3.' or 'fe08:44:')
%p - Local port
%q - Query string (excluding the '?' character)
%r - First line of the request
%s - HTTP status code of the response
%t - Date and time, in Common Log Format format
%u - Remote user that was authenticated
%U - Requested URL path
%v - Local server name
%D - Time taken to process the request, in millis
%T - Time taken to process the request, in seconds
%I - current Request thread name (can compare later with stacktraces)

In addition, the caller can specify one of the following aliases for commonly utilized patterns:

common - %h %l %u %t "%r" %s %b
combined - %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"
commonobf - %o %l %u %t "%r" %s %b
combinedobf - %o %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"

There is also support to write information from the cookie, incoming header, or the session
It is modeled after the apache syntax:

%{i,xxx} for incoming headers
%{o,xxx} for outgoing response headers
%{c,xxx} for a specific cookie
%{r,xxx} xxx is an attribute in the ServletRequest
%{s,xxx} xxx is an attribute in the HttpSession

Author: Stuart Douglas

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	AccessLogHandler.AccessLogCompletionListener
public static class	AccessLogHandler.Builder
private static class	AccessLogHandler.Wrapper

Field Summary

Modifier and Type	Field and Description
private final AccessLogReceiver	accessLogReceiver
private final ExchangeCompletionListener	exchangeCompletionListener
private final String	formatString
private final HttpHandler	next
private final Predicate	predicate
private final ExchangeAttribute	tokens

Constructor Summary

Access	Constructor and Description
public	AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, final String formatString, ClassLoader classLoader)
public	AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, final String formatString, ClassLoader classLoader, Predicate predicate)
public	AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, String formatString, final ExchangeAttribute attribute)
public	AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, String formatString, final ExchangeAttribute attribute, Predicate predicate)

Method Summary

Modifier and Type	Method and Description
private static String	handleCommonNames(String formatString)
public void	handleRequest(final HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

accessLogReceiver	back to summary
private final AccessLogReceiver accessLogReceiver

exchangeCompletionListener	back to summary
private final ExchangeCompletionListener exchangeCompletionListener

formatString	back to summary
private final String formatString

next	back to summary
private final HttpHandler next

predicate	back to summary
private final Predicate predicate

tokens	back to summary
private final ExchangeAttribute tokens

Constructor Detail

AccessLogHandler	back to summary
public AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, final String formatString, ClassLoader classLoader)

AccessLogHandler	back to summary
public AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, final String formatString, ClassLoader classLoader, Predicate predicate)

AccessLogHandler	back to summary
public AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, String formatString, final ExchangeAttribute attribute)

AccessLogHandler	back to summary
public AccessLogHandler(final HttpHandler next, final AccessLogReceiver accessLogReceiver, String formatString, final ExchangeAttribute attribute, Predicate predicate)

Method Detail

handleCommonNames	back to summary
private static String handleCommonNames(String formatString)

handleRequest	back to summary
public void handleRequest(final HttpServerExchange exchange) throws Exception Implements io.undertow.server.HttpHandler.handleRequest. Doc from io.undertow.server.HttpHandler.handleRequest. Handle the request. Parameters exchange:HttpServerExchange the HTTP request/response exchange Annotations @Override

handleRequest

back to summary

public void handleRequest(final HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters

exchange:HttpServerExchange: the HTTP request/response exchange

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.undertow.server.handlers.accesslog back to summary

private Class AccessLogHandler.AccessLogCompletionListener

Class Inheritance

extends Object
implements ExchangeCompletionListener

java.lang.Object
io.undertow.server.handlers.accesslog.AccessLogHandler.AccessLogCompletionListener

All Implemented Interfaces

io.undertow.server.ExchangeCompletionListener

Constructor Summary

Access	Constructor and Description
private	AccessLogCompletionListener()

Method Summary

Modifier and Type	Method and Description
public void	exchangeEvent(final HttpServerExchange exchange, final ExchangeCompletionListener.NextListener nextListener) Implements io.undertow.server.ExchangeCompletionListener.exchangeEvent.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AccessLogCompletionListener	back to summary
private AccessLogCompletionListener()

Method Detail

exchangeEvent	back to summary
public void exchangeEvent(final HttpServerExchange exchange, final ExchangeCompletionListener.NextListener nextListener) Implements io.undertow.server.ExchangeCompletionListener.exchangeEvent. Annotations @Override

exchangeEvent

back to summary

public void exchangeEvent(final HttpServerExchange exchange, final ExchangeCompletionListener.NextListener nextListener)

Implements io.undertow.server.ExchangeCompletionListener.exchangeEvent.

Annotations

@Override

io.undertow.server.handlers.accesslog back to summary

public Class AccessLogHandler.Builder

Class Inheritance

extends Object
implements HandlerBuilder

java.lang.Object
io.undertow.server.handlers.accesslog.AccessLogHandler.Builder

All Implemented Interfaces

io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public HandlerWrapper	build(Map<String, Object> The handler config config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler
public String	defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.
public String	name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name.
public Map<String, Class<?>>	parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types.
public Set<String>	requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public HandlerWrapper build(Map<String, Object> config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Doc from io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler Parameters config:Map<String, Object> The handler config Returns:HandlerWrapper The new predicate Annotations @Override

build

back to summary

public HandlerWrapper build(Map<String, Object> config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

Parameters

config:Map<String, Object>: The handler config

Returns:HandlerWrapper

The new predicate

Annotations

@Override

defaultParameter	back to summary
public String defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. Returns:String Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. The default parameter name, or null if it does not have a default parameter Annotations @Override

defaultParameter

back to summary

public String defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

Returns:String

Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations

@Override

name	back to summary
public String name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. Doc from io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name. Returns:String The handler name Annotations @Override

name

back to summary

public String name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

Returns:String

The handler name

Annotations

@Override

parameters	back to summary
public Map<String, Class<?>> parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types. Annotations @Override

parameters

back to summary

public Map<String, Class<?>> parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

Annotations

@Override

requiredParameters	back to summary
public Set<String> requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. Returns:Set<String> Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. The required parameters Annotations @Override

requiredParameters

back to summary

public Set<String> requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

The required parameters

Annotations

@Override

io.undertow.server.handlers.accesslog back to summary

private Class AccessLogHandler.Wrapper

Class Inheritance

extends Object
implements HandlerWrapper

java.lang.Object
io.undertow.server.handlers.accesslog.AccessLogHandler.Wrapper

All Implemented Interfaces

io.undertow.server.HandlerWrapper

Field Summary

Modifier and Type	Field and Description
private final String	category
private final String	format

Constructor Summary

Access	Constructor and Description
private	Wrapper(String format, String category)

Method Summary

Modifier and Type	Method and Description
public HttpHandler	wrap(HttpHandler handler) Implements io.undertow.server.HandlerWrapper.wrap.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

category	back to summary
private final String category

format	back to summary
private final String format

Constructor Detail

Wrapper	back to summary
private Wrapper(String format, String category)

Wrapper

back to summary

private Wrapper(String format, String category)

Method Detail

wrap	back to summary
public HttpHandler wrap(HttpHandler handler) Implements io.undertow.server.HandlerWrapper.wrap. Annotations @Override

wrap

back to summary

public HttpHandler wrap(HttpHandler handler)

Implements io.undertow.server.HandlerWrapper.wrap.

Annotations

@Override