net.logstash.logback

Class Logback11Support

java.lang.Object

net.logstash.logback.Logback11Support

public class Logback11Support
extends Object

Provides backwards compatibility at runtime with logback 1.1.x. In logback version 1.2.0, the Encoder interface was changed from writing to an OutputStream to returning byte arrays. This was a backwards incompatible change, therefore some fancy runtime reflection is required to make logstash-logback-encoder work with both pre- and post-1.2 logback versions. This class is used to determine if logback 1.1 is on the runtime classpath (isLogback11OrBefore()), and invoke the old methods on the Encoder interface.

Field Summary

Fields

Modifier and Type	Field and Description
static Logback11Support	INSTANCE

Constructor Summary

Constructors

Constructor and Description
Logback11Support()

Method Summary

Modifier and Type	Method and Description
void	close(Encoder<?> encoder) Invokes the close method of a logback 1.1 encoder.
void	doEncode(Encoder<?> encoder, Object event) Invokes the doEncode method of a logback 1.1 encoder, with the given event as the argument.
void	init(Encoder<?> encoder, OutputStream outputStream) Invokes the init method of a logback 1.1 encoder, with the given outputStream as the argument.
boolean	isLogback11OrBefore()
void	verifyLogback11OrBefore() Called by logic that should only execute if logback 1.1.x or earlier is on the runtime classpath.
void	verifyLogback12OrAfter() Called by logic that should only execute if logback 1.2.x or later is on the runtime classpath.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final Logback11Support INSTANCE

Constructor Detail

Logback11Support

public Logback11Support()

Method Detail

isLogback11OrBefore

public boolean isLogback11OrBefore()

Returns:

true if logback 1.1.x or earlier is on the runtime classpath. false if logback 1.2.x or later is on the runtime classpath

verifyLogback11OrBefore

public void verifyLogback11OrBefore()

Called by logic that should only execute if logback 1.1.x or earlier is on the runtime classpath.

Throws:

IllegalStateException - if the logback version is >= 1.2

verifyLogback12OrAfter

public void verifyLogback12OrAfter()

Called by logic that should only execute if logback 1.2.x or later is on the runtime classpath.

Throws:

IllegalStateException - if the logback version is < 1.2

init

public void init(Encoder<?> encoder,
                 OutputStream outputStream)
          throws IOException

Invokes the init method of a logback 1.1 encoder, with the given outputStream as the argument.

Parameters:

encoder - the encoder to initialize

outputStream - the output stream with which to initialize the encoder

Throws:

IOException - if an exception occurs during initialization

doEncode

public void doEncode(Encoder<?> encoder,
                     Object event)
              throws IOException

Invokes the doEncode method of a logback 1.1 encoder, with the given event as the argument.

Parameters:

encoder - the encoder to use to encode the event

event - the event to encode

Throws:

IOException - if an exception occurs during encoding

close

public void close(Encoder<?> encoder)
           throws IOException

Invokes the close method of a logback 1.1 encoder.

Parameters:

encoder - the encoder to close

Throws:

IOException - if an exception occurs during close