Add presence API to webpubsub service sdk (Azure#45834)

Author: Y-Sindo

eng/versioning/external_dependencies.txt

@@ -86,7 +86,7 @@ org.codehaus.groovy:groovy-jsr223;3.0.19
 org.codehaus.janino:janino;3.1.10
 org.codehaus.woodstox:stax2-api;4.2.2
 org.conscrypt:conscrypt-openjdk-uber;2.5.2
-org.glassfish.tyrus:tyrus-client;1.16
+org.glassfish.tyrus:tyrus-container-grizzly-client;1.21
 org.openjfx:javafx-graphics;17.0.6
 org.graalvm.buildtools:junit-platform-native;0.9.19
 org.graalvm.buildtools:native-maven-plugin;0.10.5

eng/versioning/version_client.txt

@@ -154,7 +154,7 @@ com.azure:azure-messaging-eventhubs-track2-perf;1.0.0-beta.1;1.0.0-beta.1
 com.azure:azure-messaging-servicebus;7.17.11;7.18.0-beta.2
 com.azure:azure-messaging-servicebus-stress;1.0.0-beta.1;1.0.0-beta.1
 com.azure:azure-messaging-servicebus-track2-perf;1.0.0-beta.1;1.0.0-beta.1
-com.azure:azure-messaging-webpubsub;1.4.1;1.5.0-beta.1
+com.azure:azure-messaging-webpubsub;1.4.1;1.5.0
 com.azure:azure-messaging-webpubsub-client;1.1.1;1.2.0-beta.1
 com.azure:azure-mixedreality-authentication;1.2.32;1.3.0-beta.1
 com.azure:azure-mixedreality-remoterendering;1.1.37;1.2.0-beta.1

sdk/webpubsub/azure-messaging-webpubsub-client/pom.xml

@@ -82,7 +82,7 @@
     <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-messaging-webpubsub</artifactId>
-      <version>1.5.0-beta.1</version> <!-- {x-version-update;com.azure:azure-messaging-webpubsub;current} -->
+      <version>1.5.0</version> <!-- {x-version-update;com.azure:azure-messaging-webpubsub;current} -->
       <scope>test</scope>
     </dependency>
     <dependency>

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

@@ -1,8 +1,9 @@
 # Release History
 
-## 1.5.0-beta.1 (Unreleased)
+## 1.5.0 (Unreleased)
 
 ### Features Added
+- Add "listConnectionsInGroup" API.
 
 ### Breaking Changes
 
@@ -262,7 +263,7 @@
 ### Bugs Fixed
 
 - Fixed incorrect "audience" from `getClientAccessToken` method in `WebPubSubServiceAsyncClient`. ([#24741](https://github.com/Azure/azure-sdk-for-java/issues/24741))
-- Fixed bug of getting incorrect token in `getClientAccessToken` method from Azure token credential. 
+- Fixed bug of getting incorrect token in `getClientAccessToken` method from Azure token credential.
 
 ### Features Added
 
@@ -430,7 +431,7 @@
 
 ### Features Added
 - Added support for [Azure Active Directory](https://docs.microsoft.com/azure/active-directory/authentication/) based authentication.
-- Added support for API management by configuring `reverseProxyEndpoint` on the client builder. 
+- Added support for API management by configuring `reverseProxyEndpoint` on the client builder.
   https://github.com/Azure/azure-webpubsub/issues/194 describes how to integrate with the API Management service.
 
 ## 1.0.0-beta.3 (2021-07-29)
@@ -449,9 +450,9 @@
 - Fixed issue with generating token that included only the last role in the input list.
 
 ## 1.0.0-beta.1 (2021-04-22)
-Version 1.0.0-beta.1 is a preview of our efforts in creating a client library for Azure Web PubSub that is 
-developer-friendly, idiomatic to the Java ecosystem, and as consistent across different languages and platforms as 
-possible. The principles that guide our efforts can be found in the 
+Version 1.0.0-beta.1 is a preview of our efforts in creating a client library for Azure Web PubSub that is
+developer-friendly, idiomatic to the Java ecosystem, and as consistent across different languages and platforms as
+possible. The principles that guide our efforts can be found in the
 [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java_introduction.html).
 
 - Initial release. Please see the README and wiki for information on using the new library.

sdk/webpubsub/azure-messaging-webpubsub/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/webpubsub/azure-messaging-webpubsub",
-  "Tag": "java/webpubsub/azure-messaging-webpubsub_b39e249795"
+  "Tag": "java/webpubsub/azure-messaging-webpubsub_eeba9be155"
 }

sdk/webpubsub/azure-messaging-webpubsub/pom.xml

@@ -13,7 +13,7 @@
 
   <groupId>com.azure</groupId>
   <artifactId>azure-messaging-webpubsub</artifactId>
-  <version>1.5.0-beta.1</version> <!-- {x-version-update;com.azure:azure-messaging-webpubsub;current} -->
+  <version>1.5.0</version> <!-- {x-version-update;com.azure:azure-messaging-webpubsub;current} -->
 
   <name>Microsoft Azure client library for Azure Web Pub Sub Service</name>
   <description>This package contains the Microsoft Azure Web Pub Sub library.</description>
@@ -81,8 +81,8 @@
     </dependency>
     <dependency>
       <groupId>org.glassfish.tyrus</groupId>
-      <artifactId>tyrus-client</artifactId>
-      <version>1.16</version>  <!-- {x-version-update;org.glassfish.tyrus:tyrus-client;external_dependency} -->
+      <artifactId>tyrus-container-grizzly-client</artifactId>
+      <version>1.21</version>  <!-- {x-version-update;org.glassfish.tyrus:tyrus-container-grizzly-client;external_dependency} -->
       <scope>test</scope>
       <exclusions>
         <exclusion>

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

@@ -13,6 +13,9 @@
 import com.azure.core.exception.ResourceModifiedException;
 import com.azure.core.exception.ResourceNotFoundException;
 import com.azure.core.http.HttpHeaderName;
+import com.azure.core.http.rest.PagedFlux;
+import com.azure.core.http.rest.PagedResponse;
+import com.azure.core.http.rest.PagedResponseBase;
 import com.azure.core.http.rest.RequestOptions;
 import com.azure.core.http.rest.Response;
 import com.azure.core.util.BinaryData;
@@ -25,7 +28,10 @@
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
+import com.azure.messaging.webpubsub.models.WebPubSubGroupMember;
 import com.azure.messaging.webpubsub.models.WebPubSubPermission;
+
+import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import java.util.List;
@@ -409,6 +415,61 @@ public Mono<Void> addConnectionsToGroups(List<String> groups, String filter) {
         return addConnectionsToGroupsWithResponse(body, new RequestOptions()).flatMap(FluxUtil::toMono);
     }
 
+    /**
+     * List connections in a group.
+     * <p>
+     * <strong>Query Parameters</strong>
+     * </p>
+     * <table border="1">
+     *     <caption>Query Parameters</caption>
+     *     <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
+     *     <tr><td>maxpagesize</td><td>Integer</td><td>No</td><td>The maximum number of connections to include in a single response. It should be between 1 and 200.</td></tr>
+     *     <tr><td>top</td><td>Integer</td>
+     *     <td>No</td><td>The maximum number of connections to return. If the value is not set, then all the connections in a group are returned.</td></tr>
+     * </table>
+     * You can add these to a request with {@link RequestOptions#addQueryParam}
+     * <p>
+     * <strong>Response Body Schema</strong>
+     * </p>
+     *
+     * <pre>
+     * {@code
+     * {
+     *     connectionId: String (Required)
+     *     userId: String (Optional)
+     * }
+     * }
+     * </pre>
+     *
+     * @param hub Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
+     * @param group Target group name, whose length should be greater than 0 and less than 1025.
+     * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+     * @return represents a page of elements as a LIST REST API result as paginated response with {@link PagedFlux}.
+     */
+    @ServiceMethod(returns = ReturnType.COLLECTION)
+    public PagedFlux<WebPubSubGroupMember> listConnectionsInGroup(String hub, String group,
+        RequestOptions requestOptions) {
+        PagedFlux<BinaryData> binaryDataPagedFlux
+            = this.serviceClient.listConnectionsInGroupAsync(hub, group, requestOptions);
+
+        return PagedFlux.create(() -> (continuationTokenParam, pageSizeParam) -> {
+            Flux<PagedResponse<BinaryData>> flux = (continuationTokenParam == null)
+                ? binaryDataPagedFlux.byPage().take(1)
+                : binaryDataPagedFlux.byPage(continuationTokenParam).take(1);
+            return flux.map(pagedResponse -> new PagedResponseBase<>(pagedResponse.getRequest(),
+                pagedResponse.getStatusCode(), pagedResponse.getHeaders(),
+                pagedResponse.getValue()
+                    .stream()
+                    .map(bd -> bd.toObject(WebPubSubGroupMember.class))
+                    .collect(java.util.stream.Collectors.toList()),
+                pagedResponse.getContinuationToken(), null));
+        });
+    }
+
     /**
      * Remove a connection from the target group.
      *

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

@@ -13,6 +13,7 @@
 import com.azure.core.exception.ResourceModifiedException;
 import com.azure.core.exception.ResourceNotFoundException;
 import com.azure.core.http.HttpHeaderName;
+import com.azure.core.http.rest.PagedIterable;
 import com.azure.core.http.rest.RequestOptions;
 import com.azure.core.http.rest.Response;
 import com.azure.core.util.BinaryData;
@@ -23,6 +24,7 @@
 import com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions;
 import com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken;
 import com.azure.messaging.webpubsub.models.WebPubSubContentType;
+import com.azure.messaging.webpubsub.models.WebPubSubGroupMember;
 import com.azure.messaging.webpubsub.models.WebPubSubPermission;
 
 import java.util.List;
@@ -653,4 +655,43 @@ public Response<Void> closeGroupConnectionsWithResponse(String group, RequestOpt
     public Response<Void> closeUserConnectionsWithResponse(String userId, RequestOptions requestOptions) {
         return this.serviceClient.closeUserConnectionsWithResponse(hub, userId, requestOptions);
     }
+
+    /**
+     * List connections in a group.
+     * <p>
+     * <strong>Query Parameters</strong>
+     * </p>
+     * <table border="1">
+     *     <caption>Query Parameters</caption>
+     *     <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
+     *     <tr><td>maxpagesize</td><td>Integer</td><td>No</td><td>The maximum number of connections to include in a single response. It should be between 1 and 200.</td></tr>
+     *     <tr><td>top</td><td>Integer</td><td>No</td><td>The maximum number of connections to return. If the value is not set, then all the connections in a group are returned.</td></tr>
+     * </table>
+     * You can add these to a request with {@link RequestOptions#addQueryParam}
+     * <p>
+     * <strong>Response Body Schema</strong>
+     * </p>
+     *
+     * <pre>
+     * {@code
+     * {
+     *     connectionId: String (Required)
+     *     userId: String (Optional)
+     * }
+     * }
+     * </pre>
+     *
+     * @param group Target group name, whose length should be greater than 0 and less than 1025.
+     * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+     * @return represents a page of elements as a LIST REST API result as paginated response with {@link PagedIterable}.
+     */
+    @ServiceMethod(returns = ReturnType.COLLECTION)
+    public PagedIterable<WebPubSubGroupMember> listConnectionsInGroup(String group, RequestOptions requestOptions) {
+        return this.serviceClient.listConnectionsInGroup(hub, group, requestOptions)
+            .mapPage(binaryData -> binaryData.toObject(WebPubSubGroupMember.class));
+    }
 }

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

@@ -23,7 +23,12 @@ public enum WebPubSubServiceVersion implements ServiceVersion {
     /**
      * Enum value 2024-01-01.
      */
-    V2024_01_01("2024-01-01");
+    V2024_01_01("2024-01-01"),
+
+    /**
+     * Enum value 2024-12-01.
+     */
+    V2024_12_01("2024-12-01");
 
     private final String version;
 
@@ -45,6 +50,6 @@ public String getVersion() {
      * @return The latest {@link WebPubSubServiceVersion}.
      */
     public static WebPubSubServiceVersion getLatest() {
-        return V2024_01_01;
+        return V2024_12_01;
     }
 }