Remove JndiManager#getContext method

Author: ppkarwasz

log4j-jndi-test/src/main/java/org/apache/logging/log4j/jndi/test/junit/JndiRule.java

@@ -17,18 +17,13 @@
 package org.apache.logging.log4j.jndi.test.junit;
 
 import static java.util.Objects.requireNonNull;
-import static org.junit.Assert.assertNotNull;
 
 import java.util.Collections;
 import java.util.Hashtable;
 import java.util.Map;
-import java.util.Set;
-import java.util.Spliterators;
-import java.util.stream.Collectors;
-import java.util.stream.StreamSupport;
 import javax.annotation.Nullable;
 import javax.naming.Context;
-import javax.naming.NameClassPair;
+import javax.naming.Name;
 import javax.naming.NamingException;
 import javax.naming.spi.InitialContextFactoryBuilder;
 import javax.naming.spi.NamingManager;
@@ -46,9 +41,11 @@
 @SuppressWarnings("BanJNDI")
 public class JndiRule implements TestRule {
 
+    private static final Hashtable<String, Object> ENV = new Hashtable<>(Map.of(MemoryContext.IGNORE_CLOSE, "true"));
+    private static final Context CONTEXT = new MemoryContext(ENV);
+
     static {
-        final InitialContextFactoryBuilder factoryBuilder =
-                factoryBuilderEnv -> factoryEnv -> new MemoryContext(new Hashtable<>()) {};
+        final InitialContextFactoryBuilder factoryBuilder = factoryBuilderEnv -> factoryEnv -> CONTEXT;
         try {
             NamingManager.setInitialContextFactoryBuilder(factoryBuilder);
         } catch (final NamingException error) {
@@ -91,38 +88,44 @@ public void evaluate() throws Throwable {
 
     private void resetJndiManager() throws NamingException {
         if (JndiManager.isJndiEnabled()) {
-            final Context context = getContext();
-            clearBindings(context);
-            addBindings(context);
+            clearBindings();
+            addBindings();
         }
     }
 
-    private Context getContext() {
-        final JndiManager manager =
-                managerName == null ? JndiManager.getDefaultManager() : JndiManager.getDefaultManager(managerName);
-        @Nullable final Context context = manager.getContext();
-        assertNotNull(context);
-        return context;
-    }
-
-    private static void clearBindings(final Context context) throws NamingException {
-        final Set<NameClassPair> existingBindings = StreamSupport.stream(
-                        Spliterators.spliteratorUnknownSize(context.list("").asIterator(), 0), false)
-                .collect(Collectors.toSet());
-        existingBindings.forEach(binding -> {
+    private static void clearBindings() throws NamingException {
+        Collections.list(CONTEXT.list("")).forEach(binding -> {
             try {
-                context.unbind(binding.getName());
+                CONTEXT.unbind(binding.getName());
             } catch (NamingException error) {
                 throw new RuntimeException(error);
             }
         });
     }
 
-    private void addBindings(final Context context) throws NamingException {
+    private void addBindings() throws NamingException {
         for (final Map.Entry<String, Object> entry : bindings.entrySet()) {
-            final String name = entry.getKey();
+            final String key = entry.getKey();
             final Object object = entry.getValue();
-            context.bind(name, object);
+            recursiveBind(key, object);
+        }
+    }
+
+    public static void recursiveBind(final String key, final Object value) throws NamingException {
+        final Name name = CONTEXT.getNameParser((Name) null).parse(key);
+        Context currentContext = CONTEXT;
+        final int lastIndex = name.size() - 1;
+        for (int i = 0; i < lastIndex; i++) {
+            try {
+                currentContext = (Context) currentContext.lookup(name.get(i));
+            } catch (NamingException ignored) {
+                currentContext = currentContext.createSubcontext(name.get(i));
+            }
         }
+        currentContext.bind(name.get(lastIndex), value);
+    }
+
+    public static void rebind(final String key, final Object value) throws NamingException {
+        CONTEXT.rebind(key, value);
     }
 }

log4j-jndi-test/src/test/java/org/apache/logging/log4j/jndi/appender/routing/RoutingAppenderWithJndiTest.java

@@ -20,12 +20,10 @@
 
 import java.io.File;
 import java.util.Collections;
-import javax.naming.Context;
 import javax.naming.NamingException;
 import org.apache.logging.log4j.EventLogger;
 import org.apache.logging.log4j.core.test.appender.ListAppender;
 import org.apache.logging.log4j.core.test.junit.LoggerContextRule;
-import org.apache.logging.log4j.jndi.JndiManager;
 import org.apache.logging.log4j.jndi.test.junit.JndiRule;
 import org.apache.logging.log4j.message.StructuredDataMessage;
 import org.junit.After;
@@ -77,9 +75,7 @@ public void routingTest() throws NamingException {
         assertTrue("The default log file was not created", defaultLogFile.exists());
 
         // now set jndi resource to Application1
-        final Context context = JndiManager.getDefaultManager().getContext();
-        assertNotNull(context);
-        context.bind(JNDI_CONTEXT_NAME, "Application1");
+        JndiRule.recursiveBind(JNDI_CONTEXT_NAME, "Application1");
 
         msg = new StructuredDataMessage("Test", "This is a message from Application1", "Context");
         EventLogger.logEvent(msg);
@@ -90,7 +86,7 @@ public void routingTest() throws NamingException {
                 listAppender1.getEvents().size() == 1);
 
         // now set jndi resource to Application2
-        context.rebind(JNDI_CONTEXT_NAME, "Application2");
+        JndiRule.rebind(JNDI_CONTEXT_NAME, "Application2");
 
         msg = new StructuredDataMessage("Test", "This is a message from Application2", "Context");
         EventLogger.logEvent(msg);
@@ -118,15 +114,15 @@ public void routingTest() throws NamingException {
 
         // now set jndi resource to Application3.
         // The context name, 'Application3', will be used as log file name by the default route.
-        context.rebind("java:comp/env/logging/context-name", "Application3");
+        JndiRule.rebind(JNDI_CONTEXT_NAME, "Application3");
         msg = new StructuredDataMessage("Test", "This is a message from Application3", "Context");
         EventLogger.logEvent(msg);
         final File application3LogFile = new File("target/routingbyjndi/routingbyjnditest-Application3.log");
         assertTrue("The Application3 log file was not created", application3LogFile.exists());
 
         // now set jndi resource to Application4
         // The context name, 'Application4', will be used as log file name by the default route.
-        context.rebind("java:comp/env/logging/context-name", "Application4");
+        JndiRule.rebind(JNDI_CONTEXT_NAME, "Application4");
         msg = new StructuredDataMessage("Test", "This is a message from Application4", "Context");
         EventLogger.logEvent(msg);
         final File application4LogFile = new File("target/routingbyjndi/routingbyjnditest-Application4.log");

log4j-jndi/src/main/java/org/apache/logging/log4j/jndi/JndiManager.java

@@ -21,7 +21,6 @@
 import java.net.URISyntaxException;
 import java.util.Properties;
 import java.util.concurrent.TimeUnit;
-import javax.annotation.Nullable;
 import javax.naming.Context;
 import javax.naming.InitialContext;
 import javax.naming.NamingException;
@@ -195,14 +194,6 @@ protected boolean releaseSub(final long timeout, final TimeUnit timeUnit) {
         return JndiCloser.closeSilently(this.context);
     }
 
-    /**
-     * @return the active context
-     */
-    @Nullable
-    public Context getContext() {
-        return context;
-    }
-
     /**
      * Looks up a named object through this JNDI context.
      *