Package com.linecorp.armeria.common.logging

Class RequestContextExporter

java.lang.Object

com.linecorp.armeria.common.logging.RequestContextExporter

public final class RequestContextExporter
extends Object

Exports the specified properties from current RequestContext to Map.

Method Summary

Modifier and Type	Method	Description
Map<String,AttributeKey<?>>	attributes()	Returns all AttributeKeys in the export list.
static RequestContextExporterBuilder	builder()	Returns a newly created RequestContextExporterBuilder.
Set<BuiltInProperty>	builtIns()	Returns all BuiltInPropertys in the export list.
boolean	containsAttribute(AttributeKey<?> key)	Returns true if the specified AttributeKey is in the export list.
boolean	containsBuiltIn(BuiltInProperty property)	Returns true if the specified BuiltInProperty is in the export list.
boolean	containsRequestHeader(CharSequence name)	Returns true if the specified HTTP request header name is in the export list.
boolean	containsResponseHeader(CharSequence name)	Returns true if the specified HTTP response header name is in the export list.
Map<String,String>	export()	Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from RequestContext.
Map<String,String>	export(RequestContext ctx)	Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from the specified RequestContext.
Set<AsciiString>	requestHeaders()	Returns all HTTP request header names in the export list.
Set<AsciiString>	responseHeaders()	Returns all HTTP response header names in the export list.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RequestContextExporterBuilder builder()

Returns a newly created RequestContextExporterBuilder.

containsAttribute

public boolean containsAttribute(AttributeKey<?> key)

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

containsRequestHeader

public boolean containsRequestHeader(CharSequence name)

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

containsResponseHeader

public boolean containsResponseHeader(CharSequence name)

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

containsBuiltIn

public boolean containsBuiltIn(BuiltInProperty property)

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

builtIns

public Set<BuiltInProperty> builtIns()

Returns all BuiltInPropertys in the export list.

attributes

public Map<String,AttributeKey<?>> attributes()

Returns all AttributeKeys in the export list.

Returns:

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

requestHeaders

public Set<AsciiString> requestHeaders()

Returns all HTTP request header names in the export list.

responseHeaders

public Set<AsciiString> responseHeaders()

Returns all HTTP response header names in the export list.

export

public Map<String,String> export()

Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from RequestContext. Note that this method returns an empty Map if current RequestContext is null.

export

public Map<String,String> export(RequestContext ctx)

Returns a Map whose key is an export key set through add*() in RequestContextExporterBuilder and value is extracted from the specified RequestContext.