Class AccessLogConfig.Builder

java.lang.Object

io.helidon.webserver.accesslog.AccessLogConfig.BuilderBase<AccessLogConfig.Builder, AccessLogConfig>

io.helidon.webserver.accesslog.AccessLogConfig.Builder

All Implemented Interfaces:

Prototype.Builder<AccessLogConfig.Builder, AccessLogConfig>, Builder<AccessLogConfig.Builder, AccessLogFeature>, ConfigBuilderSupport.ConfiguredBuilder<AccessLogConfig.Builder, AccessLogConfig>, Supplier<AccessLogFeature>

Enclosing interface:

AccessLogConfig

public static class AccessLogConfig.Builder
extends AccessLogConfig.BuilderBase<AccessLogConfig.Builder, AccessLogConfig>
implements Builder<AccessLogConfig.Builder, AccessLogFeature>

Fluent API builder for AccessLogFeature.

Nested Class Summary

Nested classes/interfaces inherited from class AccessLogConfig.BuilderBase

AccessLogConfig.BuilderBase.AccessLogConfigImpl

Modifier and Type	Class	Description
protected static class	AccessLogConfig.BuilderBase.AccessLogConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
AccessLogFeature	build()	Create an instance from this builder.
AccessLogConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class AccessLogConfig.BuilderBase

addEntries, addEntry, addSockets, clearEntries, clearFormat, clearSockets, clock, clock, commonLogFormat, config, config, defaultLogFormat, enabled, enabled, entries, entries, format, format, from, from, loggerName, loggerName, name, name, preBuildPrototype, sockets, sockets, toString, validatePrototype, weight, weight

Modifier and Type	Method	Description
AccessLogConfig.Builder	addEntries(List<? extends AccessLogEntry> entries)	Configured log entries.
AccessLogConfig.Builder	addEntry(AccessLogEntry entry)	Configured log entries.
AccessLogConfig.Builder	addSockets(Set<String> sockets)	List of sockets to register this feature on.
AccessLogConfig.Builder	clearEntries()	Clear all entries.
AccessLogConfig.Builder	clearFormat()	Clear existing value of format.
AccessLogConfig.Builder	clearSockets()	Clear all sockets.
Clock	clock()	Configure an alternative clock to use, such as Clock.fixed(java.time.Instant, java.time.ZoneId).
AccessLogConfig.Builder	clock(Clock clock)	Configure an alternative clock to use, such as Clock.fixed(java.time.Instant, java.time.ZoneId).
AccessLogConfig.Builder	commonLogFormat()	Use common log format.
protected Optional<Config>	config()	Configuration used to configure this instance.
AccessLogConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
AccessLogConfig.Builder	defaultLogFormat()	Use default log format.
boolean	enabled()	Whether this feature will be enabled.
AccessLogConfig.Builder	enabled(boolean enabled)	Whether this feature will be enabled.
List<AccessLogEntry>	entries()	Configured log entries.
AccessLogConfig.Builder	entries(List<? extends AccessLogEntry> entries)	Configured log entries.
Optional<String>	format()	The format for log entries (similar to the Apache LogFormat).
AccessLogConfig.Builder	format(String format)	The format for log entries (similar to the Apache LogFormat).
AccessLogConfig.Builder	from(AccessLogConfig prototype)	Update this builder from an existing prototype instance.
AccessLogConfig.Builder	from(AccessLogConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	loggerName()	Name of the logger used to obtain access log logger from System.getLogger(String).
AccessLogConfig.Builder	loggerName(String loggerName)	Name of the logger used to obtain access log logger from System.getLogger(String).
String	name()	Name of this instance.
AccessLogConfig.Builder	name(String name)	Name of this instance.
protected void	preBuildPrototype()	Handles providers and decorators.
Set<String>	sockets()	List of sockets to register this feature on.
AccessLogConfig.Builder	sockets(Set<String> sockets)	List of sockets to register this feature on.
String	toString()
protected void	validatePrototype()	Validates required properties.
double	weight()	Weight of the access log feature.
AccessLogConfig.Builder	weight(double weight)	Weight of the access log feature.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default AccessLogFeature	get()
default AccessLogConfig.Builder	identity()	Instance of this builder as the correct type.
default AccessLogConfig.Builder	update(Consumer<AccessLogConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default AccessLogConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public AccessLogConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<AccessLogConfig.Builder, AccessLogConfig>

Returns:

an instance of the setup object created from this builder

build

public AccessLogFeature build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<AccessLogConfig.Builder, AccessLogFeature>

Returns:

instance of the built type