Module io.helidon.webserver.accesslog

Package io.helidon.webserver.accesslog

Class AccessLogFeature

java.lang.Object

io.helidon.webserver.accesslog.AccessLogFeature

All Implemented Interfaces:

io.helidon.builder.api.RuntimeType.Api<AccessLogConfig>, io.helidon.common.config.NamedService, ServerFeature

public final class AccessLogFeature
extends Object
implements ServerFeature, io.helidon.builder.api.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.

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(io.helidon.config.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()
AccessLogConfig	prototype()
void	setup(ServerFeature.ServerFeatureContext featureContext)
String	type()

Methods inherited from class java.lang.Object

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

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(io.helidon.config.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)

Specified by:

setup in interface ServerFeature

prototype

public AccessLogConfig prototype()

Specified by:

prototype in interface io.helidon.builder.api.RuntimeType.Api<AccessLogConfig>

name

public String name()

Specified by:

name in interface io.helidon.common.config.NamedService

type

public String type()

Specified by:

type in interface io.helidon.common.config.NamedService