net.logstash.logback.composite

Class CompositeJsonFormatter<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

net.logstash.logback.composite.CompositeJsonFormatter<Event>

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Implemented Interfaces:

ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

Direct Known Subclasses:

AccessEventCompositeJsonFormatter, LoggingEventCompositeJsonFormatter

public abstract class CompositeJsonFormatter<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends ch.qos.logback.core.spi.ContextAwareBase
implements ch.qos.logback.core.spi.LifeCycle

Formats logstash Events as JSON using JsonProviders.

The CompositeJsonFormatter starts the JSON object ('{'), then delegates writing the contents of the object to the JsonProviders, and then ends the JSON object ('}').

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
CompositeJsonFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin)

Method Summary

Methods

Modifier and Type	Method and Description
String	getEncoding()
com.fasterxml.jackson.core.JsonFactory	getJsonFactory()
JsonFactoryDecorator	getJsonFactoryDecorator()
JsonGeneratorDecorator	getJsonGeneratorDecorator()
JsonProviders<Event>	getProviders()
boolean	isStarted()
protected void	prepareForDeferredProcessing(Event event)
void	setEncoding(String encodingName)
void	setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)
void	setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)
void	setProviders(JsonProviders<Event> jsonProviders)
void	start()
void	stop()
byte[]	writeEventAsBytes(Event event)
String	writeEventAsString(Event event)
protected void	writeEventToGenerator(com.fasterxml.jackson.core.JsonGenerator generator, Event event)
void	writeEventToOutputStream(Event event, OutputStream outputStream)

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

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeJsonFormatter

public CompositeJsonFormatter(ch.qos.logback.core.spi.ContextAware declaredOrigin)

Method Detail

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ch.qos.logback.core.spi.LifeCycle

writeEventAsBytes

public byte[] writeEventAsBytes(Event event)
                         throws IOException

Throws:

IOException

writeEventToOutputStream

public void writeEventToOutputStream(Event event,
                            OutputStream outputStream)
                              throws IOException

Throws:

IOException

writeEventAsString

public String writeEventAsString(Event event)
                          throws IOException

Throws:

IOException

writeEventToGenerator

protected void writeEventToGenerator(com.fasterxml.jackson.core.JsonGenerator generator,
                         Event event)
                              throws IOException

Throws:

IOException

prepareForDeferredProcessing

protected void prepareForDeferredProcessing(Event event)

getJsonFactory

public com.fasterxml.jackson.core.JsonFactory getJsonFactory()

getJsonFactoryDecorator

public JsonFactoryDecorator getJsonFactoryDecorator()

setJsonFactoryDecorator

public void setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)

getJsonGeneratorDecorator

public JsonGeneratorDecorator getJsonGeneratorDecorator()

setJsonGeneratorDecorator

public void setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)

getProviders

public JsonProviders<Event> getProviders()

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encodingName)

setProviders

public void setProviders(JsonProviders<Event> jsonProviders)