Module io.helidon.webserver.accesslog

Package io.helidon.webserver.accesslog

Class AccessLogFeature.Builder

java.lang.Object

io.helidon.webserver.accesslog.AccessLogFeature.Builder

All Implemented Interfaces:

io.helidon.common.Builder<AccessLogFeature.Builder,AccessLogFeature>, Supplier<AccessLogFeature>

Enclosing class:

AccessLogFeature

public static final class AccessLogFeature.Builder
extends Object
implements io.helidon.common.Builder<AccessLogFeature.Builder,AccessLogFeature>

A fluent API Builder for AccessLogFeature.

Method Summary

Modifier and Type	Method	Description
AccessLogFeature.Builder	add(AccessLogEntry entry)	Add a AccessLogEntry to the list of log entries creating the format of this access log.
AccessLogFeature	build()
AccessLogFeature.Builder	clock(Clock clock)	Configure an alternative clock to use, such as Clock.fixed(java.time.Instant, java.time.ZoneId).
AccessLogFeature.Builder	commonLogFormat()	Use common log format.
AccessLogFeature.Builder	config(io.helidon.config.Config config)	Update this builder from configuration.
AccessLogFeature.Builder	defaultLogFormat()	Use default log format.
AccessLogFeature.Builder	enabled(boolean enabled)	Access logging can be disabled (either through configuration or explicitly in code.
AccessLogFeature.Builder	logFormatString(String format)	The format for log entries (similar to the Apache LogFormat).
AccessLogFeature.Builder	loggerName(String loggerName)	Name of the logger use to obtain access log logger from System.getLogger(String).
AccessLogFeature.Builder	weight(double weight)	Configure a new weight for this feature.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

build

public AccessLogFeature build()

Specified by:

build in interface io.helidon.common.Builder<AccessLogFeature.Builder,AccessLogFeature>

defaultLogFormat

public AccessLogFeature.Builder defaultLogFormat()

Use default log format.

Clears the current log entries and replaces them with default log format.

Helidon log format uses the following log entries (in this order):

• HostLogEntry
• UserLogEntry
• TimestampLogEntry
• RequestLineLogEntry
• StatusLogEntry
• SizeLogEntry
• TimeTakenLogEntry configured for TimeUnit.MICROSECONDS

Returns:

updated builder instance

commonLogFormat

public AccessLogFeature.Builder commonLogFormat()

Use common log format.

Clears the current log entries and replaces them with common log format.

common log format uses the following log entries (in this order):

• HostLogEntry
• UserIdLogEntry
• UserLogEntry
• TimestampLogEntry
• RequestLineLogEntry
• StatusLogEntry
• SizeLogEntry

Returns:

updated builder instance

logFormatString

public AccessLogFeature.Builder logFormatString(String format)

The format for log entries (similar to the Apache LogFormat).

Log format elements

%h	IP address of the remote host	HostLogEntry
%l	The client identity. This is always undefined in Helidon.	UserIdLogEntry
%u	User ID as asserted by Helidon Security.	UserLogEntry
%t	The timestamp	TimestampLogEntry
%r	The request line ("GET /favicon.ico HTTP/1.0")	RequestLineLogEntry
%s	The status code returned to the client	StatusLogEntry
%b	The entity size in bytes	SizeLogEntry
%D	The time taken in microseconds (start of request until last byte written)	TimeTakenLogEntry
%T	The time taken in seconds (start of request until last byte written), integer	TimeTakenLogEntry
%{header-name}i	Value of header header-name	HeaderLogEntry

Parameters:

format - format string, such as %h %l %u %t %r %b %{Referer}i

Returns:

updated builder instance

add

public AccessLogFeature.Builder add(AccessLogEntry entry)

Add a AccessLogEntry to the list of log entries creating the format of this access log. Entries are separated by a space.

Parameters:

entry - entry to add to the list of format entries

Returns:

updated builder instance

enabled

public AccessLogFeature.Builder enabled(boolean enabled)

Access logging can be disabled (either through configuration or explicitly in code.

Parameters:

enabled - whether to enable (true) or disable (false) access logging

Returns:

updated builder instance

config

public AccessLogFeature.Builder config(io.helidon.config.Config config)

Update this builder from configuration. In case format is specified in configuration, it would replace the currently configured format in this builder.

Parameters:

config - configuration with Access log configuration options

Returns:

updated builder instance

weight

public AccessLogFeature.Builder weight(double weight)

Configure a new weight for this feature. Changing weight may change ordering of features.

Parameters:

weight - new weight to use

Returns:

updated builder

loggerName

public AccessLogFeature.Builder loggerName(String loggerName)

Name of the logger use to obtain access log logger from System.getLogger(String). Defaults to "io.helidon.webserver.AccessLog".

Parameters:

loggerName - name of the logger to use

Returns:

updated builder instance

clock

public AccessLogFeature.Builder clock(Clock clock)

Configure an alternative clock to use, such as Clock.fixed(java.time.Instant, java.time.ZoneId). Defaults to Clock.systemDefaultZone().

Parameters:

clock - clock to use to get current times

Returns:

updated builder instance