Module io.helidon.webserver.accesslog
Package io.helidon.webserver.accesslog

Interface AccessLogEntry

All Superinterfaces:
BiConsumer<ServerRequest,ServerResponse>, Handler
All Known Implementing Classes:
AbstractLogEntry, HeaderLogEntry, HostLogEntry, RequestLineLogEntry, SizeLogEntry, StatusLogEntry, TimestampLogEntry, TimeTakenLogEntry, UserIdLogEntry, UserLogEntry
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface AccessLogEntry extends Handler
An entry generating data for access log. Implementation MUST be thread safe.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.helidon.webserver.Handler

    Handler.EntityHandler<T>

  • Field Summary

    Fields
    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
    default void
    accept(ServerRequest req, ServerResponse res)
    This method allows for each log entry to register anything on the request and/or response.
    String
    apply(AccessLogContext context)
    This method is called once the response is fully processed.

    Methods inherited from interface java.util.function.BiConsumer

    andThen

  • Field Details

    • NOT_AVAILABLE

      static final String NOT_AVAILABLE
      If an entry is not available, use this string as the result.
      See Also:

  • Method Details

    • accept

      default void accept(ServerRequest req, ServerResponse res)
      This method allows for each log entry to register anything on the request and/or response. As the log entry is shared by all threads, make sure the handling is implemented as thread safe.
      Specified by:
      accept in interface BiConsumer<ServerRequest,ServerResponse>
      Specified by:
      accept in interface Handler
      Parameters:
      req - an HTTP server request.
      res - an HTTP server response.

    • apply

      String apply(AccessLogContext context)
      This method is called once the response is fully processed. The AccessLogContext.serverResponse() will return a completed response.
      Parameters:
      context - context with access to information useful for access log entries
      Returns:
      string representation of a log entry (such as a formatted date time, response time etc.)