Module logstash.logback.encoder

Package net.logstash.logback.decorate

Interface JsonFactoryDecorator

All Known Implementing Classes:

CborJsonFactoryDecorator, CharacterEscapesJsonFactoryDecorator, CompositeJsonFactoryDecorator, EscapeNonAsciiJsonFactoryDecorator, FeatureJsonFactoryDecorator, NullJsonFactoryDecorator, SmileJsonFactoryDecorator, YamlJsonFactoryDecorator

public interface JsonFactoryDecorator

Decorates the JsonFactory used by a AbstractCompositeJsonFormatter.

This allows you to customize the factory used by the formatters.

Implementations must be idempotent. The decorator configured on a formatter is called each time a formatter is started, and there is no way to 'un-decorate' the factory when when formatter is stopped. So, the factory could be decorated multiple times if the formatter is restarted.

Method Summary

Modifier and Type	Method	Description
default JsonFactory	decorate(JsonFactory factory)	Decorates the given JsonFactory.

Method Details

decorate

default JsonFactory decorate(JsonFactory factory)

Decorates the given JsonFactory.

By default, returns the given factory unchanged.

Note that the default JsonFactory created by logstash-logback-encoder is a MappingJsonFactory, but can be changed by JsonFactoryDecorators to any subclass of JsonFactory.

Parameters:

factory - the factory to decorate

Returns:

the decorated JsonFactory