Package io.dropwizard.logging.json.layout

Class AccessJsonLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.LayoutBase<E>

io.dropwizard.logging.json.layout.AbstractJsonLayout<ch.qos.logback.access.spi.IAccessEvent>

io.dropwizard.logging.json.layout.AccessJsonLayout

All Implemented Interfaces:

ch.qos.logback.core.Layout<ch.qos.logback.access.spi.IAccessEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class AccessJsonLayout
extends AbstractJsonLayout<ch.qos.logback.access.spi.IAccessEvent>

Builds JSON messages from access log events as IAccessEvent.

Field Summary

Fields inherited from class ch.qos.logback.core.LayoutBase

started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
AccessJsonLayout(JsonFormatter jsonFormatter, TimestampFormatter timestampFormatter, Set<AccessAttribute> includes, Map<String,String> customFieldNames, Map<String,Object> additionalFields)

Method Summary

Modifier and Type	Method	Description
Set<AccessAttribute>	getIncludes()
@Nullable String	getJsonProtocolVersion()
Set<String>	getRequestAttributes()
Set<String>	getRequestHeaders()
Set<String>	getResponseHeaders()
void	setIncludes(Set<AccessAttribute> includes)
void	setJsonProtocolVersion(@Nullable String jsonProtocolVersion)
void	setRequestAttributes(Set<String> requestAttributes)
void	setRequestHeaders(Set<String> requestHeaders)
void	setResponseHeaders(Set<String> responseHeaders)
protected Map<String,Object>	toJsonMap(ch.qos.logback.access.spi.IAccessEvent event)	Converts the provided logging event to a generic Map

Methods inherited from class io.dropwizard.logging.json.layout.AbstractJsonLayout

doLayout

Methods inherited from class ch.qos.logback.core.LayoutBase

getContentType, getContext, getFileFooter, getFileHeader, getPresentationFooter, getPresentationHeader, isStarted, setContext, setFileFooter, setFileHeader, setPresentationFooter, setPresentationHeader, start, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getDeclaredOrigin, getStatusManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn

Constructor Detail

AccessJsonLayout

public AccessJsonLayout(JsonFormatter jsonFormatter,
                        TimestampFormatter timestampFormatter,
                        Set<AccessAttribute> includes,
                        Map<String,String> customFieldNames,
                        Map<String,Object> additionalFields)

Method Detail

toJsonMap

protected Map<String,Object> toJsonMap(ch.qos.logback.access.spi.IAccessEvent event)

Description copied from class: AbstractJsonLayout

Converts the provided logging event to a generic Map

Specified by:

toJsonMap in class AbstractJsonLayout<ch.qos.logback.access.spi.IAccessEvent>

getIncludes

public Set<AccessAttribute> getIncludes()

setIncludes

public void setIncludes(Set<AccessAttribute> includes)

getJsonProtocolVersion

public @Nullable String getJsonProtocolVersion()

setJsonProtocolVersion

public void setJsonProtocolVersion(@Nullable String jsonProtocolVersion)

getRequestHeaders

public Set<String> getRequestHeaders()

setRequestHeaders

public void setRequestHeaders(Set<String> requestHeaders)

getResponseHeaders

public Set<String> getResponseHeaders()

setResponseHeaders

public void setResponseHeaders(Set<String> responseHeaders)

getRequestAttributes

public Set<String> getRequestAttributes()

Since:

2.0

setRequestAttributes

public void setRequestAttributes(Set<String> requestAttributes)

Since:

2.0