Package com.linecorp.armeria.common.logging

Interface ContentPreviewerFactory

public interface ContentPreviewerFactory

A factory creating a ContentPreviewer.

Method Summary

Modifier and Type	Method	Description
static ContentPreviewerFactoryBuilder	builder()	Returns a newly created ContentPreviewerFactoryBuilder.
ContentPreviewer	requestContentPreviewer(RequestContext ctx, RequestHeaders headers)	Returns a newly-created request ContentPreviewer with the given RequestContext and RequestHeaders.
ContentPreviewer	responseContentPreviewer(RequestContext ctx, ResponseHeaders resHeaders)	Returns a newly-created response ContentPreviewer with the given RequestContext and ResponseHeaders.
static ContentPreviewerFactory	text(int maxLength)	Returns a new ContentPreviewerFactory which creates a ContentPreviewer.
static ContentPreviewerFactory	text(int maxLength, Charset defaultCharset)	Returns a new ContentPreviewerFactory which creates a ContentPreviewer.

Method Details

builder

static ContentPreviewerFactoryBuilder builder()

Returns a newly created ContentPreviewerFactoryBuilder.

text

static ContentPreviewerFactory text(int maxLength)

Returns a new ContentPreviewerFactory which creates a ContentPreviewer. The ContentPreviewer produces the text with the maxLength limit if the content type of the RequestHeaders or ResponseHeaders meets any of the following conditions:

• when it matches text/* or application/x-www-form-urlencoded
• when its charset has been specified
• when its subtype is "xml" or "json"
• when its subtype ends with "+xml" or "+json"

Parameters:

maxLength - the maximum length of the preview

text

static ContentPreviewerFactory text(int maxLength,
Charset defaultCharset)

Returns a new ContentPreviewerFactory which creates a ContentPreviewer. The ContentPreviewer produces the text with the maxLength limit if the content type of the RequestHeaders or ResponseHeaders meets any of the following conditions:

• when it matches text/* or application/x-www-form-urlencoded
• when its charset has been specified
• when its subtype is "xml" or "json"
• when its subtype ends with "+xml" or "+json"

Parameters:

maxLength - the maximum length of the preview

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

requestContentPreviewer

ContentPreviewer requestContentPreviewer(RequestContext ctx,
RequestHeaders headers)

Returns a newly-created request ContentPreviewer with the given RequestContext and RequestHeaders. Note that the returned ContentPreviewer can be ContentPreviewer.disabled().

responseContentPreviewer

ContentPreviewer responseContentPreviewer(RequestContext ctx,
ResponseHeaders resHeaders)

Returns a newly-created response ContentPreviewer with the given RequestContext and ResponseHeaders. Note that the returned ContentPreviewer can be ContentPreviewer.disabled().