This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/karaf.git
The following commit(s) were added to refs/heads/main by this push:
new fcfc7ef07b fix(management): retry JMX connector start on JNDI
NotContextException (#2309)
fcfc7ef07b is described below
commit fcfc7ef07b79eca1e7e08336ab54cf233a7ed2a1
Author: JB Onofré <[email protected]>
AuthorDate: Sat Mar 14 14:14:58 2026 +0100
fix(management): retry JMX connector start on JNDI NotContextException
(#2309)
When the JMX connector starts in a separate thread, it can race with
the RMI registry initialization, causing a NotContextException when
trying to bind to the JNDI context. Add retry logic (up to 10 attempts,
1s apart) for this transient failure, while still failing immediately
for other errors like BindException.
---
.../karaf/management/ConnectorServerFactory.java | 49 ++++++-
.../management/ConnectorServerFactoryTest.java | 163 +++++++++++++++++++++
2 files changed, 210 insertions(+), 2 deletions(-)
diff --git
a/management/server/src/main/java/org/apache/karaf/management/ConnectorServerFactory.java
b/management/server/src/main/java/org/apache/karaf/management/ConnectorServerFactory.java
index e3f28bb30d..64f1537175 100644
---
a/management/server/src/main/java/org/apache/karaf/management/ConnectorServerFactory.java
+++
b/management/server/src/main/java/org/apache/karaf/management/ConnectorServerFactory.java
@@ -48,10 +48,19 @@ import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLServerSocket;
import javax.net.ssl.SSLServerSocketFactory;
+import javax.naming.NotContextException;
import javax.rmi.ssl.SslRMIClientSocketFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
public class ConnectorServerFactory {
+ private static final Logger LOG =
LoggerFactory.getLogger(ConnectorServerFactory.class);
+
+ static final int MAX_RETRIES = 10;
+ static final long RETRY_DELAY_MS = 1000;
+
private enum AuthenticatorType {NONE, PASSWORD, CERTIFICATE}
private MBeanServer server;
@@ -312,7 +321,7 @@ public class ConnectorServerFactory {
Thread connectorThread = new Thread(() -> {
try {
Thread.currentThread().setContextClassLoader(ConnectorServerFactory.class.getClassLoader());
- connectorServer.start();
+ startWithRetry(connectorServer);
if (jmxmpEnabled && jmxmpConnectorServer != null) {
jmxmpConnectorServer.start();
}
@@ -335,7 +344,7 @@ public class ConnectorServerFactory {
connectorThread.setDaemon(this.daemon);
connectorThread.start();
} else {
- this.connectorServer.start();
+ startWithRetry(this.connectorServer);
if (jmxmpEnabled && jmxmpConnectorServer != null) {
jmxmpConnectorServer.start();
}
@@ -351,6 +360,42 @@ public class ConnectorServerFactory {
}
}
+ static void startWithRetry(JMXConnectorServer server) throws IOException {
+ startWithRetry(server, MAX_RETRIES, RETRY_DELAY_MS);
+ }
+
+ static void startWithRetry(JMXConnectorServer server, int maxRetries, long
retryDelayMs) throws IOException {
+ for (int attempt = 1; attempt <= maxRetries; attempt++) {
+ try {
+ server.start();
+ return;
+ } catch (IOException ex) {
+ if (hasCause(ex, NotContextException.class) && attempt <
maxRetries) {
+ LOG.warn("JNDI context not yet available, retrying JMX
connector start (attempt {}/{})", attempt, maxRetries);
+ try {
+ Thread.sleep(retryDelayMs);
+ } catch (InterruptedException ie) {
+ Thread.currentThread().interrupt();
+ throw ex;
+ }
+ } else {
+ throw ex;
+ }
+ }
+ }
+ }
+
+ static boolean hasCause(Throwable throwable, Class<? extends Throwable>
causeType) {
+ Throwable current = throwable;
+ while (current != null) {
+ if (causeType.isInstance(current)) {
+ return true;
+ }
+ current = current.getCause();
+ }
+ return false;
+ }
+
public void destroy() throws Exception {
try {
if (this.connectorServer != null) {
diff --git
a/management/server/src/test/java/org/apache/karaf/management/ConnectorServerFactoryTest.java
b/management/server/src/test/java/org/apache/karaf/management/ConnectorServerFactoryTest.java
new file mode 100644
index 0000000000..903d4008ff
--- /dev/null
+++
b/management/server/src/test/java/org/apache/karaf/management/ConnectorServerFactoryTest.java
@@ -0,0 +1,163 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.karaf.management;
+
+import java.io.IOException;
+import java.net.BindException;
+
+import javax.management.remote.JMXConnectorServer;
+import javax.naming.NotContextException;
+
+import junit.framework.TestCase;
+import org.easymock.EasyMock;
+
+public class ConnectorServerFactoryTest extends TestCase {
+
+ private static final int TEST_MAX_RETRIES = 3;
+ private static final long TEST_RETRY_DELAY_MS = 10;
+
+ public void testHasCauseDirectMatch() {
+ NotContextException nce = new NotContextException("test");
+ assertTrue(ConnectorServerFactory.hasCause(nce,
NotContextException.class));
+ }
+
+ public void testHasCauseNestedMatch() {
+ NotContextException nce = new NotContextException("context not found");
+ IOException ioe = new IOException("Cannot bind", nce);
+ assertTrue(ConnectorServerFactory.hasCause(ioe,
NotContextException.class));
+ }
+
+ public void testHasCauseDeeplyNested() {
+ NotContextException nce = new NotContextException("context not found");
+ IOException ioe = new IOException("Cannot bind", nce);
+ RuntimeException rte = new RuntimeException("wrapper", ioe);
+ assertTrue(ConnectorServerFactory.hasCause(rte,
NotContextException.class));
+ }
+
+ public void testHasCauseNoMatch() {
+ IOException ioe = new IOException("some error");
+ assertFalse(ConnectorServerFactory.hasCause(ioe,
NotContextException.class));
+ }
+
+ public void testHasCauseNullThrowable() {
+ assertFalse(ConnectorServerFactory.hasCause(null,
NotContextException.class));
+ }
+
+ public void testStartWithRetrySucceedsFirstAttempt() throws Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ mockServer.start();
+ EasyMock.expectLastCall().once();
+ EasyMock.replay(mockServer);
+
+ ConnectorServerFactory.startWithRetry(mockServer, TEST_MAX_RETRIES,
TEST_RETRY_DELAY_MS);
+
+ EasyMock.verify(mockServer);
+ }
+
+ public void testStartWithRetrySucceedsAfterNotContextException() throws
Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ // First call throws IOException caused by NotContextException
+ mockServer.start();
+ EasyMock.expectLastCall().andThrow(
+ new IOException("Cannot bind", new
NotContextException("context not found")));
+ // Second call succeeds
+ mockServer.start();
+ EasyMock.expectLastCall().once();
+ EasyMock.replay(mockServer);
+
+ ConnectorServerFactory.startWithRetry(mockServer, TEST_MAX_RETRIES,
TEST_RETRY_DELAY_MS);
+
+ EasyMock.verify(mockServer);
+ }
+
+ public void testStartWithRetryThrowsImmediatelyOnBindException() throws
Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ BindException be = new BindException("Address already in use");
+ IOException ioe = new IOException("Cannot bind", be);
+ mockServer.start();
+ EasyMock.expectLastCall().andThrow(ioe);
+ EasyMock.replay(mockServer);
+
+ try {
+ ConnectorServerFactory.startWithRetry(mockServer,
TEST_MAX_RETRIES, TEST_RETRY_DELAY_MS);
+ fail("Expected IOException to be thrown");
+ } catch (IOException ex) {
+ assertSame(ioe, ex);
+ }
+
+ // Verify start() was only called once (no retry for BindException)
+ EasyMock.verify(mockServer);
+ }
+
+ public void testStartWithRetryThrowsImmediatelyOnPlainIOException() throws
Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ IOException ioe = new IOException("some other error");
+ mockServer.start();
+ EasyMock.expectLastCall().andThrow(ioe);
+ EasyMock.replay(mockServer);
+
+ try {
+ ConnectorServerFactory.startWithRetry(mockServer,
TEST_MAX_RETRIES, TEST_RETRY_DELAY_MS);
+ fail("Expected IOException to be thrown");
+ } catch (IOException ex) {
+ assertSame(ioe, ex);
+ }
+
+ EasyMock.verify(mockServer);
+ }
+
+ public void testStartWithRetryExhaustsRetries() throws Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ IOException ioe = new IOException("Cannot bind", new
NotContextException("context not found"));
+ for (int i = 0; i < TEST_MAX_RETRIES; i++) {
+ mockServer.start();
+ EasyMock.expectLastCall().andThrow(ioe);
+ }
+ EasyMock.replay(mockServer);
+
+ try {
+ ConnectorServerFactory.startWithRetry(mockServer,
TEST_MAX_RETRIES, TEST_RETRY_DELAY_MS);
+ fail("Expected IOException to be thrown after exhausting retries");
+ } catch (IOException ex) {
+ assertSame(ioe, ex);
+ }
+
+ EasyMock.verify(mockServer);
+ }
+
+ public void testStartWithRetryRespectsInterrupt() throws Exception {
+ JMXConnectorServer mockServer =
EasyMock.createMock(JMXConnectorServer.class);
+ IOException ioe = new IOException("Cannot bind", new
NotContextException("context not found"));
+ mockServer.start();
+ EasyMock.expectLastCall().andThrow(ioe);
+ EasyMock.replay(mockServer);
+
+ Thread.currentThread().interrupt();
+ try {
+ ConnectorServerFactory.startWithRetry(mockServer,
TEST_MAX_RETRIES, TEST_RETRY_DELAY_MS);
+ fail("Expected IOException to be thrown on interrupt");
+ } catch (IOException ex) {
+ assertSame(ioe, ex);
+ assertTrue("Thread interrupt flag should be set",
Thread.currentThread().isInterrupted());
+ } finally {
+ // Clear interrupt flag for other tests
+ Thread.interrupted();
+ }
+
+ EasyMock.verify(mockServer);
+ }
+}
