ARTEMIS-6217 mitigate shutdown stacktraces for MQTT

When the broker is processing MQTT packets (especially those related to
QoS 2 message flows) a shutdown can cause the broker to log several
different stack-traces that are effectively harmless, but can alarm users.
The broker should detect these and avoid logging them.

Co-Authored-By: Claude <noreply@anthropic.com>

Author: jbertram

artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTConnectionManager.java

@@ -16,15 +16,20 @@
  */
 package org.apache.activemq.artemis.core.protocol.mqtt;
 
+import java.lang.invoke.MethodHandles;
+
 import io.netty.buffer.ByteBufAllocator;
 import io.netty.handler.codec.mqtt.MqttConnectMessage;
 import io.netty.handler.codec.mqtt.MqttProperties;
 import io.netty.handler.codec.mqtt.MqttVersion;
 import org.apache.activemq.artemis.api.core.client.ActiveMQClient;
+import org.apache.activemq.artemis.core.persistence.impl.journal.ActiveMQIDGeneratorStoppedException;
 import org.apache.activemq.artemis.core.server.ActiveMQServer;
 import org.apache.activemq.artemis.core.server.ServerSession;
 import org.apache.activemq.artemis.core.server.impl.ServerSessionImpl;
 import org.apache.activemq.artemis.utils.UUIDGenerator;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import static io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType.ASSIGNED_CLIENT_IDENTIFIER;
 import static io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType.AUTHENTICATION_METHOD;
@@ -41,6 +46,8 @@
  */
 public class MQTTConnectionManager {
 
+   private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
    private MQTTSession session;
 
    public MQTTConnectionManager(MQTTSession session) {
@@ -194,6 +201,8 @@ synchronized void disconnect(boolean failure) {
       try {
          session.stop(failure);
          session.getConnection().destroy();
+      } catch (ActiveMQIDGeneratorStoppedException harmless) {
+         logger.debug("Unable to cleanly disconnect MQTT client {} because the storage manager is stopping", session.getState().getClientId(), harmless);
       } catch (Exception e) {
          MQTTLogger.LOGGER.errorDisconnectingClient(e);
       } finally {

artemis-protocols/artemis-mqtt-protocol/src/main/java/org/apache/activemq/artemis/core/protocol/mqtt/MQTTSessionCallback.java

@@ -16,14 +16,21 @@
  */
 package org.apache.activemq.artemis.core.protocol.mqtt;
 
+import java.lang.invoke.MethodHandles;
+
 import org.apache.activemq.artemis.api.core.SimpleString;
+import org.apache.activemq.artemis.core.persistence.impl.journal.ActiveMQIDGeneratorStoppedException;
 import org.apache.activemq.artemis.core.server.MessageReference;
 import org.apache.activemq.artemis.core.server.ServerConsumer;
 import org.apache.activemq.artemis.spi.core.protocol.SessionCallback;
 import org.apache.activemq.artemis.spi.core.remoting.ReadyListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class MQTTSessionCallback implements SessionCallback {
 
+   private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
    private final MQTTSession session;
    private final MQTTConnection connection;
    private final int defaultMaximumInFlightPublishMessages;
@@ -50,6 +57,8 @@ public int sendMessage(MessageReference ref,
                           int deliveryCount) {
       try {
          session.getMqttPublishManager().publishToClient(ref.getMessage().toCore(), consumer);
+      } catch (ActiveMQIDGeneratorStoppedException harmless) {
+         logger.debug("Unable to send message to MQTT client because the storage manager is stopping; consumer: {}; message: {}", consumer, ref, harmless);
       } catch (Exception e) {
          MQTTLogger.LOGGER.unableToSendMessage(session.getState().getClientId(), ref, e);
       }

artemis-server/src/main/java/org/apache/activemq/artemis/core/persistence/impl/journal/ActiveMQIDGeneratorStoppedException.java

@@ -0,0 +1,30 @@
+/*
+ * 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.activemq.artemis.core.persistence.impl.journal;
+
+/**
+ * Thrown by an {@link org.apache.activemq.artemis.utils.IDGenerator} when an ID is requested after the generator has
+ * been stopped.
+ */
+public class ActiveMQIDGeneratorStoppedException extends RuntimeException {
+
+   private static final long serialVersionUID = 8328635365036357836L;
+
+   public ActiveMQIDGeneratorStoppedException(String message) {
+      super(message);
+   }
+}

artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQMessageBundle.java

@@ -48,6 +48,7 @@
 import org.apache.activemq.artemis.api.core.SimpleString;
 import org.apache.activemq.artemis.api.core.TransportConfiguration;
 import org.apache.activemq.artemis.core.io.SequentialFile;
+import org.apache.activemq.artemis.core.persistence.impl.journal.ActiveMQIDGeneratorStoppedException;
 import org.apache.activemq.artemis.core.postoffice.Binding;
 import org.apache.activemq.artemis.core.protocol.core.impl.wireformat.ReplicationSyncFileMessage;
 import org.apache.activemq.artemis.core.security.CheckType;
@@ -533,7 +534,7 @@ IllegalStateException invalidRoutingTypeUpdate(String queueName,
    IllegalArgumentException positivePowerOfTwo(String name, Number val);
 
    @Message(id = 229257, value = "IDGenerator has been stopped")
-   RuntimeException idGeneratorStopped();
+   ActiveMQIDGeneratorStoppedException idGeneratorStopped();
 
    @Message(id = 229258, value = "Invalid cluster bridge message! No queue IDs defined in the property {}")
    ActiveMQIllegalStateException noQueueIdsDefined(SimpleString idsHeaderName);