Module io.helidon.webserver.accesslog

Package io.helidon.webserver.accesslog

Class AccessLogFeature

java.lang.Object

io.helidon.webserver.accesslog.AccessLogFeature

All Implemented Interfaces:

RuntimeType.Api<AccessLogConfig>, NamedService, Weighted, ServerFeature, Comparable<Weighted>

public final class AccessLogFeature
extends Object
implements Weighted, ServerFeature, RuntimeType.Api<AccessLogConfig>

Service that adds support for Access logging to Server.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.spi.ServerFeature

ServerFeature.RoutingBuilders, ServerFeature.ServerFeatureContext, ServerFeature.SocketBuilders

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LOGGER_NAME	Name of the System.getLogger(String) used to log access log records.

Fields inherited from interface io.helidon.common.Weighted

DEFAULT_WEIGHT

Method Summary

Modifier and Type	Method	Description
static AccessLogConfig.Builder	builder()	A new fluent API builder to create Access log support instance.
static AccessLogFeature	create()	Create Access log support with default configuration.
static AccessLogFeature	create(Config config)	Create Access log support configured from Config.
static AccessLogFeature	create(AccessLogConfig config)	Create a new instance from its configuration.
static AccessLogFeature	create(Consumer<AccessLogConfig.Builder> builderConsumer)	Create a new instance customizing its configuration.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
AccessLogConfig	prototype()	The prototype as it was received when creating this runtime object instance.
void	setup(ServerFeature.ServerFeatureContext featureContext)	Set up a server feature.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
double	weight()	Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation).

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.Weighted

compareTo

Field Details

DEFAULT_LOGGER_NAME

public static final String DEFAULT_LOGGER_NAME

Name of the System.getLogger(String) used to log access log records. The message logged contains all information, so the format should be modified to only log the message.

See Also:

• AccessLogHandler
• Constant Field Values

Method Details

create

public static AccessLogFeature create()

Create Access log support with default configuration.

Returns:

a new access log support to be registered with WebServer routing

create

public static AccessLogFeature create(Config config)

Create Access log support configured from Config.

Parameters:

config - to configure a new access log support instance

Returns:

a new access log support to be registered with WebServer routing

builder

public static AccessLogConfig.Builder builder()

A new fluent API builder to create Access log support instance.

Returns:

a new builder

create

public static AccessLogFeature create(AccessLogConfig config)

Create a new instance from its configuration.

Parameters:

config - configuration

Returns:

a new feature

create

public static AccessLogFeature create(Consumer<AccessLogConfig.Builder> builderConsumer)

Create a new instance customizing its configuration.

Parameters:

builderConsumer - consumer of configuration

Returns:

a new feature

setup

public void setup(ServerFeature.ServerFeatureContext featureContext)

Description copied from interface: ServerFeature

Set up a server feature. Server features can modify server configuration, right before the server is created. To access listener configuration, or routing, a list of all listeners is provided.

Specified by:

setup in interface ServerFeature

Parameters:

featureContext - to access builders of webserver, listeners, and routing

prototype

public AccessLogConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<AccessLogConfig>

Returns:

prototype object used to create this instance

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

weight

public double weight()

Description copied from interface: Weighted

Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation). If not dynamic, you can use the Weight annotation rather than implementing this interface as long as it is supported by the library using this Weighted.

Specified by:

weight in interface Weighted

Returns:

the weight of this service, must be a non-negative number