Package com.linecorp.armeria.common.logging

Class TextHeadersSanitizerBuilder

java.lang.Object

com.linecorp.armeria.common.logging.TextHeadersSanitizerBuilder

public final class TextHeadersSanitizerBuilder
extends Object

A builder implementation for Text HeadersSanitizer.

Constructor Summary

Constructors

Constructor	Description
TextHeadersSanitizerBuilder()

Method Summary

Modifier and Type	Method	Description
HeadersSanitizer<String>	build()	Returns a newly created text HeadersSanitizer based on the properties of this builder.
TextHeadersSanitizerBuilder	maskingFunction(HeaderMaskingFunction maskingFunction)	Sets the Function to use to maskFunction headers before logging.
TextHeadersSanitizerBuilder	sensitiveHeaders(CharSequence... headers)	Adds the headers to mask before logging.
TextHeadersSanitizerBuilder	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

TextHeadersSanitizerBuilder

public TextHeadersSanitizerBuilder()

Method Details

sensitiveHeaders

public TextHeadersSanitizerBuilder sensitiveHeaders(CharSequence... headers)

Adds the headers to mask before logging.

sensitiveHeaders

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

Adds the headers to mask before logging.

maskingFunction

public TextHeadersSanitizerBuilder 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;
   }
 }
 

build

public HeadersSanitizer<String> build()

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