Package ca.uhn.fhir.rest.server.interceptor

Class ResponseSizeCapturingInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

public class ResponseSizeCapturingInterceptor
extends Object

This interceptor captures and makes available the number of characters written (pre-compression if Gzip compression is being used) to the HTTP response stream for FHIR responses.

Response details are made available in the request RequestDetails UserData map with RESPONSE_RESULT_KEY as the key.

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponseSizeCapturingInterceptor.Result	Contains the results of the capture

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESPONSE_RESULT_KEY	If the response was a character stream, a character count will be placed in the RequestDetails UserData map with this key, containing an ResponseSizeCapturingInterceptor.Result value.

Constructor Summary

Constructors

Constructor	Description
ResponseSizeCapturingInterceptor()

Method Summary

Modifier and Type	Method	Description
Writer	capture(RequestDetails theRequestDetails, Writer theWriter)
void	completed(RequestDetails theRequestDetails)
void	registerConsumer(Consumer<ResponseSizeCapturingInterceptor.Result> theConsumer)	Registers a new consumer.

Methods inherited from class java.lang.Object

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

Field Details

RESPONSE_RESULT_KEY

public static final String RESPONSE_RESULT_KEY

If the response was a character stream, a character count will be placed in the RequestDetails UserData map with this key, containing an ResponseSizeCapturingInterceptor.Result value.

The value will be placed at the start of the Pointcut.SERVER_PROCESSING_COMPLETED pointcut, so it will not be available before that time.

Constructor Details

ResponseSizeCapturingInterceptor

public ResponseSizeCapturingInterceptor()

Method Details

capture

public Writer capture(RequestDetails theRequestDetails,
 Writer theWriter)

completed

public void completed(RequestDetails theRequestDetails)

registerConsumer

public void registerConsumer(@Nonnull
 Consumer<ResponseSizeCapturingInterceptor.Result> theConsumer)

Registers a new consumer. All consumers will be notified each time a request is complete.

Parameters:

theConsumer - The consumer