HeadersSanitizer (Armeria 1.29.3 API reference)

All Superinterfaces:: BiFunction<RequestContext,HttpHeaders,T>

Functional Interface:: This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public interface HeadersSanitizer<T> extends BiFunction<RequestContext,HttpHeaders,T>

A sanitizer that sanitizes HttpHeaders.

Method Summary

Modifier and Type

Method

Description

default T

apply(RequestContext requestContext, HttpHeaders entries)

static JsonHeadersSanitizerBuilder

builderForJson()

Returns a newly created JsonHeadersSanitizerBuilder.

static TextHeadersSanitizerBuilder

builderForText()

Returns a newly created TextHeadersSanitizerBuilder.

static HeadersSanitizer<JsonNode>

ofJson()

Returns the default JSON HeadersSanitizer that masks HttpHeaderNames.AUTHORIZATION, HttpHeaderNames.COOKIE, HttpHeaderNames.SET_COOKIE, and HttpHeaderNames.PROXY_AUTHORIZATION with ****.

static HeadersSanitizer<String>

ofText()

Returns the default text HeadersSanitizer that masks HttpHeaderNames.AUTHORIZATION, HttpHeaderNames.COOKIE, HttpHeaderNames.SET_COOKIE, and HttpHeaderNames.PROXY_AUTHORIZATION with ****.

T

sanitize(RequestContext requestContext, HttpHeaders headers)

Sanitizes the specified HttpHeaders.

Methods inherited from interface java.util.function.BiFunction
andThen

Method Details
- ofText
  
  static HeadersSanitizer<String> ofText()
  
  Returns the default text HeadersSanitizer that masks HttpHeaderNames.AUTHORIZATION, HttpHeaderNames.COOKIE, HttpHeaderNames.SET_COOKIE, and HttpHeaderNames.PROXY_AUTHORIZATION with ****.
- builderForText
  
  static TextHeadersSanitizerBuilder builderForText()
  
  Returns a newly created TextHeadersSanitizerBuilder.
- ofJson
  
  static HeadersSanitizer<JsonNode> ofJson()
  
  Returns the default JSON HeadersSanitizer that masks HttpHeaderNames.AUTHORIZATION, HttpHeaderNames.COOKIE, HttpHeaderNames.SET_COOKIE, and HttpHeaderNames.PROXY_AUTHORIZATION with ****.
- builderForJson
  
  static JsonHeadersSanitizerBuilder builderForJson()
  
  Returns a newly created JsonHeadersSanitizerBuilder.
- sanitize
  
  @Nullable T sanitize(RequestContext requestContext, HttpHeaders headers)
  
  Sanitizes the specified HttpHeaders. If null is returned, the specified HttpHeaders will be excluded from the log.
- apply
  
  @Nullable default T apply(RequestContext requestContext, HttpHeaders entries)
  
  Specified by:
  
  apply in interface BiFunction<RequestContext,HttpHeaders,T>