Class HeaderLogEntry

java.lang.Object

io.helidon.webserver.accesslog.AbstractLogEntry

io.helidon.webserver.accesslog.HeaderLogEntry

All Implemented Interfaces:

AccessLogEntry

public final class HeaderLogEntry
extends AbstractLogEntry

Access log entry for header values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HeaderLogEntry.Builder	Fluent API builder for HeaderLogEntry.

Field Summary

Fields inherited from class AbstractLogEntry

DEFAULT_MAX_LENGTH

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_LENGTH	Default limit for the number of characters written.

Fields inherited from interface AccessLogEntry

NOT_AVAILABLE

Modifier and Type	Field	Description
static final String	NOT_AVAILABLE	If an entry is not available, use this string as the result.

Method Summary

Modifier and Type	Method	Description
static HeaderLogEntry.Builder	builder(HeaderName headerName)	Create a fluent API builder for a header log entry.
static HeaderLogEntry.Builder	builder(String headerName)	Create a fluent API builder for a header log entry.
static HeaderLogEntry	create(String headerName)	Create a header log entry for a specified header name with default configuration.
protected String	doApply(AccessLogContext context)	Apply the "raw" log entry.

Methods inherited from class AbstractLogEntry

apply, maxLength, pad, sanitize

Modifier and Type	Method	Description
String	apply(AccessLogContext context)	Apply the log entry, adds padding to the log entry and then calls AbstractLogEntry.doApply(AccessLogContext).
protected String	maxLength(String toLimit)	Apply maximal length limitation.
protected String	pad(String toPad)	Apply configured padding.
protected String	sanitize(String toSanitize)	Apply configured sanitization.

Methods inherited from class Object

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

Method Details

create

public static HeaderLogEntry create(String headerName)

Create a header log entry for a specified header name with default configuration.

Parameters:

headerName - name of HTTP header to print to the access log

Returns:

a new header log entry

builder

public static HeaderLogEntry.Builder builder(String headerName)

Create a fluent API builder for a header log entry.

Parameters:

headerName - name of HTTP header to print to the access log

Returns:

a fluent API builder

builder

public static HeaderLogEntry.Builder builder(HeaderName headerName)

Create a fluent API builder for a header log entry.

Parameters:

headerName - header name

Returns:

a fluent API builder

doApply

protected String doApply(AccessLogContext context)

Description copied from class: AbstractLogEntry

Apply the "raw" log entry. The result will go through common formatting, such as padding if configured.

Specified by:

doApply in class AbstractLogEntry

Parameters:

context - context with access to information useful for access log entries

Returns:

log entry

See Also:

• AccessLogEntry.NOT_AVAILABLE