HTTP functionality for the Reactor Netty library 1.1.16 · reactor.netty.http.server.logging.AccessLogFactory

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static AccessLogFactory	Returns: an `AccessLogFactory` to be used in `reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)` createFilter(Predicate<AccessLogArgProvider> the filter that returns `true` if the request should be logged, `false` otherwise predicate) Helper method to create an access log factory that selectively enables access logs.
public static AccessLogFactory	Returns: an `AccessLogFactory` to be used in `reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)` createFilter(Predicate<AccessLogArgProvider> the filter that returns `true` if the request should be logged, `false` otherwise predicate, AccessLogFactory the `AccessLogFactory` that creates `AccessLog` instances, encapsulating the format and the extraction of relevant arguments formatFunction) Helper method to create an access log factory that selectively enables access logs and customizes the format to apply.

public static AccessLogFactory

Returns:

an AccessLogFactory to be used in reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)

createFilter(Predicate<AccessLogArgProvider>

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

predicate)

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

public static AccessLogFactory

Returns:

an AccessLogFactory to be used in reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)

createFilter(Predicate<AccessLogArgProvider>

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

predicate, AccessLogFactory

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

formatFunction)

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

Inherited from java.util.function.Function:: andThen apply compose identity

Method Detail

createFilter back to summary

createFilter	back to summary
public 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:Predicate<AccessLogArgProvider> the filter that returns `true` if the request should be logged, `false` otherwise Returns:AccessLogFactory an `AccessLogFactory` to be used in `reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)` Since 1.0.3

public 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:Predicate<AccessLogArgProvider>: the filter that returns true if the request should be logged, false otherwise

Returns:AccessLogFactory

an AccessLogFactory to be used in reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)

Since

1.0.3

createFilter back to summary

createFilter	back to summary
public 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:Predicate<AccessLogArgProvider> the filter that returns `true` if the request should be logged, `false` otherwise formatFunction:AccessLogFactory the `AccessLogFactory` that creates `AccessLog` instances, encapsulating the format and the extraction of relevant arguments Returns:AccessLogFactory an `AccessLogFactory` to be used in `reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)` Since 1.0.3

public 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:Predicate<AccessLogArgProvider>: the filter that returns true if the request should be logged, false otherwise
formatFunction:AccessLogFactory: the AccessLogFactory that creates AccessLog instances, encapsulating the format and the extraction of relevant arguments

Returns:AccessLogFactory

an AccessLogFactory to be used in reactor.netty.http.server.HttpServer#accessLog(boolean, AccessLogFactory)

Since

1.0.3

public Interface AccessLogFactory

Method Summary

Method Detail