com.linecorp.armeria.common.logging

Class RequestContextExporterBuilder

java.lang.Object

com.linecorp.armeria.common.logging.RequestContextExporterBuilder

public final class RequestContextExporterBuilder
extends Object

Builds a new RequestContextExporter.

Method Summary

Modifier and Type	Method and Description
RequestContextExporterBuilder	addAttribute(String alias, io.netty.util.AttributeKey<?> attrKey) Adds the specified AttributeKey to the export list.
RequestContextExporterBuilder	addAttribute(String alias, io.netty.util.AttributeKey<?> attrKey, Function<?,String> stringifier) Adds the specified AttributeKey to the export list.
RequestContextExporterBuilder	addBuiltIn(BuiltInProperty property) Adds the specified BuiltInProperty to the export list.
RequestContextExporterBuilder	addHttpRequestHeader(CharSequence name) Adds the specified HTTP request header name to the export list.
RequestContextExporterBuilder	addHttpResponseHeader(CharSequence name) Adds the specified HTTP response header name to the export list.
RequestContextExporterBuilder	addKeyPattern(String keyPattern) Adds the property represented by the specified key pattern to the export list.
RequestContextExporter	build() Returns a newly-created RequestContextExporter instance.
boolean	containsAttribute(io.netty.util.AttributeKey<?> key) Deprecated. This method will be removed without a replacement.
boolean	containsBuiltIn(BuiltInProperty property) Deprecated. This method will be removed without a replacement.
boolean	containsHttpRequestHeader(CharSequence name) Deprecated. This method will be removed without a replacement.
boolean	containsHttpResponseHeader(CharSequence name) Deprecated. This method will be removed without a replacement.
Map<String,io.netty.util.AttributeKey<?>>	getAttributes() Deprecated. This method will be removed without a replacement.
Set<BuiltInProperty>	getBuiltIns() Deprecated. This method will be removed without a replacement.
Set<io.netty.util.AsciiString>	getHttpRequestHeaders() Deprecated. This method will be removed without a replacement.
Set<io.netty.util.AsciiString>	getHttpResponseHeaders() Deprecated. This method will be removed without a replacement.

Methods inherited from class java.lang.Object

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

Method Detail

addBuiltIn

public RequestContextExporterBuilder addBuiltIn(BuiltInProperty property)

Adds the specified BuiltInProperty to the export list.

containsBuiltIn

@Deprecated
public boolean containsBuiltIn(BuiltInProperty property)

Deprecated. This method will be removed without a replacement.

Returns true if the specified BuiltInProperty is in the export list.

getBuiltIns

@Deprecated
public Set<BuiltInProperty> getBuiltIns()

Deprecated. This method will be removed without a replacement.

Returns all BuiltInPropertys in the export list.

addAttribute

public RequestContextExporterBuilder addAttribute(String alias,
                                                  io.netty.util.AttributeKey<?> attrKey)

Adds the specified AttributeKey to the export list.

Parameters:

alias - the alias of the attribute to export

attrKey - the key of the attribute to export

addAttribute

public RequestContextExporterBuilder addAttribute(String alias,
                                                  io.netty.util.AttributeKey<?> attrKey,
                                                  Function<?,String> stringifier)

Adds the specified AttributeKey to the export list.

Parameters:

alias - the alias of the attribute to export

attrKey - the key of the attribute to export

stringifier - the Function that converts the attribute value into a String

containsAttribute

@Deprecated
public boolean containsAttribute(io.netty.util.AttributeKey<?> key)

Deprecated. This method will be removed without a replacement.

Returns true if the specified AttributeKey is in the export list.

getAttributes

@Deprecated
public Map<String,io.netty.util.AttributeKey<?>> getAttributes()

Deprecated. This method will be removed without a replacement.

Returns all AttributeKeys in the export list.

Returns:

the Map whose key is an alias and value is an AttributeKey

addHttpRequestHeader

public RequestContextExporterBuilder addHttpRequestHeader(CharSequence name)

Adds the specified HTTP request header name to the export list.

addHttpResponseHeader

public RequestContextExporterBuilder addHttpResponseHeader(CharSequence name)

Adds the specified HTTP response header name to the export list.

containsHttpRequestHeader

@Deprecated
public boolean containsHttpRequestHeader(CharSequence name)

Deprecated. This method will be removed without a replacement.

Returns true if the specified HTTP request header name is in the export list.

containsHttpResponseHeader

@Deprecated
public boolean containsHttpResponseHeader(CharSequence name)

Deprecated. This method will be removed without a replacement.

Returns true if the specified HTTP response header name is in the export list.

getHttpRequestHeaders

@Deprecated
public Set<io.netty.util.AsciiString> getHttpRequestHeaders()

Deprecated. This method will be removed without a replacement.

Returns all HTTP request header names in the export list.

getHttpResponseHeaders

@Deprecated
public Set<io.netty.util.AsciiString> getHttpResponseHeaders()

Deprecated. This method will be removed without a replacement.

Returns all HTTP response header names in the export list.

addKeyPattern

public RequestContextExporterBuilder addKeyPattern(String keyPattern)

Adds the property represented by the specified key pattern to the export list. Please refer to the Logging contextual information in order to learn how to specify a key pattern.

build

public RequestContextExporter build()

Returns a newly-created RequestContextExporter instance.