Package com.linecorp.armeria.client.logging

Class ContentPreviewingClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<HttpRequest,HttpResponse>

com.linecorp.armeria.client.SimpleDecoratingHttpClient

com.linecorp.armeria.client.logging.ContentPreviewingClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

public final class ContentPreviewingClient
extends SimpleDecoratingHttpClient

Decorates an HttpClient to preview the content of Requests and Responses.

Note that this decorator just sets RequestOnlyLog.requestContentPreview() and RequestLog.responseContentPreview(). You can get the previews using RequestLogAccess.

 RequestLogAccess logAccess = ctx.log();
 logAccess.whenComplete().thenApply(log -> {
     // Call log.requestContentPreview() and log.responseContentPreview() to use them.
     ...
 });
 

Method Summary

Modifier and Type	Method	Description
HttpResponse	execute(ClientRequestContext ctx, HttpRequest req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
static Function<? super HttpClient,ContentPreviewingClient>	newDecorator(int maxLength)	Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit.
static Function<? super HttpClient,ContentPreviewingClient>	newDecorator(int maxLength, Charset defaultCharset)	Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit.
static Function<? super HttpClient,ContentPreviewingClient>	newDecorator(ContentPreviewerFactory contentPreviewerFactory)	Creates a new ContentPreviewingClient decorator with the specified ContentPreviewerFactory.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Method Details

newDecorator

public static Function<? super HttpClient,ContentPreviewingClient> newDecorator(int maxLength)

Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit. The preview is produced when 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

newDecorator

public static Function<? super HttpClient,ContentPreviewingClient> newDecorator(int maxLength, Charset defaultCharset)

Creates a new ContentPreviewingClient decorator which produces text preview with the specified maxLength limit. The preview is produced when 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

newDecorator

public static Function<? super HttpClient,ContentPreviewingClient> newDecorator(ContentPreviewerFactory contentPreviewerFactory)

Creates a new ContentPreviewingClient decorator with the specified ContentPreviewerFactory.

execute

public HttpResponse execute(ClientRequestContext ctx, HttpRequest req) throws Exception

Description copied from interface: Client

Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().

Returns:

the Response to the specified Request

Throws:

Exception