API review feedback fixes for RuleManager Client (#32174)

* API review feedback fixes for RuleManager Client
Azure · Nov 16, 2022 · d2d6751 · d2d6751
1 parent a9963d8
commit d2d6751
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 65 deletions.
diff --git a/...ging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusClientBuilder.java b/...ging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusClientBuilder.java
@@ -1990,7 +1990,7 @@ ServiceBusReceiverAsyncClient buildAsyncClient(boolean isAutoCompleteAllowed, bo
      *
      * @see ServiceBusRuleManagerAsyncClient
      */
-    @ServiceClientBuilder(serviceClients = {ServiceBusRuleManagerAsyncClient.class})
+    @ServiceClientBuilder(serviceClients = {ServiceBusRuleManagerAsyncClient.class, ServiceBusRuleManagerClient.class})
     public final class ServiceBusRuleManagerBuilder {
         private String subscriptionName;
         private String topicName;

diff --git a/...icebus/src/main/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClient.java b/...icebus/src/main/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClient.java
@@ -8,7 +8,6 @@
 import com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient;
 import com.azure.messaging.servicebus.administration.models.CorrelationRuleFilter;
 import com.azure.messaging.servicebus.administration.models.CreateRuleOptions;
-import com.azure.messaging.servicebus.administration.models.RuleFilter;
 import com.azure.messaging.servicebus.administration.models.RuleProperties;
 import com.azure.messaging.servicebus.administration.models.SqlRuleAction;
 import com.azure.messaging.servicebus.administration.models.SqlRuleFilter;
@@ -143,24 +142,6 @@ public Mono<Void> createRule(String ruleName, CreateRuleOptions options) {
         return createRuleInternal(ruleName, options);
     }
 
-    /**
-     * Creates a rule to the current subscription to filter the messages reaching from topic to the subscription.
-     *
-     * @param ruleName Name of rule.
-     * @param filter The filter expression against which messages will be matched.
-     * @return A Mono that completes when the rule is created.
-     *
-     * @throws NullPointerException if {@code filter}, {@code ruleName} is null.
-     * @throws IllegalStateException if client is disposed.
-     * @throws IllegalArgumentException if ruleName is empty string, {@code filter} is not instanceof {@link SqlRuleFilter} or
-     * {@link CorrelationRuleFilter}.
-     * @throws ServiceBusException if filter matches {@code ruleName} is already created in subscription.
-     */
-    public Mono<Void> createRule(String ruleName, RuleFilter filter) {
-        CreateRuleOptions options = new CreateRuleOptions(filter);
-        return createRuleInternal(ruleName, options);
-    }
-
     /**
      * Fetches all rules associated with the topic and subscription.
      *
@@ -169,7 +150,7 @@ public Mono<Void> createRule(String ruleName, RuleFilter filter) {
      * @throws IllegalStateException if client is disposed.
      * @throws UnsupportedOperationException if client cannot support filter with descriptor in message body.
      */
-    public Flux<RuleProperties> getRules() {
+    public Flux<RuleProperties> listRules() {
         if (isDisposed.get()) {
             return fluxError(LOGGER, new IllegalStateException(
                 String.format(INVALID_OPERATION_DISPOSED_RULE_MANAGER, "getRules")
@@ -178,7 +159,7 @@ public Flux<RuleProperties> getRules() {
 
         return connectionProcessor
             .flatMap(connection -> connection.getManagementNode(entityPath, entityType))
-            .flatMapMany(ServiceBusManagementNode::getRules);
+            .flatMapMany(ServiceBusManagementNode::listRules);
     }
 
     /**

diff --git a/...-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusRuleManagerClient.java b/...-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusRuleManagerClient.java
@@ -8,7 +8,6 @@
 import com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient;
 import com.azure.messaging.servicebus.administration.models.CorrelationRuleFilter;
 import com.azure.messaging.servicebus.administration.models.CreateRuleOptions;
-import com.azure.messaging.servicebus.administration.models.RuleFilter;
 import com.azure.messaging.servicebus.administration.models.RuleProperties;
 import com.azure.messaging.servicebus.administration.models.SqlRuleAction;
 import com.azure.messaging.servicebus.administration.models.SqlRuleFilter;
@@ -83,22 +82,6 @@ public void createRule(String ruleName, CreateRuleOptions options) {
         asyncClient.createRule(ruleName, options).block(operationTimeout);
     }
 
-    /**
-     * Creates a rule to the current subscription to filter the messages reaching from topic to the subscription.
-     *
-     * @param ruleName Name of rule.
-     * @param filter The filter expression against which messages will be matched.
-     *
-     * @throws NullPointerException if {@code filter}, {@code ruleName} is null.
-     * @throws IllegalStateException if client is disposed.
-     * @throws IllegalArgumentException if ruleName is empty string, {@code filter} is not instanceof {@link SqlRuleFilter} or
-     * {@link CorrelationRuleFilter}.
-     * @throws ServiceBusException if filter matches {@code ruleName} is already created in subscription.
-     */
-    public void createRule(String ruleName, RuleFilter filter) {
-        asyncClient.createRule(ruleName, filter).block(operationTimeout);
-    }
-
     /**
      * Fetches all rules associated with the topic and subscription.
      *
@@ -107,8 +90,8 @@ public void createRule(String ruleName, RuleFilter filter) {
      * @throws IllegalStateException if client is disposed.
      * @throws UnsupportedOperationException if client cannot support filter with descriptor in message body.
      */
-    public IterableStream<RuleProperties> getRules() {
-        return new IterableStream<>(asyncClient.getRules());
+    public IterableStream<RuleProperties> listRules() {
+        return new IterableStream<>(asyncClient.listRules());
     }
 
     /**

diff --git a/...icebus/src/main/java/com/azure/messaging/servicebus/implementation/ManagementChannel.java b/...icebus/src/main/java/com/azure/messaging/servicebus/implementation/ManagementChannel.java
@@ -506,7 +506,7 @@ public Mono<Void> deleteRule(String ruleName) {
      * {@inheritDoc}
      */
     @Override
-    public Flux<RuleProperties> getRules() {
+    public Flux<RuleProperties> listRules() {
         return isAuthorized(OPERATION_GET_RULES).then(createChannel.flatMap(channel -> {
             final Message message = createManagementMessage(OPERATION_GET_RULES, null);
 

diff --git a/...src/main/java/com/azure/messaging/servicebus/implementation/ServiceBusManagementNode.java b/...src/main/java/com/azure/messaging/servicebus/implementation/ServiceBusManagementNode.java
@@ -146,7 +146,7 @@ Mono<Void> updateDisposition(String lockToken, DispositionStatus dispositionStat
      *
      * @return A collection of {@link RuleProperties rules}.
      */
-    Flux<RuleProperties> getRules();
+    Flux<RuleProperties> listRules();
 
     @Override
     void close();

diff --git a/...ng-servicebus/src/samples/java/com/azure/messaging/servicebus/ManageRulesAsyncSample.java b/...ng-servicebus/src/samples/java/com/azure/messaging/servicebus/ManageRulesAsyncSample.java
@@ -61,7 +61,7 @@ public void run() {
         );
 
         // Fetch all rules.
-        ruleManager.getRules().subscribe(ruleProperties -> System.out.println(ruleProperties.getName()));
+        ruleManager.listRules().subscribe(ruleProperties -> System.out.println(ruleProperties.getName()));
 
         // Delete rule.
         ruleManager.deleteRule("exist-rule").subscribe(

diff --git a/...es/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClientJavaDocSample.java b/...es/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClientJavaDocSample.java
@@ -84,7 +84,7 @@ public void createRule() {
     @Test
     public void getRules() {
         // BEGIN: com.azure.messaging.servicebus.servicebusrulemanagerasyncclient.getRules
-        ruleManager.getRules().subscribe(ruleProperties -> System.out.println(ruleProperties.getName()));
+        ruleManager.listRules().subscribe(ruleProperties -> System.out.println(ruleProperties.getName()));
         // END: com.azure.messaging.servicebus.servicebusrulemanagerasyncclient.getRules
     }
 

diff --git a/...us/src/test/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClientTest.java b/...us/src/test/java/com/azure/messaging/servicebus/ServiceBusRuleManagerAsyncClientTest.java
@@ -12,7 +12,6 @@
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.logging.ClientLogger;
 import com.azure.messaging.servicebus.administration.models.CreateRuleOptions;
-import com.azure.messaging.servicebus.administration.models.RuleFilter;
 import com.azure.messaging.servicebus.administration.models.RuleProperties;
 import com.azure.messaging.servicebus.administration.models.SqlRuleFilter;
 import com.azure.messaging.servicebus.implementation.MessagingEntityType;
@@ -37,8 +36,6 @@
 
 import java.time.Duration;
 
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.when;
 
 public class ServiceBusRuleManagerAsyncClientTest {
@@ -120,20 +117,6 @@ void teardown(TestInfo testInfo) throws Exception {
         mocksCloseable.close();
     }
 
-    /**
-     * Verifies that create a rule with a {@link RuleFilter}.
-     */
-    @Test
-    void createRuleWithFilter() {
-        // Arrange
-        when(managementNode.createRule(eq(RULE_NAME), any(CreateRuleOptions.class))).thenReturn(Mono.empty());
-
-        // Act & Assert
-        StepVerifier.create(ruleManager.createRule(RULE_NAME, ruleFilter))
-            .expectComplete()
-            .verify();
-    }
-
     /**
      * Verifies that create a rule with a {@link CreateRuleOptions}.
      */
@@ -150,10 +133,10 @@ void createRuleWithOptions() {
     @Test
     void getRules() {
         // Arrange
-        when(managementNode.getRules()).thenReturn(Flux.fromArray(new RuleProperties[]{ruleProperties1, ruleProperties2}));
+        when(managementNode.listRules()).thenReturn(Flux.fromArray(new RuleProperties[]{ruleProperties1, ruleProperties2}));
 
         // Act & Assert
-        StepVerifier.create(ruleManager.getRules()).expectNext(ruleProperties1, ruleProperties2).verifyComplete();
+        StepVerifier.create(ruleManager.listRules()).expectNext(ruleProperties1, ruleProperties2).verifyComplete();
     }
 
     @Test

diff --git a/...s/src/test/java/com/azure/messaging/servicebus/implementation/ManagementChannelTests.java b/...s/src/test/java/com/azure/messaging/servicebus/implementation/ManagementChannelTests.java
@@ -586,7 +586,7 @@ void getRules() {
         responseMessage.setBody(message.getBody());
 
         // Assert response message content.
-        StepVerifier.create(managementChannel.getRules())
+        StepVerifier.create(managementChannel.listRules())
             .assertNext(ruleProperties -> {
                 assertEquals("$Default", ruleProperties.getName());
                 assertEquals(ruleProperties.getFilter(), new TrueRuleFilter());