Class AbstractJsonProvider<Event extends DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Implemented Interfaces:

ContextAware, JsonProvider<Event>

Direct Known Subclasses:

AbstractFieldJsonProvider, AbstractPatternJsonProvider, GlobalCustomFieldsJsonProvider, LogstashMarkersJsonProvider

public abstract class AbstractJsonProvider<Event extends DeferredProcessingAware>
extends ContextAwareBase
implements JsonProvider<Event>

Base JsonProvider that provides default implementations for standard methods.

Field Summary

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
AbstractJsonProvider()

Method Summary

Modifier and Type	Method	Description
protected void	assertIsStarted()	Assert the component is started and throw IllegalStateException if not
boolean	isStarted()	Report whether the provider is started or not.
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	start()	Start the provider after all configuration properties are set.
void	stop()	Stop the provider

Methods inherited from class ContextAwareBase

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

Methods inherited from class Object

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

Methods inherited from interface ContextAware

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

Methods inherited from interface JsonProvider

writeTo

Constructor Details

AbstractJsonProvider

public AbstractJsonProvider()

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>

stop

public void stop()

Description copied from interface: JsonProvider

Stop the provider

Specified by:

stop in interface JsonProvider<Event extends DeferredProcessingAware>

isStarted

public boolean isStarted()

Description copied from interface: JsonProvider

Report whether the provider is started or not.

Specified by:

isStarted in interface JsonProvider<Event extends DeferredProcessingAware>

Returns:

true if the provider is started, false otherwise.

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>

Parameters:

event - the event to prepare for deferred processing

assertIsStarted

protected void assertIsStarted()

Assert the component is started and throw IllegalStateException if not

Throws:

IllegalStateException - if component is not started