Package org.opends.server.loggers

Interface HTTPRequestInfo

All Known Implementing Classes:
HttpLogContext
public interface HTTPRequestInfo
Contains the information required for logging the HTTP request.

  • Method Details

    • getServerAddress

      String getServerAddress()
      Returns the server's host.
      Returns:
      the serverAddress

    • getServerHost

      String getServerHost()
      Returns the server's host.
      Returns:
      the serverHost

    • getServerPort

      int getServerPort()
      Returns the server's port.
      Returns:
      the serverPort

    • getClientAddress

      String getClientAddress()
      Returns the client's address.
      Returns:
      the clientAddress

    • getClientHost

      String getClientHost()
      Returns the client's host.
      Returns:
      the clientHost

    • getClientPort

      int getClientPort()
      Returns the client's port.
      Returns:
      the clientPort

    • getProtocol

      String getProtocol()
      Returns the protocol used for this request.
      Returns:
      the protocol

    • getMethod

      String getMethod()
      Returns the HTTP method/verb used for this request.
      Returns:
      the method

    • getUri

      URI getUri()
      Returns the URI issued by the client.
      Returns:
      the URI

    • getUserAgent

      String getUserAgent()
      Returns the user agent used by the client.
      Returns:
      the userAgent

    • getAuthUser

      String getAuthUser()
      Returns the username that was used to authenticate.
      Returns:
      the authUser

    • setAuthUser

      void setAuthUser(String authUser)
      Sets the username that was used to authenticate.
      Parameters:
      authUser - the authUser to set

    • getStatusCode

      int getStatusCode()
      Returns the HTTP status code returned to the client.
      Returns:
      the statusCode

    • getConnectionID

      long getConnectionID()
      Returns the unique identifier that has been assigned to the client connection for this HTTP request.
      Returns:
      The unique identifier that has been assigned to the client connection for this HTTP request

    • getTotalProcessingTime

      long getTotalProcessingTime()
      Returns the total processing time for this HTTP request.
      Returns:
      the total processing time for this HTTP request

    • getTransactionId

      String getTransactionId()
      Returns the transactionId for this request.
      Returns:
      the transactionId

    • log

      void log(int statusCode)
      Logs the current request info in the HTTP access log.
      Parameters:
      statusCode - the HTTP status code that was returned to the client.