com.linecorp.armeria.common.logging

Interface ContentPreviewer

All Known Implementing Classes:

ContentPreviewerAdapter

public interface ContentPreviewer

Produces the preview of RequestLog.

Method Summary

Modifier and Type	Method and Description
static ContentPreviewer	disabled() A dummy ContentPreviewer which discards everything it collected and produces null.
boolean	isDone() Determines if the previewer has been ready to produce the preview or the preview has been already produced.
static ContentPreviewer	ofBinary(int length, BiFunction<? super HttpHeaders,? super io.netty.buffer.ByteBuf,String> reproducer) Creates a new instance of ContentPreviewer which produces the preview through reproducer when the contents have been aggregated more than length bytes.
static ContentPreviewer	ofBinary(int length, Function<? super io.netty.buffer.ByteBuf,String> reproducer) Creates a new instance of ContentPreviewer which produces the preview through reproducer when the contents have been aggregated more than length bytes.
static ContentPreviewer	ofText(int length) Creates a new instance of ContentPreviewer which produces the text with the maximum length limit.
static ContentPreviewer	ofText(int length, Charset defaultCharset) Creates a new instance of ContentPreviewer which produces the text with the maximum length limit.
void	onData(HttpData data) Invoked after request/response data is received.
void	onHeaders(HttpHeaders headers) Invoked after request/response headers is received.
String	produce() Produces the preview of RequestLog.

Method Detail

ofBinary

static ContentPreviewer ofBinary(int length,
                                 Function<? super io.netty.buffer.ByteBuf,String> reproducer)

Creates a new instance of ContentPreviewer which produces the preview through reproducer when the contents have been aggregated more than length bytes.

ofBinary

static ContentPreviewer ofBinary(int length,
                                 BiFunction<? super HttpHeaders,? super io.netty.buffer.ByteBuf,String> reproducer)

Creates a new instance of ContentPreviewer which produces the preview through reproducer when the contents have been aggregated more than length bytes.

ofText

static ContentPreviewer ofText(int length,
                               Charset defaultCharset)

Creates a new instance of ContentPreviewer which produces the text with the maximum length limit.

Parameters:

length - the maximum length of the preview

defaultCharset - the default charset used when a charset is not specified in the "content-type" header

ofText

static ContentPreviewer ofText(int length)

Creates a new instance of ContentPreviewer which produces the text with the maximum length limit.

Parameters:

length - the maximum length of the preview.

disabled

static ContentPreviewer disabled()

A dummy ContentPreviewer which discards everything it collected and produces null.

onHeaders

void onHeaders(HttpHeaders headers)

Invoked after request/response headers is received.

onData

void onData(HttpData data)

Invoked after request/response data is received. Note that it is not invoked when the request/response is completed or isDone() returns true even if a new content is received.

produce

@Nullable
String produce()

Produces the preview of RequestLog. Note that it is invoked when the request or response is ended or the preview has been ready to be produced.

Returns:

the preview, or null if disabled.

isDone

boolean isDone()

Determines if the previewer has been ready to produce the preview or the preview has been already produced.