Package reactor.netty.http.server.logging

Interface AccessLogFactory

All Superinterfaces:

Function<AccessLogArgProvider,@Nullable AccessLog>

public interface AccessLogFactory
extends Function<AccessLogArgProvider,@Nullable AccessLog>

An interface to declare more concisely a Function that apply an AccessLog by an AccessLogArgProvider.

Can be used in accessLog method for example.

Since:

1.0.3

Author:

Simon Baslé, Audrey Neveu

Method Summary

Static Methods

Modifier and Type	Method	Description
static AccessLogFactory	createFilter(Predicate<AccessLogArgProvider> predicate)	Helper method to create an access log factory that selectively enables access logs.
static AccessLogFactory	createFilter(Predicate<AccessLogArgProvider> predicate, AccessLogFactory formatFunction)	Helper method to create an access log factory that selectively enables access logs and customizes the format to apply.

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Method Details

createFilter

static AccessLogFactory createFilter(Predicate<AccessLogArgProvider> predicate)

Helper method to create an access log factory that selectively enables access logs.

Any request (represented as an AccessLogArgProvider) that doesn't match the provided Predicate is excluded from the access log. Other requests are logged using the default format.

Parameters:

predicate - the filter that returns true if the request should be logged, false otherwise

Returns:

an AccessLogFactory to be used in HttpServer.accessLog(boolean, AccessLogFactory)

Since:

1.0.3

createFilter

static AccessLogFactory createFilter(Predicate<AccessLogArgProvider> predicate,
 AccessLogFactory formatFunction)

Helper method to create an access log factory that selectively enables access logs and customizes the format to apply.

Any request (represented as an AccessLogArgProvider) that doesn't match the provided Predicate is excluded from the access log. Other requests are logged using the provided formatting Function. Said function is expected to create an AccessLog instance, defining both the String format and a vararg of the relevant arguments, extracted from the AccessLogArgProvider.

Parameters:

predicate - the filter that returns true if the request should be logged, false otherwise

formatFunction - the AccessLogFactory that creates AccessLog instances, encapsulating the format and the extraction of relevant arguments

Returns:

an AccessLogFactory to be used in HttpServer.accessLog(boolean, AccessLogFactory)

Since:

1.0.3