Module logstash.logback.encoder

Package net.logstash.logback.composite

Class AbstractNestedJsonProvider<Event extends DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

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

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Implemented Interfaces:

ContextAware, JsonFactoryAware, JsonProvider<Event>

Direct Known Subclasses:

AccessEventNestedJsonProvider, LoggingEventNestedJsonProvider

public abstract class AbstractNestedJsonProvider<Event extends DeferredProcessingAware>
extends AbstractFieldJsonProvider<Event>
implements JsonFactoryAware

A JsonProvider that nests other providers within a subobject.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_NESTED

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

context

Constructor Summary

Constructors

Constructor	Description
AbstractNestedJsonProvider()

Method Summary

Modifier and Type	Method	Description
JsonProviders<Event>	getProviders()
void	prepareForDeferredProcessing(Event event)	Gives the provider a chance to perform more deferred processing (in addition to what is already provided by DeferredProcessingAware.prepareForDeferredProcessing()).
void	setJsonFactory(JsonFactory jsonFactory)
void	setProviders(JsonProviders<Event> jsonProviders)
void	start()	Start the provider after all configuration properties are set.
void	stop()	Stop the provider
void	writeTo(JsonGenerator generator, Event event)	Writes information about the event, to the given generator.

Methods inherited from class net.logstash.logback.composite.AbstractFieldJsonProvider

getFieldName, setFieldName

Methods inherited from class net.logstash.logback.composite.AbstractJsonProvider

assertIsStarted, isStarted

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

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

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Details

FIELD_NESTED

public static final String FIELD_NESTED

See Also:

• Constant Field Values

Constructor Details

AbstractNestedJsonProvider

public AbstractNestedJsonProvider()

Method Details

start

public void start()

Description copied from interface: JsonProvider

Start the provider after all configuration properties are set.

Specified by:

start in interface JsonProvider<Event extends DeferredProcessingAware>

Overrides:

start in class AbstractJsonProvider<Event extends DeferredProcessingAware>

stop

public void stop()

Description copied from interface: JsonProvider

Stop the provider

Specified by:

stop in interface JsonProvider<Event extends DeferredProcessingAware>

Overrides:

stop in class AbstractJsonProvider<Event extends DeferredProcessingAware>

writeTo

public void writeTo(JsonGenerator generator,
 Event event)
             throws IOException

Description copied from interface: JsonProvider

Writes information about the event, to the given generator.

When called, the generator is assumed to be within a JSON object context (i.e. this provider should write fields and their values to the generator). Upon return, the generator should be within the same JSON object context.

Specified by:

writeTo in interface JsonProvider<Event extends DeferredProcessingAware>

Parameters:

generator - the JsonGenerator to produce JSON content

event - the event to convert into JSON

Throws:

IOException - if an I/O error occurs

getProviders

public JsonProviders<Event> getProviders()

setProviders

public void setProviders(JsonProviders<Event> jsonProviders)

setJsonFactory

public void setJsonFactory(JsonFactory jsonFactory)

Specified by:

setJsonFactory in interface JsonFactoryAware

prepareForDeferredProcessing

public void prepareForDeferredProcessing(Event event)

Description copied from interface: JsonProvider

Gives the provider a chance to perform more deferred processing (in addition to what is already provided by DeferredProcessingAware.prepareForDeferredProcessing()).

Specified by:

prepareForDeferredProcessing in interface JsonProvider<Event extends DeferredProcessingAware>

Overrides:

prepareForDeferredProcessing in class AbstractJsonProvider<Event extends DeferredProcessingAware>

Parameters:

event - the event to prepare for deferred processing