Package com.linecorp.armeria.server.logging

Class ContentPreviewingService

java.lang.Object

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

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.logging.ContentPreviewingService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class ContentPreviewingService
extends SimpleDecoratingHttpService

Decorates an HttpService 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
static ContentPreviewingServiceBuilder	builder(ContentPreviewerFactory contentPreviewerFactory)	Returns a newly-created ContentPreviewingServiceBuilder.
static Function<? super HttpService,ContentPreviewingService>	newDecorator(int maxLength)	Creates a new ContentPreviewingService decorator which produces text preview with the specified maxLength limit.
static Function<? super HttpService,ContentPreviewingService>	newDecorator(int maxLength, Charset defaultCharset)	Creates a new ContentPreviewingService decorator which produces text preview with the specified maxLength limit.
static Function<? super HttpService,ContentPreviewingService>	newDecorator(ContentPreviewerFactory contentPreviewerFactory)	Creates a new ContentPreviewingService decorator with the specified ContentPreviewerFactory.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.

Methods inherited from class com.linecorp.armeria.server.SimpleDecoratingHttpService

exchangeType

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

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

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super HttpService,ContentPreviewingService> newDecorator(int maxLength)

Creates a new ContentPreviewingService 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 HttpService,ContentPreviewingService> newDecorator(int maxLength,
 Charset defaultCharset)

Creates a new ContentPreviewingService 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 HttpService,ContentPreviewingService> newDecorator(ContentPreviewerFactory contentPreviewerFactory)

Creates a new ContentPreviewingService decorator with the specified ContentPreviewerFactory.

builder

public static ContentPreviewingServiceBuilder builder(ContentPreviewerFactory contentPreviewerFactory)

Returns a newly-created ContentPreviewingServiceBuilder.

serve

public HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                   throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception