ARTEMIS-5786 determine if address is blocked via mngmnt API

Author: jbertram

artemis-commons/src/main/java/org/apache/activemq/artemis/logs/AuditLogger.java

@@ -2896,4 +2896,11 @@ static void retryMessages(Object source, Object... args) {
    @LogMessage(id = 601802, value = "User {} is retry sending messages on target resource: {} {}", level = LogMessage.Level.INFO)
    void retryMessages(String user, Object source, String args);
 
+   static void isBlockedViaManagement(Object source) {
+      BASE_LOGGER.isBlockedViaManagement(getCaller(), source);
+   }
+
+   @LogMessage(id = 601803, value = "User {} is getting BlockedViaManagement on target resource: {}", level = LogMessage.Level.INFO)
+   void isBlockedViaManagement(String user, Object source);
+
 }

artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java

@@ -155,6 +155,12 @@ public interface AddressControl {
    @Operation(desc = "Resumes message production to this address, if previously blocked.", impact = MBeanOperationInfo.ACTION)
    void unblock() throws Exception;
 
+   /**
+    * {@return whether message production to this address is blocked via management (via the {@code block} operation)}
+    */
+   @Attribute(desc = "whether message production to this address is blocked via management (via the block operation)")
+   boolean isBlockedViaManagement() throws Exception;
+
    /**
     * {@return the number of bytes used by each page for this address}
     */

artemis-server/src/main/java/org/apache/activemq/artemis/core/management/impl/AddressControlImpl.java

@@ -481,6 +481,26 @@ public void unblock() {
       }
    }
 
+   @Override
+   public boolean isBlockedViaManagement() throws Exception {
+      if (AuditLogger.isBaseLoggingEnabled()) {
+         AuditLogger.isBlockedViaManagement(this.addressInfo);
+      }
+      clearIO();
+      try {
+         final PagingStore pagingStore = getPagingStore();
+         if (pagingStore != null) {
+            return pagingStore.isBlockedViaManagement();
+         } else {
+            return false;
+         }
+      } catch (Exception e) {
+         return false;
+      } finally {
+         blockOnIO();
+      }
+   }
+
    @Override
    public long getNumberOfPages() {
       if (AuditLogger.isBaseLoggingEnabled()) {

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

@@ -284,6 +284,8 @@ default void addSize(int size) {
 
    void unblock();
 
+   boolean isBlockedViaManagement();
+
    default boolean hasPendingIO() {
       return false;
    }

artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/impl/PagingStoreImpl.java

@@ -170,7 +170,7 @@ public class PagingStoreImpl implements PagingStore {
 
    private volatile boolean blocking = false;
 
-   private volatile boolean blockedViaAddressControl = false;
+   private volatile boolean blockedViaManagement = false;
 
    private long rejectThreshold;
 
@@ -1290,7 +1290,7 @@ private void addToBlockList(AtomicRunnable atomicRunnable, Consumer<AtomicRunnab
    public boolean checkMemory(boolean runOnFailure, Runnable runWhenAvailableParameter, Runnable runWhenBlocking, Consumer<AtomicRunnable> blockedCallback) {
       AtomicRunnable runWhenAvailable = AtomicRunnable.checkAtomic(runWhenAvailableParameter);
 
-      if (blockedViaAddressControl) {
+      if (blockedViaManagement) {
          if (runWhenAvailable != null) {
             addToBlockList(runWhenAvailable, blockedCallback);
          }
@@ -1404,7 +1404,7 @@ public void addSize(final int size, boolean sizeOnly, boolean affectGlobal) {
 
    @Override
    public boolean checkReleasedMemory() {
-      if (!blockedViaAddressControl && !pagingManager.isGlobalFull() && !full) {
+      if (!blockedViaManagement && !pagingManager.isGlobalFull() && !full) {
          executor.execute(this::memoryReleased);
          if (blocking) {
             ActiveMQServerLogger.LOGGER.unblockingMessageProduction(address, getPageInfo());
@@ -1876,21 +1876,26 @@ public int getAddressLimitPercent() {
 
    @Override
    public void block() {
-      if (!blockedViaAddressControl) {
+      if (!blockedViaManagement) {
          ActiveMQServerLogger.LOGGER.blockingViaControl(address);
       }
-      blockedViaAddressControl = true;
+      blockedViaManagement = true;
    }
 
    @Override
    public void unblock() {
-      if (blockedViaAddressControl) {
+      if (blockedViaManagement) {
          ActiveMQServerLogger.LOGGER.unblockingViaControl(address);
       }
-      blockedViaAddressControl = false;
+      blockedViaManagement = false;
       checkReleasedMemory();
    }
 
+   @Override
+   public boolean isBlockedViaManagement() {
+      return blockedViaManagement;
+   }
+
    @Override
    public boolean isRejectingMessages() {
       if (addressFullMessagePolicy != AddressFullMessagePolicy.BLOCK) {

tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/management/AddressControlTest.java

@@ -880,6 +880,24 @@ public void testAddressSizeAfterRestartWithPaging() throws Exception {
       assertEquals(exactPercentBeforeRestart, addressControl.getAddressLimitPercent());
    }
 
+   @Test
+   public void testIsBlockedViaManagement() throws Exception {
+      SimpleString address = RandomUtil.randomUUIDSimpleString();
+      SimpleString queue = RandomUtil.randomUUIDSimpleString();
+
+      session.createQueue(QueueConfiguration.of(queue).setAddress(address).setDurable(false));
+
+      AddressControl addressControl = createManagementControl(address);
+
+      assertFalse(addressControl.isBlockedViaManagement());
+      addressControl.block();
+      assertTrue(addressControl.isBlockedViaManagement());
+      addressControl.unblock();
+      assertFalse(addressControl.isBlockedViaManagement());
+
+      session.deleteQueue(queue);
+   }
+
 
    @Override
    @BeforeEach

tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/management/AddressControlUsingCoreTest.java

@@ -128,7 +128,12 @@ public boolean block() throws Exception {
 
          @Override
          public void unblock() throws Exception {
-            proxy.invokeOperation("unBlock");
+            proxy.invokeOperation("unblock");
+         }
+
+         @Override
+         public boolean isBlockedViaManagement() throws Exception {
+            return (boolean) proxy.retrieveAttributeValue("blockedViaManagement");
          }
 
          @Override

tests/performance-tests/src/test/java/org/apache/activemq/artemis/tests/performance/storage/PersistMultiThreadTest.java

@@ -614,5 +614,10 @@ public void block() {
       @Override
       public void unblock() {
       }
+
+      @Override
+      public boolean isBlockedViaManagement() {
+         return false;
+      }
    }
 }