Package com.linecorp.armeria.common.logging

Class JsonHeadersSanitizerBuilder

java.lang.Object

com.linecorp.armeria.common.logging.JsonHeadersSanitizerBuilder

public final class JsonHeadersSanitizerBuilder
extends Object

A builder implementation for JSON HeadersSanitizer.

Constructor Summary

Constructors

Constructor	Description
JsonHeadersSanitizerBuilder()

Method Summary

Modifier and Type	Method	Description
HeadersSanitizer<com.fasterxml.jackson.databind.JsonNode>	build()	Returns a newly created JSON HeadersSanitizer based on the properties of this builder.
JsonHeadersSanitizerBuilder	maskingFunction(HeaderMaskingFunction maskingFunction)	Sets the Function to use to maskFunction headers before logging.
JsonHeadersSanitizerBuilder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Sets the ObjectMapper that will be used to convert headers into a JsonNode.
JsonHeadersSanitizerBuilder	sensitiveHeaders(CharSequence... headers)	Adds the headers to mask before logging.
JsonHeadersSanitizerBuilder	sensitiveHeaders(Iterable<? extends CharSequence> headers)	Adds the headers to mask before logging.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonHeadersSanitizerBuilder

public JsonHeadersSanitizerBuilder()

Method Details

sensitiveHeaders

public JsonHeadersSanitizerBuilder sensitiveHeaders(CharSequence... headers)

Adds the headers to mask before logging.

sensitiveHeaders

public JsonHeadersSanitizerBuilder sensitiveHeaders(Iterable<? extends CharSequence> headers)

Adds the headers to mask before logging.

maskingFunction

public JsonHeadersSanitizerBuilder maskingFunction(HeaderMaskingFunction maskingFunction)

Sets the Function to use to maskFunction headers before logging. The default maskingFunction is HeaderMaskingFunction.of()

 builder.maskingFunction((name, value) -> {
   if (name.equals(HttpHeaderNames.AUTHORIZATION)) {
     return "****";
   } else if (name.equals(HttpHeaderNames.COOKIE)) {
     return name.substring(0, 4) + "****";
   } else {
     return value;
   }
 }
 

objectMapper

public JsonHeadersSanitizerBuilder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the ObjectMapper that will be used to convert headers into a JsonNode.

build

public HeadersSanitizer<com.fasterxml.jackson.databind.JsonNode> build()

Returns a newly created JSON HeadersSanitizer based on the properties of this builder.