Package com.azure.messaging.webpubsub

Class WebPubSubServiceClient

java.lang.Object

com.azure.messaging.webpubsub.WebPubSubServiceClient

public final class WebPubSubServiceClient
extends Object

Initializes a new instance of the synchronous AzureWebPubSubServiceRestAPI type.

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.Response<Void>	addConnectionToGroupWithResponse(String group, String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Add a connection to the target group.
com.azure.core.http.rest.Response<Void>	addUserToGroupWithResponse(String group, String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Add a user to the target group.
com.azure.core.http.rest.Response<Boolean>	checkPermissionWithResponse(WebPubSubPermission permission, String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Check if a connection has permission to the specified action.
com.azure.core.http.rest.Response<Void>	closeAllConnectionsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Close the connections in the hub.
com.azure.core.http.rest.Response<Void>	closeConnectionWithResponse(String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Close the client connection.
com.azure.core.http.rest.Response<Void>	closeGroupConnectionsWithResponse(String group, com.azure.core.http.rest.RequestOptions requestOptions)	Close connections in the specific group.
com.azure.core.http.rest.Response<Void>	closeUserConnectionsWithResponse(String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Close connections for the specific user.
com.azure.core.http.rest.Response<Boolean>	connectionExistsWithResponse(String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Check if the connection with the given connectionId exists.
WebPubSubClientAccessToken	getClientAccessToken(GetClientAccessTokenOptions options)	Creates a client access token.
com.azure.core.http.rest.Response<Void>	grantPermissionWithResponse(WebPubSubPermission permission, String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Grant permission to the connection.
com.azure.core.http.rest.Response<Boolean>	groupExistsWithResponse(String group, com.azure.core.http.rest.RequestOptions requestOptions)	Check if there are any client connections inside the given group.
com.azure.core.http.rest.Response<Void>	removeConnectionFromGroupWithResponse(String group, String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Remove a connection from the target group.
com.azure.core.http.rest.Response<Void>	removeUserFromAllGroupsWithResponse(String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Remove a user from all groups.
com.azure.core.http.rest.Response<Void>	removeUserFromGroupWithResponse(String group, String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Remove a user from the target group.
com.azure.core.http.rest.Response<Void>	revokePermissionWithResponse(WebPubSubPermission permission, String connectionId, com.azure.core.http.rest.RequestOptions requestOptions)	Revoke permission for the connection.
void	sendToAll(String message, WebPubSubContentType contentType)	Broadcast content inside request body to all the connected client connections.
com.azure.core.http.rest.Response<Void>	sendToAllWithResponse(com.azure.core.util.BinaryData message, com.azure.core.http.rest.RequestOptions requestOptions)	Broadcast content inside request body to all the connected client connections.
com.azure.core.http.rest.Response<Void>	sendToAllWithResponse(com.azure.core.util.BinaryData message, WebPubSubContentType contentType, long contentLength, com.azure.core.http.rest.RequestOptions requestOptions)	Broadcast content inside request body to all the connected client connections.
void	sendToConnection(String connectionId, String message, WebPubSubContentType contentType)	Send content inside request body to the specific connection.
com.azure.core.http.rest.Response<Void>	sendToConnectionWithResponse(String connectionId, com.azure.core.util.BinaryData message, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to the specific connection.
com.azure.core.http.rest.Response<Void>	sendToConnectionWithResponse(String connectionId, com.azure.core.util.BinaryData message, WebPubSubContentType contentType, long contentLength, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to the specific connection.
void	sendToGroup(String group, String message, WebPubSubContentType contentType)	Send content inside request body to a group of connections.
com.azure.core.http.rest.Response<Void>	sendToGroupWithResponse(String group, com.azure.core.util.BinaryData message, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to a group of connections.
com.azure.core.http.rest.Response<Void>	sendToGroupWithResponse(String group, com.azure.core.util.BinaryData message, WebPubSubContentType contentType, long contentLength, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to a group of connections.
void	sendToUser(String userId, String message, WebPubSubContentType contentType)	Send content inside request body to the specific user.
com.azure.core.http.rest.Response<Void>	sendToUserWithResponse(String userId, com.azure.core.util.BinaryData message, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to the specific user.
com.azure.core.http.rest.Response<Void>	sendToUserWithResponse(String userId, com.azure.core.util.BinaryData message, WebPubSubContentType contentType, long contentLength, com.azure.core.http.rest.RequestOptions requestOptions)	Send content inside request body to the specific user.
com.azure.core.http.rest.Response<Boolean>	userExistsWithResponse(String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Check if there are any client connections connected for the given user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClientAccessToken

public WebPubSubClientAccessToken getClientAccessToken(GetClientAccessTokenOptions options)

Creates a client access token.

Parameters:

options - Options to apply when creating the client access token.

Returns:

A new client access instance.

sendToAllWithResponse

public com.azure.core.http.rest.Response<Void> sendToAllWithResponse(com.azure.core.util.BinaryData message,
                                                                     WebPubSubContentType contentType,
                                                                     long contentLength,
                                                                     com.azure.core.http.rest.RequestOptions requestOptions)

Broadcast content inside request body to all the connected client connections.

Parameters:

message - The payload body.

contentType - Upload file type.

contentLength - The contentLength parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToAll

public void sendToAll(String message,
                      WebPubSubContentType contentType)

Broadcast content inside request body to all the connected client connections.

Parameters:

message - The payload body.

contentType - Upload file type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToAllWithResponse

public com.azure.core.http.rest.Response<Void> sendToAllWithResponse(com.azure.core.util.BinaryData message,
                                                                     com.azure.core.http.rest.RequestOptions requestOptions)

Broadcast content inside request body to all the connected client connections.

Parameters:

message - The payload body.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

connectionExistsWithResponse

public com.azure.core.http.rest.Response<Boolean> connectionExistsWithResponse(String connectionId,
                                                                               com.azure.core.http.rest.RequestOptions requestOptions)

Check if the connection with the given connectionId exists.

Parameters:

connectionId - The connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

closeConnectionWithResponse

public com.azure.core.http.rest.Response<Void> closeConnectionWithResponse(String connectionId,
                                                                           com.azure.core.http.rest.RequestOptions requestOptions)

Close the client connection.

Parameters:

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToConnectionWithResponse

public com.azure.core.http.rest.Response<Void> sendToConnectionWithResponse(String connectionId,
                                                                            com.azure.core.util.BinaryData message,
                                                                            WebPubSubContentType contentType,
                                                                            long contentLength,
                                                                            com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to the specific connection.

Parameters:

connectionId - The connection Id.

message - The payload body.

contentType - Upload file type.

contentLength - The contentLength parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToConnection

public void sendToConnection(String connectionId,
                             String message,
                             WebPubSubContentType contentType)

Send content inside request body to the specific connection.

Parameters:

connectionId - The connection Id.

message - The payload body.

contentType - Upload file type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToConnectionWithResponse

public com.azure.core.http.rest.Response<Void> sendToConnectionWithResponse(String connectionId,
                                                                            com.azure.core.util.BinaryData message,
                                                                            com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to the specific connection.

Parameters:

connectionId - The connection Id.

message - The payload body.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

groupExistsWithResponse

public com.azure.core.http.rest.Response<Boolean> groupExistsWithResponse(String group,
                                                                          com.azure.core.http.rest.RequestOptions requestOptions)

Check if there are any client connections inside the given group.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToGroupWithResponse

public com.azure.core.http.rest.Response<Void> sendToGroupWithResponse(String group,
                                                                       com.azure.core.util.BinaryData message,
                                                                       WebPubSubContentType contentType,
                                                                       long contentLength,
                                                                       com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to a group of connections.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

message - The payload body.

contentType - Upload file type.

contentLength - The contentLength parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToGroup

public void sendToGroup(String group,
                        String message,
                        WebPubSubContentType contentType)

Send content inside request body to a group of connections.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

message - The payload body.

contentType - Upload file type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToGroupWithResponse

public com.azure.core.http.rest.Response<Void> sendToGroupWithResponse(String group,
                                                                       com.azure.core.util.BinaryData message,
                                                                       com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to a group of connections.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

message - The payload body.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addConnectionToGroupWithResponse

public com.azure.core.http.rest.Response<Void> addConnectionToGroupWithResponse(String group,
                                                                                String connectionId,
                                                                                com.azure.core.http.rest.RequestOptions requestOptions)

Add a connection to the target group.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeConnectionFromGroupWithResponse

public com.azure.core.http.rest.Response<Void> removeConnectionFromGroupWithResponse(String group,
                                                                                     String connectionId,
                                                                                     com.azure.core.http.rest.RequestOptions requestOptions)

Remove a connection from the target group.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

userExistsWithResponse

public com.azure.core.http.rest.Response<Boolean> userExistsWithResponse(String userId,
                                                                         com.azure.core.http.rest.RequestOptions requestOptions)

Check if there are any client connections connected for the given user.

Parameters:

userId - Target user Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToUserWithResponse

public com.azure.core.http.rest.Response<Void> sendToUserWithResponse(String userId,
                                                                      com.azure.core.util.BinaryData message,
                                                                      WebPubSubContentType contentType,
                                                                      long contentLength,
                                                                      com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to the specific user.

Parameters:

userId - The user Id.

message - The payload body.

contentType - Upload file type.

contentLength - The contentLength parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToUser

public void sendToUser(String userId,
                       String message,
                       WebPubSubContentType contentType)

Send content inside request body to the specific user.

Parameters:

userId - The user Id.

message - The payload body.

contentType - Upload file type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendToUserWithResponse

public com.azure.core.http.rest.Response<Void> sendToUserWithResponse(String userId,
                                                                      com.azure.core.util.BinaryData message,
                                                                      com.azure.core.http.rest.RequestOptions requestOptions)

Send content inside request body to the specific user.

Parameters:

userId - The user Id.

message - The payload body.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addUserToGroupWithResponse

public com.azure.core.http.rest.Response<Void> addUserToGroupWithResponse(String group,
                                                                          String userId,
                                                                          com.azure.core.http.rest.RequestOptions requestOptions)

Add a user to the target group.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

userId - Target user Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeUserFromGroupWithResponse

public com.azure.core.http.rest.Response<Void> removeUserFromGroupWithResponse(String group,
                                                                               String userId,
                                                                               com.azure.core.http.rest.RequestOptions requestOptions)

Remove a user from the target group.

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

userId - Target user Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeUserFromAllGroupsWithResponse

public com.azure.core.http.rest.Response<Void> removeUserFromAllGroupsWithResponse(String userId,
                                                                                   com.azure.core.http.rest.RequestOptions requestOptions)

Remove a user from all groups.

Parameters:

userId - Target user Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

grantPermissionWithResponse

public com.azure.core.http.rest.Response<Void> grantPermissionWithResponse(WebPubSubPermission permission,
                                                                           String connectionId,
                                                                           com.azure.core.http.rest.RequestOptions requestOptions)

Grant permission to the connection.

Parameters:

permission - The permission: current supported actions are joinLeaveGroup and sendToGroup.

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

revokePermissionWithResponse

public com.azure.core.http.rest.Response<Void> revokePermissionWithResponse(WebPubSubPermission permission,
                                                                            String connectionId,
                                                                            com.azure.core.http.rest.RequestOptions requestOptions)

Revoke permission for the connection.

Parameters:

permission - The permission: current supported actions are joinLeaveGroup and sendToGroup.

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkPermissionWithResponse

public com.azure.core.http.rest.Response<Boolean> checkPermissionWithResponse(WebPubSubPermission permission,
                                                                              String connectionId,
                                                                              com.azure.core.http.rest.RequestOptions requestOptions)

Check if a connection has permission to the specified action.

Parameters:

permission - The permission: current supported actions are joinLeaveGroup and sendToGroup.

connectionId - Target connection Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

closeAllConnectionsWithResponse

public com.azure.core.http.rest.Response<Void> closeAllConnectionsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Close the connections in the hub.

Query Parameters

Query Parameters

Name	Type	Required	Description
excluded	String	No	Exclude these connectionIds when closing the connections in the hub.
reason	String	No	The reason closing the client connection.
apiVersion	String	Yes	Api Version

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if status code is 400 or above, if throwOnError in requestOptions is not false.

closeGroupConnectionsWithResponse

public com.azure.core.http.rest.Response<Void> closeGroupConnectionsWithResponse(String group,
                                                                                 com.azure.core.http.rest.RequestOptions requestOptions)

Close connections in the specific group.

Query Parameters

Query Parameters

Name	Type	Required	Description
excluded	String	No	Exclude these connectionIds when closing the connections in the group.
reason	String	No	The reason closing the client connection.
apiVersion	String	Yes	Api Version

Parameters:

group - Target group name, which length should be greater than 0 and less than 1025.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if status code is 400 or above, if throwOnError in requestOptions is not false.

closeUserConnectionsWithResponse

public com.azure.core.http.rest.Response<Void> closeUserConnectionsWithResponse(String userId,
                                                                                com.azure.core.http.rest.RequestOptions requestOptions)

Close connections for the specific user.

Query Parameters

Query Parameters

Name	Type	Required	Description
excluded	String	No	Exclude these connectionIds when closing the connections for the user.
reason	String	No	The reason closing the client connection.
apiVersion	String	Yes	Api Version

Parameters:

userId - The user Id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if status code is 400 or above, if throwOnError in requestOptions is not false.