org.hawaiiframework.logging.util

Class HttpRequestResponseLogUtil

java.lang.Object

org.hawaiiframework.logging.util.HttpRequestResponseLogUtil

public class HttpRequestResponseLogUtil
extends java.lang.Object

Utility for logging requests / responses.

The utility can be used to generate HTTP request / response log strings. Both for incoming service calls as outgoing calls (i.e. calls to backend systems).

Since:

2.0.0

Author:

Rutger Lubbers

Constructor Summary

Constructors

Constructor and Description
HttpRequestResponseLogUtil()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createLogString(org.springframework.http.HttpHeaders headers, byte[] body) Create a log string for the given headers and body with the platform's default charset.
java.lang.String	createLogString(org.springframework.http.HttpHeaders headers, byte[] body, java.nio.charset.Charset charset) Create a log string for the given headers and body with the given charset.
java.lang.String	createLogString(org.springframework.http.HttpHeaders headers, byte[] body, java.lang.String characterEncoding) Create a log string for the given headers and body with the given characterEncoding.
java.lang.String	createLogString(org.springframework.http.HttpHeaders headers, java.lang.String body) Create a log string for the given headers and body with the platform's default charset.
java.lang.String	createLogString(java.lang.String requestLine, org.springframework.http.HttpHeaders headers, byte[] body, java.nio.charset.Charset charset) Create a log string for the given requestLine, headers and body.
java.lang.String	createLogString(java.lang.String requestLine, org.springframework.http.HttpHeaders headers, byte[] body, java.lang.String characterEncoding) Create a log string for the given requestLine, headers and body.
java.lang.String	createLogString(java.lang.String requestLine, org.springframework.http.HttpHeaders headers, java.lang.String body) Create a log string for the given requestLine, headers and body.
java.lang.String	createRequestLine(java.lang.String request, java.lang.String protocol) Create a request line for the requestUri and protocol.
java.lang.String	formatRequest(java.lang.String request, javax.servlet.http.HttpServletRequest servletRequest) Format the request as a nicely formatted string.
org.springframework.http.HttpHeaders	getHeaders(javax.servlet.http.HttpServletRequest request) Create HttpHeaders for the request.
org.springframework.http.HttpHeaders	getHeaders(javax.servlet.http.HttpServletResponse response) Create HttpHeaders for the response.
java.lang.String	getRequestUri(javax.servlet.http.HttpServletRequest servletRequest) Transform the request into a log line.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestResponseLogUtil

public HttpRequestResponseLogUtil()

Method Detail

getHeaders

public org.springframework.http.HttpHeaders getHeaders(javax.servlet.http.HttpServletRequest request)

Create HttpHeaders for the request.

getHeaders

public org.springframework.http.HttpHeaders getHeaders(javax.servlet.http.HttpServletResponse response)

Create HttpHeaders for the response.

createRequestLine

public java.lang.String createRequestLine(java.lang.String request,
                                          java.lang.String protocol)

Create a request line for the requestUri and protocol.

For example: GET /doc/test.html HTTP/1.1.

createLogString

public java.lang.String createLogString(org.springframework.http.HttpHeaders headers,
                                        java.lang.String body)

Create a log string for the given headers and body with the platform's default charset.

createLogString

public java.lang.String createLogString(org.springframework.http.HttpHeaders headers,
                                        byte[] body)

Create a log string for the given headers and body with the platform's default charset.

createLogString

public java.lang.String createLogString(org.springframework.http.HttpHeaders headers,
                                        byte[] body,
                                        java.lang.String characterEncoding)

Create a log string for the given headers and body with the given characterEncoding.

createLogString

public java.lang.String createLogString(org.springframework.http.HttpHeaders headers,
                                        byte[] body,
                                        java.nio.charset.Charset charset)

Create a log string for the given headers and body with the given charset.

createLogString

public java.lang.String createLogString(java.lang.String requestLine,
                                        org.springframework.http.HttpHeaders headers,
                                        byte[] body,
                                        java.lang.String characterEncoding)

Create a log string for the given requestLine, headers and body.

createLogString

public java.lang.String createLogString(java.lang.String requestLine,
                                        org.springframework.http.HttpHeaders headers,
                                        byte[] body,
                                        java.nio.charset.Charset charset)

Create a log string for the given requestLine, headers and body.

createLogString

public java.lang.String createLogString(java.lang.String requestLine,
                                        org.springframework.http.HttpHeaders headers,
                                        java.lang.String body)

Create a log string for the given requestLine, headers and body.

getRequestUri

public java.lang.String getRequestUri(javax.servlet.http.HttpServletRequest servletRequest)

Transform the request into a log line.

formatRequest

public java.lang.String formatRequest(java.lang.String request,
                                      javax.servlet.http.HttpServletRequest servletRequest)
                               throws java.io.IOException

Format the request as a nicely formatted string.

Note that this will read the request! Use ResettableHttpServletRequest for instance to reset the input.

Throws:

java.io.IOException