org.zalando.logbook

Class DefaultHttpLogFormatter

java.lang.Object

org.zalando.logbook.DefaultHttpLogFormatter

All Implemented Interfaces:

HttpLogFormatter

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

Constructor Summary

Constructors

Constructor and Description
DefaultHttpLogFormatter()

Method Summary

Modifier and Type	Method and Description
String	format(Correlation<HttpRequest,HttpResponse> correlation)
String	format(List<String> lines) Renders an HTTP-like message into a printable string.
String	format(Precorrelation<HttpRequest> precorrelation)
List<String>	prepare(Correlation<HttpRequest,HttpResponse> correlation) Produces an HTTP-like response in individual lines.
List<String>	prepare(Precorrelation<HttpRequest> precorrelation) Produces an HTTP-like request in individual lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttpLogFormatter

public DefaultHttpLogFormatter()

Method Detail

format

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

Specified by:

format in interface HttpLogFormatter

Throws:

IOException

prepare

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

Produces an HTTP-like request in individual lines.

Parameters:

precorrelation - the request correlation

Returns:

a line-separated HTTP request

Throws:

IOException - if reading body fails

See Also:

prepare(Correlation), format(List), JsonHttpLogFormatter.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 List<String> prepare(Correlation<HttpRequest,HttpResponse> correlation)
                                               throws IOException

Produces an HTTP-like response in individual lines.

Pr@param correlation the response correlation

Parameters:

correlation - the correlated request and response pair

Returns:

a line-separated HTTP response

Throws:

IOException - if reading body fails

See Also:

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

format

@API(status=EXPERIMENTAL)
public String format(List<String> lines)

Renders an HTTP-like message into a printable string.

Parameters:

lines - lines of an HTTP message

Returns:

the whole message as a single string, separated by new lines

See Also:

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