Rename ClientEndpointType to WebPubSubClientProtocol (Azure#41147)

* rename ClientEndpointType to ClientType

* update changelog

Co-authored-by: Liangying.Wei <[email protected]>

* rename to WebPubSubClientAccess

* change name to WebPubSubClientProtocol

---------

Co-authored-by: chuongnguyen <[email protected]>
Co-authored-by: Liangying.Wei <[email protected]>

Author: cqnguy23

sdk/webpubsub/azure-messaging-webpubsub/CHANGELOG.md

@@ -4,8 +4,7 @@
 
 ### Features Added
 
-- Added a `clientEndpointType` option to `GenerateClientTokenOptions` to specify the type of client endpoint
-  when generating token. This option can be used to generate token and client connection URL for a specific client endpoint type, such as `Default` or `MQTT`.
+- Added a `webPubSubClientProtocol` option to `GenerateClientTokenOptions` to specify the type of client when generating token. This option can be used to generate token and client connection URL for a specific client type, such as `Default` or `MQTT`.
 - Added a `addConnectionsToGroups` method to `WebPubSubServiceClient` and `WebPubSubServiceAsyncClient` to add filtered connections to multiple groups.
 - Migrated serialization to `azure-json` which offers implementation agnostic serialization, providing support for
   more serialization frameworks than just Jackson.

sdk/webpubsub/azure-messaging-webpubsub/src/main/java/com/azure/messaging/webpubsub/WebPubSubServiceAsyncClient.java

@@ -21,7 +21,7 @@
 import com.azure.messaging.webpubsub.implementation.WebPubSubUtil;
 import com.azure.messaging.webpubsub.implementation.WebPubSubsImpl;
 import com.azure.messaging.webpubsub.implementation.models.AddToGroupsRequest;
-import com.azure.messaging.webpubsub.models.ClientEndpointType;
+import com.azure.messaging.webpubsub.models.WebPubSubClientProtocol;
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
@@ -59,8 +59,8 @@ public final class WebPubSubServiceAsyncClient {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<WebPubSubClientAccessToken> getClientAccessToken(GetClientAccessTokenOptions options) {
-        final ClientEndpointType clientEndpointType = options.getClientEndpointType();
-        final String path = clientEndpointType.equals(ClientEndpointType.MQTT)
+        final WebPubSubClientProtocol webPubSubClientProtocol = options.getWebPubSubClientAccess();
+        final String path = webPubSubClientProtocol.equals(WebPubSubClientProtocol.MQTT)
             ? "clients/mqtt/hubs/" : "client/hubs/";
         if (this.keyCredential == null) {
             return this.serviceClient.generateClientTokenWithResponseAsync(hub,
@@ -91,8 +91,8 @@ static RequestOptions configureClientAccessTokenRequestOptions(GetClientAccessTo
         if (!CoreUtils.isNullOrEmpty(options.getGroups())) {
             options.getGroups().stream().forEach(groupName -> requestOptions.addQueryParam("group", groupName));
         }
-        if (options.getClientEndpointType() != null) {
-            requestOptions.addQueryParam("clientType", options.getClientEndpointType().toString());
+        if (options.getWebPubSubClientAccess() != null) {
+            requestOptions.addQueryParam("clientType", options.getWebPubSubClientAccess().toString());
         }
         return requestOptions;
     }

sdk/webpubsub/azure-messaging-webpubsub/src/main/java/com/azure/messaging/webpubsub/WebPubSubServiceClient.java

@@ -19,7 +19,7 @@
 import com.azure.messaging.webpubsub.implementation.WebPubSubUtil;
 import com.azure.messaging.webpubsub.implementation.WebPubSubsImpl;
 import com.azure.messaging.webpubsub.implementation.models.AddToGroupsRequest;
-import com.azure.messaging.webpubsub.models.ClientEndpointType;
+import com.azure.messaging.webpubsub.models.WebPubSubClientProtocol;
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
@@ -60,8 +60,8 @@ public final class WebPubSubServiceClient {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public WebPubSubClientAccessToken getClientAccessToken(GetClientAccessTokenOptions options) {
-        final ClientEndpointType clientEndpointType = options.getClientEndpointType();
-        final String path = clientEndpointType.equals(ClientEndpointType.MQTT)
+        final WebPubSubClientProtocol webPubSubClientProtocol = options.getWebPubSubClientAccess();
+        final String path = webPubSubClientProtocol.equals(WebPubSubClientProtocol.MQTT)
             ? "clients/mqtt/hubs/" : "client/hubs/";
         if (this.keyCredential == null) {
             Response<BinaryData> response = serviceClient.generateClientTokenWithResponse(hub,

sdk/webpubsub/azure-messaging-webpubsub/src/main/java/com/azure/messaging/webpubsub/models/GetClientAccessTokenOptions.java

@@ -20,13 +20,13 @@ public final class GetClientAccessTokenOptions {
     private String userId;
     private List<String> roles;
     private List<String> groups;
-    private ClientEndpointType clientEndpointType;
+    private WebPubSubClientProtocol webPubSubClientProtocol;
 
     /**
      * Creates an instance of GetClientAccessTokenOptions.
      */
     public GetClientAccessTokenOptions() {
-        this.clientEndpointType = ClientEndpointType.DEFAULT;
+        this.webPubSubClientProtocol = WebPubSubClientProtocol.DEFAULT;
     }
 
     /**
@@ -130,18 +130,18 @@ public GetClientAccessTokenOptions setGroups(List<String> groups) {
      *
      * @return The same instance of this type, modified based on the value provided in this set method.
      */
-    public ClientEndpointType getClientEndpointType() {
-        return clientEndpointType;
+    public WebPubSubClientProtocol getWebPubSubClientAccess() {
+        return webPubSubClientProtocol;
     }
 
     /**
      * Specifies the endpoint type of the client. Default type is <code>default</code>
      *
-     * @param clientEndpointType The endpoint type of client
+     * @param webPubSubClientProtocol The endpoint type of client
      * @return The same instance of this type, modified based on the value provided in this set method.
      */
-    public GetClientAccessTokenOptions setClientEndpointType(final ClientEndpointType clientEndpointType) {
-        this.clientEndpointType = clientEndpointType;
+    public GetClientAccessTokenOptions setWebPubSubClientAccess(final WebPubSubClientProtocol webPubSubClientProtocol) {
+        this.webPubSubClientProtocol = webPubSubClientProtocol;
         return this;
     }
 

sdk/webpubsub/azure-messaging-webpubsub/src/main/java/com/azure/messaging/webpubsub/models/ClientEndpointType.java renamed to sdk/webpubsub/azure-messaging-webpubsub/src/main/java/com/azure/messaging/webpubsub/models/WebPubSubClientProtocol.java

@@ -4,9 +4,9 @@
 package com.azure.messaging.webpubsub.models;
 
 /**
- * Defines values for ClientEndpointType
+ * Defines values for WebPubSubClientProtocol
  */
-public enum ClientEndpointType {
+public enum WebPubSubClientProtocol {
     /**
      * Default WebPubSub Client Endpoint. E.g: <code>wss://exampleHost.com/client/hubs/exampleHub</code>
      */
@@ -18,23 +18,23 @@ public enum ClientEndpointType {
     MQTT("mqtt");
 
     /**
-     * The actual serialized value for a ClientEndpointType.
+     * The actual serialized value for a WebPubSubClientProtocol.
      */
     private final String value;
 
-    ClientEndpointType(String value) {
+    WebPubSubClientProtocol(String value) {
         this.value = value;
     }
 
     /**
-     * Parses a serialized value to a ClientEndpointType instance.
+     * Parses a serialized value to a WebPubSubClientProtocol instance.
      *
      * @param value the serialized value to parse.
-     * @return the parsed ClientEndpointType object, or null if unable to parse.
+     * @return the parsed WebPubSubClientProtocol object, or null if unable to parse.
      */
-    public static ClientEndpointType fromString(String value) {
-        ClientEndpointType[] items = ClientEndpointType.values();
-        for (ClientEndpointType item : items) {
+    public static WebPubSubClientProtocol fromString(String value) {
+        WebPubSubClientProtocol[] items = WebPubSubClientProtocol.values();
+        for (WebPubSubClientProtocol item : items) {
             if (item.toString().equalsIgnoreCase(value)) {
                 return item;
             }

sdk/webpubsub/azure-messaging-webpubsub/src/test/java/com/azure/messaging/webpubsub/WebPubSubServiceAsyncClientTests.java

@@ -16,7 +16,7 @@
 import com.azure.core.test.annotation.LiveOnly;
 import com.azure.core.util.BinaryData;
 import com.azure.identity.DefaultAzureCredentialBuilder;
-import com.azure.messaging.webpubsub.models.ClientEndpointType;
+import com.azure.messaging.webpubsub.models.WebPubSubClientProtocol;
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
 import com.azure.messaging.webpubsub.models.WebPubSubPermission;
@@ -276,7 +276,7 @@ public void testGetAuthenticationToken() {
     @LiveOnly
     public void testGetMqttAuthenticationToken() {
         GetClientAccessTokenOptions options = new GetClientAccessTokenOptions();
-        options.setClientEndpointType(ClientEndpointType.MQTT);
+        options.setWebPubSubClientAccess(WebPubSubClientProtocol.MQTT);
         StepVerifier.create(client.getClientAccessToken(options))
             .assertNext(token -> {
                 Assertions.assertNotNull(token);

sdk/webpubsub/azure-messaging-webpubsub/src/test/java/com/azure/messaging/webpubsub/WebPubSubServiceClientTests.java

@@ -16,7 +16,7 @@
 import com.azure.core.test.annotation.LiveOnly;
 import com.azure.core.util.BinaryData;
 import com.azure.identity.DefaultAzureCredentialBuilder;
-import com.azure.messaging.webpubsub.models.ClientEndpointType;
+import com.azure.messaging.webpubsub.models.WebPubSubClientProtocol;
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
@@ -244,7 +244,7 @@ public void testGetAuthenticationToken() throws ParseException {
     @LiveOnly
     public void testGetMqttAuthenticationToken() throws ParseException {
         GetClientAccessTokenOptions options = new GetClientAccessTokenOptions()
-            .setClientEndpointType(ClientEndpointType.MQTT);
+            .setWebPubSubClientAccess(WebPubSubClientProtocol.MQTT);
         WebPubSubClientAccessToken token = client.getClientAccessToken(options);
 
         Assertions.assertNotNull(token);