Module ch.qos.logback.access.common
Package ch.qos.logback.access.common.spi

Interface IAccessEvent

All Superinterfaces:
ch.qos.logback.core.spi.DeferredProcessingAware
All Known Implementing Classes:
AccessEvent
public interface IAccessEvent extends ch.qos.logback.core.spi.DeferredProcessingAware

This class is the internal representation of events to be logged.

When the HTTP container wishes to log an HTTP access event, then an instance of this class is created. This instance is passed around to the different logback components.

Put differently, the logback-access project revolves around this interface.

Author:
Ceki Gülcü, Sébastien Pennec, Jörn Huxhorn

  • Field Details

  • Method Details

    • getRequest

      jakarta.servlet.http.HttpServletRequest getRequest()
      Returns the underlying HttpServletRequest. After serialization the returned value will be null.
      Returns:

    • getResponse

      jakarta.servlet.http.HttpServletResponse getResponse()
      Returns the underlying HttpServletResponse. After serialization the returned value will be null.
      Returns:

    • getTimeStamp

      long getTimeStamp()
      The number of milliseconds elapsed from 1/1/1970 until logging event was created.

    • getSequenceNumber

      long getSequenceNumber()
      The sequence number associated with this event.

      Sequence numbers, if present, should be increasing monotonically.

      Since:
      1.3.0

    • getElapsedTime

      long getElapsedTime()
      The time elapsed between receiving the request and logging it in milliseconds.

    • getElapsedSeconds

      long getElapsedSeconds()
      The number of seconds elapsed between receiving the request and logging it.

    • getRequestURI

      String getRequestURI()

    • getRequestURL

      String getRequestURL()
      The first line of the request.

    • getRemoteHost

      String getRemoteHost()

    • getRemoteUser

      String getRemoteUser()

    • getProtocol

      String getProtocol()

    • getMethod

      String getMethod()

    • getServerName

      String getServerName()

    • getSessionID

      String getSessionID()

    • setThreadName

      void setThreadName(String threadName)

    • getThreadName

      String getThreadName()

    • getQueryString

      String getQueryString()

    • getRemoteAddr

      String getRemoteAddr()

    • getRequestHeader

      String getRequestHeader(String key)

    • getRequestHeaderNames

      Enumeration<String> getRequestHeaderNames()

    • getRequestHeaderMap

      Map<String,String> getRequestHeaderMap()

    • getRequestParameterMap

      Map<String,String[]> getRequestParameterMap()

    • getAttribute

      String getAttribute(String key)

    • getRequestParameter

      String[] getRequestParameter(String key)

    • getCookies

      default List<jakarta.servlet.http.Cookie> getCookies()

      Return a list of cookies in the httpRequest. The list is immutable and is created if it did not exist previously.

      The default implementation returns an immutable empty list.

      Returns:
      an immutable list of cookies in the httpRequest, the returned list can be empty but not null
      Since:
      version 2.0.2

    • getCookie

      String getCookie(String key)

    • getContentLength

      long getContentLength()

    • getStatusCode

      int getStatusCode()

    • getRequestContent

      String getRequestContent()

    • getResponseContent

      String getResponseContent()

    • getLocalPort

      int getLocalPort()

    • getServerAdapter

      ServerAdapter getServerAdapter()

    • getResponseHeader

      String getResponseHeader(String key)

    • getResponseHeaderMap

      Map<String,String> getResponseHeaderMap()

    • getResponseHeaderNameList

      List<String> getResponseHeaderNameList()