org.zalando.logbook

Class JsonHttpLogFormatter

java.lang.Object

org.zalando.logbook.JsonHttpLogFormatter

All Implemented Interfaces:

HttpLogFormatter

@API(status=STABLE)
public final class JsonHttpLogFormatter
extends Object
implements HttpLogFormatter

A custom HttpLogFormatter that produces JSON objects. It can be augmented with composition:

 

 public class CustomsFormatter implements HttpLogFormatter {

     private final JsonHttpLogFormatter delegate;

     public CustomsFormatter(final ObjectMapper mapper) {
         this.delegate = new JsonHttpLogFormatter(mapper);
     }

     public String format(final Precorrelation<HttpRequest> precorrelation) throws IOException {
         Map<String, Object> request = delegate.prepare(precorrelation);
         // TODO modify request here
         return delegate.format(request);
     }

     public String format(final Correlation<HttpRequest, HttpResponse> correlation) throws IOException {
         Map<String, Object> response = delegate.prepare(correlation);
         // TODO modify response here
         return delegate.format(response);
      }

 }
 
 

Constructor Summary

Constructors

Constructor and Description
JsonHttpLogFormatter()
JsonHttpLogFormatter(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
String	format(Correlation<HttpRequest,HttpResponse> correlation)
String	format(Map<String,Object> content) Renders properties of an HTTP message into a JSON string.
String	format(Precorrelation<HttpRequest> precorrelation)
Map<String,Object>	prepare(Correlation<HttpRequest,HttpResponse> correlation) Produces a map of individual properties from an HTTP response.
Map<String,Object>	prepare(Precorrelation<HttpRequest> precorrelation) Produces a map of individual properties from an HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonHttpLogFormatter

public JsonHttpLogFormatter()

JsonHttpLogFormatter

public JsonHttpLogFormatter(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

format

public String format(Precorrelation<HttpRequest> precorrelation)
              throws IOException

Specified by:

format in interface HttpLogFormatter

Throws:

IOException

prepare

@API(status=EXPERIMENTAL)
public Map<String,Object> prepare(Precorrelation<HttpRequest> precorrelation)
                                                     throws IOException

Produces a map of individual properties from an HTTP request.

Parameters:

precorrelation - the request correlation

Returns:

a map containing HTTP request attributes

Throws:

IOException - if reading body fails

See Also:

prepare(Correlation), format(Map), DefaultHttpLogFormatter.prepare(Precorrelation)

format

public String format(Correlation<HttpRequest,HttpResponse> correlation)
              throws IOException

Specified by:

format in interface HttpLogFormatter

Throws:

IOException

prepare

@API(status=EXPERIMENTAL)
public Map<String,Object> prepare(Correlation<HttpRequest,HttpResponse> correlation)
                                                     throws IOException

Produces a map of individual properties from an HTTP response.

Parameters:

correlation - the response correlation

Returns:

a map containing HTTP response attributes

Throws:

IOException - if reading body fails

See Also:

prepare(Correlation), format(Map), DefaultHttpLogFormatter.prepare(Correlation)

format

@API(status=EXPERIMENTAL)
public String format(Map<String,Object> content)
                                        throws IOException

Renders properties of an HTTP message into a JSON string.

Parameters:

content - individual parts of an HTTP message

Returns:

the whole message as a JSON object

Throws:

IOException - if writing JSON output fails

See Also:

prepare(Precorrelation), prepare(Correlation), DefaultHttpLogFormatter.format(List)