net.logstash.logback.encoder

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

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.encoder.EncoderBase<Event>

net.logstash.logback.encoder.CompositeJsonEncoder<Event>

All Implemented Interfaces:

ch.qos.logback.core.encoder.Encoder<Event>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

Direct Known Subclasses:

AccessEventCompositeJsonEncoder, LoggingEventCompositeJsonEncoder

public abstract class CompositeJsonEncoder<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends ch.qos.logback.core.encoder.EncoderBase<Event>

Field Summary

Fields inherited from class ch.qos.logback.core.encoder.EncoderBase

started

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

context

Constructor Summary

Constructors

Constructor and Description
CompositeJsonEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This is an overridden method from Encoder from logback 1.1.
protected abstract CompositeJsonFormatter<Event>	createFormatter()
void	doEncode(Event event) This is an overridden method from Encoder from logback 1.1.
void	doEncode(Object event) This is an overridden method from Encoder from logback 1.1.
byte[]	encode(Event event)
byte[]	footerBytes()
String	getEncoding()
protected CompositeJsonFormatter<Event>	getFormatter()
JsonFactoryDecorator	getJsonFactoryDecorator()
JsonGeneratorDecorator	getJsonGeneratorDecorator()
String	getLineSeparator()
int	getMinBufferSize()
ch.qos.logback.core.encoder.Encoder<Event>	getPrefix()
JsonProviders<Event>	getProviders()
ch.qos.logback.core.encoder.Encoder<Event>	getSuffix()
byte[]	headerBytes()
void	init(OutputStream outputStream) This is an overridden method from Encoder from logback 1.1.
boolean	isImmediateFlush()
void	setEncoding(String encodingName) The character encoding to use (default = "UTF-8").
void	setImmediateFlush(boolean immediateFlush)
void	setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)
void	setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)
void	setLineSeparator(String lineSeparator) Sets which lineSeparator to use between events.
void	setMinBufferSize(int minBufferSize) Sets the minimum size of the byte array buffer used when encoding events in logback versions greater than or equal to 1.2.0.
void	setPrefix(ch.qos.logback.core.encoder.Encoder<Event> prefix)
void	setProviders(JsonProviders<Event> jsonProviders)
void	setSuffix(ch.qos.logback.core.encoder.Encoder<Event> suffix)
void	start()
void	stop()

Methods inherited from class ch.qos.logback.core.encoder.EncoderBase

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

Constructor Detail

CompositeJsonEncoder

public CompositeJsonEncoder()

Method Detail

createFormatter

protected abstract CompositeJsonFormatter<Event> createFormatter()

init

public void init(OutputStream outputStream)
          throws IOException

This is an overridden method from Encoder from logback 1.1. It sets the OutputStream to which this encoder should write encoded events. This method is not part of the Encoder interface in logback 1.2, therefore, logback 1.2+ will not call this method.

Throws:

IllegalStateException - if the logback version is >= 1.2

IOException

encode

public byte[] encode(Event event)

doEncode

public void doEncode(Object event)
              throws IOException

This is an overridden method from Encoder from logback 1.1. It encodes the event to the OutputStream passed to the init(OutputStream) method. This method takes the place of the bridge method that would have been generated by the compiler when compiled against logback 1.1. This method is not part of the Encoder interface in logback 1.2, therefore, logback 1.2+ will not call this method.

Throws:

IllegalStateException - if the logback version is >= 1.2

IOException

doEncode

public void doEncode(Event event)
              throws IOException

This is an overridden method from Encoder from logback 1.1. It encodes the event to the OutputStream passed to the init(OutputStream) method. This method is not part of the Encoder interface in logback 1.2, therefore, logback 1.2+ will not call this method.

Throws:

IllegalStateException - if the logback version is >= 1.2

IOException

start

public void start()

Specified by:

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

Overrides:

start in class ch.qos.logback.core.encoder.EncoderBase<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

stop

public void stop()

Specified by:

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

Overrides:

stop in class ch.qos.logback.core.encoder.EncoderBase<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

close

public void close()
           throws IOException

This is an overridden method from Encoder from logback 1.1. It closes this encoder. It is called prior to closing the underlying outputstream. This method is not part of the Encoder interface in logback 1.2, therefore, logback 1.2+ will not call this method.

Throws:

IllegalStateException - if the logback version is >= 1.2

IOException

headerBytes

public byte[] headerBytes()

footerBytes

public byte[] footerBytes()

getProviders

public JsonProviders<Event> getProviders()

setProviders

public void setProviders(JsonProviders<Event> jsonProviders)

isImmediateFlush

public boolean isImmediateFlush()

setImmediateFlush

public void setImmediateFlush(boolean immediateFlush)

getJsonFactoryDecorator

public JsonFactoryDecorator getJsonFactoryDecorator()

setJsonFactoryDecorator

public void setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)

getJsonGeneratorDecorator

public JsonGeneratorDecorator getJsonGeneratorDecorator()

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encodingName)

The character encoding to use (default = "UTF-8"). Must an encoding supported by JsonEncoding

setJsonGeneratorDecorator

public void setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)

getLineSeparator

public String getLineSeparator()

setLineSeparator

public void setLineSeparator(String lineSeparator)

Sets which lineSeparator to use between events.

The following values have special meaning:

• null or empty string = no new line.
• "SYSTEM" = operating system new line (default).
• "UNIX" = unix line ending (\n).
• "WINDOWS" = windows line ending (\r\n).

Any other value will be used as given as the lineSeparator.

getMinBufferSize

public int getMinBufferSize()

setMinBufferSize

public void setMinBufferSize(int minBufferSize)

Sets the minimum size of the byte array buffer used when encoding events in logback versions greater than or equal to 1.2.0. The actual buffer size will be the minBufferSize plus the prefix, suffix, and line separators sizes.

getFormatter

protected CompositeJsonFormatter<Event> getFormatter()

getPrefix

public ch.qos.logback.core.encoder.Encoder<Event> getPrefix()

setPrefix

public void setPrefix(ch.qos.logback.core.encoder.Encoder<Event> prefix)

getSuffix

public ch.qos.logback.core.encoder.Encoder<Event> getSuffix()

setSuffix

public void setSuffix(ch.qos.logback.core.encoder.Encoder<Event> suffix)