Let LogstashEncoder/Layout throw an exception when setProviders() is called

Author: brenuart

src/main/java/net/logstash/logback/encoder/LogstashEncoder.java

@@ -20,6 +20,7 @@
 import net.logstash.logback.LogstashFormatter;
 import net.logstash.logback.composite.AbstractCompositeJsonFormatter;
 import net.logstash.logback.composite.JsonProvider;
+import net.logstash.logback.composite.JsonProviders;
 import net.logstash.logback.fieldnames.LogstashFieldNames;
 
 import ch.qos.logback.classic.pattern.ThrowableHandlingConverter;
@@ -229,4 +230,10 @@ public String getMessageSplitRegex() {
     public void setMessageSplitRegex(String messageSplitRegex) {
         getFormatter().setMessageSplitRegex(messageSplitRegex);
     }
+    
+    
+    @Override
+    public void setProviders(JsonProviders<ILoggingEvent> jsonProviders) {
+        throw new IllegalArgumentException("Using the <providers> configuration property is not allowed. Use <provider> instead to registerd additional " + JsonProvider.class.getSimpleName() + ".");
+    }
 }

src/main/java/net/logstash/logback/layout/LogstashLayout.java

@@ -20,6 +20,7 @@
 import net.logstash.logback.LogstashFormatter;
 import net.logstash.logback.composite.AbstractCompositeJsonFormatter;
 import net.logstash.logback.composite.JsonProvider;
+import net.logstash.logback.composite.JsonProviders;
 import net.logstash.logback.fieldnames.LogstashFieldNames;
 
 import ch.qos.logback.classic.pattern.ThrowableHandlingConverter;
@@ -228,4 +229,10 @@ public String getMessageSplitRegex() {
     public void setMessageSplitRegex(String messageSplitRegex) {
         getFormatter().setMessageSplitRegex(messageSplitRegex);
     }
+    
+    
+    @Override
+    public void setProviders(JsonProviders<ILoggingEvent> jsonProviders) {
+        throw new IllegalArgumentException("Using the <providers> configuration property is not allowed. Use <provider> instead to registerd additional " + JsonProvider.class.getSimpleName() + ".");
+    }
 }

src/test/java/net/logstash/logback/encoder/LogstashEncoderTest.java

@@ -19,6 +19,7 @@
 import static net.logstash.logback.marker.Markers.appendEntries;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatCode;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
@@ -36,6 +37,7 @@
 import java.util.TimeZone;
 
 import net.logstash.logback.composite.AbstractFormattedTimestampJsonProvider;
+import net.logstash.logback.composite.loggingevent.LoggingEventJsonProviders;
 import net.logstash.logback.decorate.JsonFactoryDecorator;
 import net.logstash.logback.decorate.JsonGeneratorDecorator;
 import net.logstash.logback.fieldnames.LogstashCommonFieldNames;
@@ -691,6 +693,12 @@ public void testMessageSplitDisabledByDefault() throws Exception {
         assertThat(node.path("message").textValue()).isEqualTo(message);
     }
 
+    @Test
+    public void testJsonProvidersCannotBeChanged() {
+        assertThatExceptionOfType(IllegalArgumentException.class)
+            .isThrownBy(() -> encoder.setProviders(new LoggingEventJsonProviders()));
+    }
+    
     private void assertJsonArray(JsonNode jsonNode, String... expected) {
         assertThat(jsonNode).isNotNull();
         assertThat(jsonNode.isArray()).isTrue();