Class AccessLogRoutingFeature

java.lang.Object

io.helidon.webserver.accesslog.AccessLogRoutingFeature

All Implemented Interfaces:

Weighted, HttpFeature, ServerLifecycle, Comparable<Weighted>, Supplier<HttpFeature>

public final class AccessLogRoutingFeature
extends Object
implements HttpFeature, Weighted

Service that adds support for Access logging to Server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AccessLogRoutingFeature.Builder	A fluent API Builder for AccessLogRoutingFeature.

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 Weighted

DEFAULT_WEIGHT

Modifier and Type	Field	Description
static final double	DEFAULT_WEIGHT	Default weight for any weighted component (whether it implements this interface or uses Weight annotation).

Method Summary

Modifier and Type	Method	Description
static AccessLogRoutingFeature.Builder	builder()	A new fluent API builder to create Access log support instance.
static AccessLogRoutingFeature	create()	Create Access log support with default configuration.
static AccessLogRoutingFeature	create(Config config)	Create Access log support configured from Config.
void	setup(HttpRouting.Builder routing)	Method to set up a feature.

Methods inherited from class Object

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

Methods inherited from interface HttpFeature

get, socket, socketRequired

Modifier and Type	Method	Description
default HttpFeature	get()
default String	socket()	Name of the listener socket this feature should be registered on, for automatically discovered features.
default boolean	socketRequired()	Whether the socket defined in HttpFeature.socket() must be present for this feature, or it can be exposed on default socket.

Methods inherited from interface ServerLifecycle

afterStart, afterStop, beforeStart

Modifier and Type	Method	Description
default void	afterStart(WebServer webServer)	After server start.
default void	afterStop()	After server stop.
default void	beforeStart()	Before server start.

Methods inherited from interface Weighted

compareTo, weight

Modifier and Type	Method	Description
default int	compareTo(Weighted o)
default double	weight()	Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation).

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 AccessLogRoutingFeature create()

Create Access log support with default configuration.

Returns:

a new access log support to be registered with WebServer routing

create

public static AccessLogRoutingFeature 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 AccessLogRoutingFeature.Builder builder()

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

Returns:

a new builder

setup

public void setup(HttpRouting.Builder routing)

Description copied from interface: HttpFeature

Method to set up a feature.

Specified by:

setup in interface HttpFeature

Parameters:

routing - routing builder