Package org.azd.security.accesscontrollists

Class AccessControlListsRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.security.accesscontrollists.AccessControlListsRequestBuilder
public class AccessControlListsRequestBuilder extends BaseRequestBuilder
Provides functionality to work with Security Access control lists Api.

  • Constructor Details

    • AccessControlListsRequestBuilder

      public AccessControlListsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • queryAsync

      public CompletableFuture<ACLs> queryAsync(String securityNamespaceId, Consumer<AccessControlListsRequestBuilder.QueryRequestConfiguration> requestConfiguration) throws AzDException
      Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Returns:
      Collection of Access control lists ACLs
      Throws:
      AzDException - Default Api exception handler.

    • removeAsync

      public CompletableFuture<Boolean> removeAsync(String securityNamespaceId, Consumer<AccessControlListsRequestBuilder.DeleteRequestConfiguration> requestConfiguration) throws AzDException
      Remove access control lists under the specified security namespace.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Throws:
      AzDException - Default Api Exception handler.

    • setAsync

      public CompletableFuture<Void> setAsync(String securityNamespaceId, ACLs setAccessControlListsRequest) throws AzDException
      Create or update one or more access control lists. All data that currently exists for the ACLs supplied will be overwritten.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      setAccessControlListsRequest - Request body to add or update the access control lists.
      Throws:
      AzDException - Default Api Exception handler.

    • query

      public ACLs query(String securityNamespaceId, Consumer<AccessControlListsRequestBuilder.QueryRequestConfiguration> requestConfiguration) throws AzDException
      Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Returns:
      Collection of Access control lists ACLs
      Throws:
      AzDException - Default Api exception handler.

    • remove

      public Boolean remove(String securityNamespaceId, Consumer<AccessControlListsRequestBuilder.DeleteRequestConfiguration> requestConfiguration) throws AzDException
      Remove access control lists under the specified security namespace.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Throws:
      AzDException - Default Api Exception handler.

    • set

      public Void set(String securityNamespaceId, ACLs setAccessControlListsRequest) throws AzDException
      Create or update one or more access control lists. All data that currently exists for the ACLs supplied will be overwritten.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      setAccessControlListsRequest - Request body to add or update the access control lists.
      Throws:
      AzDException - Default Api Exception handler.