Module io.helidon.webserver.accesslog

Package io.helidon.webserver.accesslog

Class AccessLogConfig.BuilderBase.AccessLogConfigImpl

java.lang.Object

io.helidon.webserver.accesslog.AccessLogConfig.BuilderBase.AccessLogConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<AccessLogFeature>, AccessLogConfig, Supplier<AccessLogFeature>

Enclosing class:

AccessLogConfig.BuilderBase<BUILDER extends AccessLogConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AccessLogConfig>

protected static class AccessLogConfig.BuilderBase.AccessLogConfigImpl
extends Object
implements AccessLogConfig, Supplier<AccessLogFeature>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.accesslog.AccessLogConfig

AccessLogConfig.Builder, AccessLogConfig.BuilderBase<BUILDER extends AccessLogConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AccessLogConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static final List<AccessLogEntry>	COMMON_FORMAT	Common log format, see AccessLogConfig.BuilderBase.commonLogFormat().
static final List<AccessLogEntry>	HELIDON_FORMAT	Helidon log format, see AccessLogConfig.BuilderBase.defaultLogFormat().

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccessLogConfigImpl(AccessLogConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
AccessLogFeature	build()	Create a new instance of the runtime type from this config object.
Clock	clock()	Configure an alternative clock to use, such as Clock.fixed(java.time.Instant, java.time.ZoneId).
boolean	enabled()	Whether this feature will be enabled.
List<AccessLogEntry>	entries()	Configured log entries.
boolean	equals(Object o)
Optional<String>	format()	The format for log entries (similar to the Apache LogFormat).
AccessLogFeature	get()
int	hashCode()
String	loggerName()	Name of the logger used to obtain access log logger from System.getLogger(String).
String	name()	Name of this instance.
Set<String>	sockets()	List of sockets to register this feature on.
String	toString()
double	weight()	Weight of the access log feature.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COMMON_FORMAT

static final List<AccessLogEntry> COMMON_FORMAT

Common log format, see AccessLogConfig.BuilderBase.commonLogFormat().

HELIDON_FORMAT

static final List<AccessLogEntry> HELIDON_FORMAT

Helidon log format, see AccessLogConfig.BuilderBase.defaultLogFormat().

Constructor Details

AccessLogConfigImpl

protected AccessLogConfigImpl(AccessLogConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public AccessLogFeature build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<AccessLogFeature>

Returns:

new configured runtime instance

get

public AccessLogFeature get()

Specified by:

get in interface Supplier<AccessLogFeature>

entries

public List<AccessLogEntry> entries()

Description copied from interface: AccessLogConfig

Configured log entries. If both entries and AccessLogConfig.format() are defined, AccessLogConfig.format() is used.

Specified by:

entries in interface AccessLogConfig

Returns:

list of access log entries

clock

public Clock clock()

Description copied from interface: AccessLogConfig

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

Specified by:

clock in interface AccessLogConfig

Returns:

clock to use to get current times

loggerName

public String loggerName()

Description copied from interface: AccessLogConfig

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

Specified by:

loggerName in interface AccessLogConfig

Returns:

name of the logger to use

weight

public double weight()

Description copied from interface: AccessLogConfig

Weight of the access log feature. We need to log access for anything happening on the server, so weight is high: 1000.0.

Specified by:

weight in interface AccessLogConfig

Returns:

weight of the feature

sockets

public Set<String> sockets()

Description copied from interface: AccessLogConfig

List of sockets to register this feature on. If empty, it would get registered on all sockets. The logger used will have the expected logger with a suffix of the socket name.

Specified by:

sockets in interface AccessLogConfig

Returns:

socket names to register on, defaults to empty (all available sockets)

name

public String name()

Description copied from interface: AccessLogConfig

Name of this instance.

Specified by:

name in interface AccessLogConfig

Returns:

instance name

format

public Optional<String> format()

Description copied from interface: AccessLogConfig

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

Specified by:

format in interface AccessLogConfig

Returns:

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

enabled

public boolean enabled()

Description copied from interface: AccessLogConfig

Whether this feature will be enabled.

Specified by:

enabled in interface AccessLogConfig

Returns:

whether enabled

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object