Recursive acl

sdk/storage/azure-storage-file-datalake/CHANGELOG.md

@@ -1,7 +1,8 @@
 # Release History
 
 ## 12.3.0-beta.1 (Unreleased)
-- Added support for the 2019-02-10 service version.
+- Added support for the 2020-02-10 service version.
+- Added support for setting, modifying, and removing ACLs recursively.
 - Added support to schedule file expiration. 
 - Added support to specify Arrow Output Serialization when querying a file. 
 - Added support to generate directory SAS and added support to specify additional user ids and correlation ids for user delegation SAS.

sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakePathClient.java

@@ -17,16 +17,22 @@
 import com.azure.storage.file.datalake.implementation.models.LeaseAccessConditions;
 import com.azure.storage.file.datalake.implementation.models.ModifiedAccessConditions;
 import com.azure.storage.file.datalake.implementation.models.PathRenameMode;
+import com.azure.storage.file.datalake.implementation.models.PathSetAccessControlRecursiveMode;
 import com.azure.storage.file.datalake.implementation.models.SourceModifiedAccessConditions;
 import com.azure.storage.file.datalake.implementation.util.DataLakeImplUtils;
+import com.azure.storage.file.datalake.models.AccessControlChangeResult;
 import com.azure.storage.file.datalake.models.DataLakeRequestConditions;
 import com.azure.storage.file.datalake.models.PathAccessControl;
 import com.azure.storage.file.datalake.models.PathAccessControlEntry;
 import com.azure.storage.file.datalake.models.PathHttpHeaders;
 import com.azure.storage.file.datalake.models.PathInfo;
 import com.azure.storage.file.datalake.models.PathPermissions;
 import com.azure.storage.file.datalake.models.PathProperties;
+import com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry;
 import com.azure.storage.file.datalake.models.UserDelegationKey;
+import com.azure.storage.file.datalake.options.PathRemoveAccessControlRecursiveOptions;
+import com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions;
+import com.azure.storage.file.datalake.options.PathUpdateAccessControlRecursiveOptions;
 import com.azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues;
 import reactor.core.publisher.Mono;
 
@@ -354,6 +360,140 @@ public Response<PathInfo> setPermissionsWithResponse(PathPermissions permissions
         return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
     }
 
+    /**
+     * Recursively sets the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.setAccessControlRecursive#List}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param accessControlList The POSIX access control list for the file or directory.
+     * @return The result of the operation.
+     */
+    public AccessControlChangeResult setAccessControlRecursive(List<PathAccessControlEntry> accessControlList) {
+        return setAccessControlRecursiveWithResponse(new PathSetAccessControlRecursiveOptions(accessControlList), null,
+            Context.NONE).getValue();
+    }
+
+    /**
+     * Recursively sets the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.setAccessControlRecursiveWithResponse#PathSetAccessControlRecursiveOptions-Duration-Context}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param options {@link PathSetAccessControlRecursiveOptions}
+     * @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
+     * @param context Additional context that is passed through the Http pipeline during the service call.
+     * @return A response containing the result of the operation.
+     */
+    public Response<AccessControlChangeResult> setAccessControlRecursiveWithResponse(
+        PathSetAccessControlRecursiveOptions options, Duration timeout, Context context) {
+        Mono<Response<AccessControlChangeResult>> response =
+            dataLakePathAsyncClient.setAccessControlRecursiveWithResponse(
+                PathAccessControlEntry.serializeList(options.getAccessControlList()), options.getProgressHandler(),
+                PathSetAccessControlRecursiveMode.SET, options.getBatchSize(), options.getMaxBatches(),
+                options.isContinuingOnFailure(), options.getContinuationToken(), context);
+
+        return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
+    }
+
+    /**
+     * Recursively updates the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.updateAccessControlRecursive#List}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param accessControlList The POSIX access control list for the file or directory.
+     * @return The result of the operation.
+     */
+    public AccessControlChangeResult updateAccessControlRecursive(List<PathAccessControlEntry> accessControlList) {
+        return updateAccessControlRecursiveWithResponse(new PathUpdateAccessControlRecursiveOptions(accessControlList),
+            null, Context.NONE).getValue();
+    }
+
+    /**
+     * Recursively updates the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.updateAccessControlRecursiveWithResponse#PathUpdateAccessControlRecursiveOptions-Duration-Context}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param options {@link PathUpdateAccessControlRecursiveOptions}
+     * @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
+     * @param context Additional context that is passed through the Http pipeline during the service call.
+     * @return A response containing the result of the operation.
+     */
+    public Response<AccessControlChangeResult> updateAccessControlRecursiveWithResponse(
+        PathUpdateAccessControlRecursiveOptions options, Duration timeout, Context context) {
+        Mono<Response<AccessControlChangeResult>> response =
+            dataLakePathAsyncClient.setAccessControlRecursiveWithResponse(
+                PathAccessControlEntry.serializeList(options.getAccessControlList()), options.getProgressHandler(),
+                PathSetAccessControlRecursiveMode.MODIFY, options.getBatchSize(), options.getMaxBatches(),
+                options.isContinuingOnFailure(), options.getContinuationToken(), context);
+
+        return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
+    }
+
+    /**
+     * Recursively removes the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.removeAccessControlRecursive#List}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param accessControlList The POSIX access control list for the file or directory.
+     * @return The result of the operation.
+     */
+    public AccessControlChangeResult removeAccessControlRecursive(
+        List<PathRemoveAccessControlEntry> accessControlList) {
+        return removeAccessControlRecursiveWithResponse(new PathRemoveAccessControlRecursiveOptions(accessControlList),
+            null, Context.NONE).getValue();
+    }
+
+    /**
+     * Recursively removes the access control on a path and all subpaths.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.removeAccessControlRecursiveWithResponse#PathRemoveAccessControlRecursiveOptions-Duration-Context}
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update">Azure Docs</a></p>
+     *
+     * @param options {@link PathRemoveAccessControlRecursiveOptions}
+     * @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
+     * @param context Additional context that is passed through the Http pipeline during the service call.
+     * @return A  response containing the result of the operation.
+     */
+    public Response<AccessControlChangeResult> removeAccessControlRecursiveWithResponse(
+        PathRemoveAccessControlRecursiveOptions options, Duration timeout, Context context) {
+        Mono<Response<AccessControlChangeResult>> response =
+            dataLakePathAsyncClient.setAccessControlRecursiveWithResponse(
+                PathRemoveAccessControlEntry.serializeList(options.getAccessControlList()),
+                options.getProgressHandler(), PathSetAccessControlRecursiveMode.REMOVE, options.getBatchSize(),
+                options.getMaxBatches(), options.isContinuingOnFailure(), options.getContinuationToken(), context);
+
+        return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
+    }
+
+
     /**
      * Returns the access control for a resource.
      *
@@ -456,7 +596,7 @@ public Boolean exists() {
      * <p>Note that this method does not guarantee that the path type (file/directory) matches expectations.</p>
      * <p>For example, a DataLakeFileClient representing a path to a datalake directory will return true, and vice
      * versa.</p>
-     * 
+     *
      * <p><strong>Code Samples</strong></p>
      *
      * {@codesnippet com.azure.storage.file.datalake.DataLakePathClient.existsWithResponse#Duration-Context}

sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/implementation/PathsImpl.java

@@ -123,7 +123,7 @@ private interface PathsService {
         @Patch("{filesystem}/{path}")
         @ExpectedResponses({200})
         @UnexpectedResponseExceptionType(DataLakeStorageException.class)
-        Mono<PathsSetAccessControlRecursiveResponse> setAccessControlRecursive(@HostParam("url") String url, @QueryParam("timeout") Integer timeout, @QueryParam("continuation") String continuation, @QueryParam("mode") PathSetAccessControlRecursiveMode mode, @QueryParam("forceFlag") Boolean forceFlag, @QueryParam("maxRecords") Integer maxRecords, @HeaderParam("x-ms-acl") String acl, @HeaderParam("x-ms-client-request-id") String requestId, @HeaderParam("x-ms-version") String version, @QueryParam("action") String action, Context context);
+        Mono<PathsSetAccessControlRecursiveResponse> setAccessControlRecursive(@PathParam("filesystem") String fileSystem, @PathParam("path") String path1, @HostParam("url") String url, @QueryParam("timeout") Integer timeout, @QueryParam("continuation") String continuation, @QueryParam("mode") PathSetAccessControlRecursiveMode mode, @QueryParam("forceFlag") Boolean forceFlag, @QueryParam("maxRecords") Integer maxRecords, @HeaderParam("x-ms-acl") String acl, @HeaderParam("x-ms-client-request-id") String requestId, @HeaderParam("x-ms-version") String version, @QueryParam("action") String action, Context context);
 
         @Patch("{filesystem}/{path}")
         @ExpectedResponses({200})
@@ -726,7 +726,7 @@ public Mono<PathsSetAccessControlRecursiveResponse> setAccessControlRecursiveWit
         final String acl = null;
         final String requestId = null;
         final String action = "setAccessControlRecursive";
-        return service.setAccessControlRecursive(this.client.getUrl(), timeout, continuation, mode, forceFlag, maxRecords, acl, requestId, this.client.getVersion(), action, context);
+        return service.setAccessControlRecursive(this.client.getFileSystem(), this.client.getPath1(), this.client.getUrl(), timeout, continuation, mode, forceFlag, maxRecords, acl, requestId, this.client.getVersion(), action, context);
     }
 
     /**
@@ -746,7 +746,7 @@ public Mono<PathsSetAccessControlRecursiveResponse> setAccessControlRecursiveWit
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<PathsSetAccessControlRecursiveResponse> setAccessControlRecursiveWithRestResponseAsync(PathSetAccessControlRecursiveMode mode, Integer timeout, String continuation, Boolean forceFlag, Integer maxRecords, String acl, String requestId, Context context) {
         final String action = "setAccessControlRecursive";
-        return service.setAccessControlRecursive(this.client.getUrl(), timeout, continuation, mode, forceFlag, maxRecords, acl, requestId, this.client.getVersion(), action, context);
+        return service.setAccessControlRecursive(this.client.getFileSystem(), this.client.getPath1(), this.client.getUrl(), timeout, continuation, mode, forceFlag, maxRecords, acl, requestId, this.client.getVersion(), action, context);
     }
 
     /**

sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/implementation/models/AppendMode.java

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.storage.file.datalake.implementation.models;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Defines values for AppendMode.
+ */
+public enum AppendMode {
+    /**
+     * Enum value autoCreate.
+     */
+    AUTO_CREATE("autoCreate");
+
+    /**
+     * The actual serialized value for a AppendMode instance.
+     */
+    private final String value;
+
+    AppendMode(String value) {
+        this.value = value;
+    }
+
+    /**
+     * Parses a serialized value to a AppendMode instance.
+     *
+     * @param value the serialized value to parse.
+     * @return the parsed AppendMode object, or null if unable to parse.
+     */
+    @JsonCreator
+    public static AppendMode fromString(String value) {
+        AppendMode[] items = AppendMode.values();
+        for (AppendMode item : items) {
+            if (item.toString().equalsIgnoreCase(value)) {
+                return item;
+            }
+        }
+        return null;
+    }
+
+    @JsonValue
+    @Override
+    public String toString() {
+        return this.value;
+    }
+}

sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/implementation/models/BlobType.java

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.storage.file.datalake.implementation.models;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Defines values for BlobType.
+ */
+public enum BlobType {
+    /**
+     * Enum value appendblob.
+     */
+    APPENDBLOB("appendblob");
+
+    /**
+     * The actual serialized value for a BlobType instance.
+     */
+    private final String value;
+
+    BlobType(String value) {
+        this.value = value;
+    }
+
+    /**
+     * Parses a serialized value to a BlobType instance.
+     *
+     * @param value the serialized value to parse.
+     * @return the parsed BlobType object, or null if unable to parse.
+     */
+    @JsonCreator
+    public static BlobType fromString(String value) {
+        BlobType[] items = BlobType.values();
+        for (BlobType item : items) {
+            if (item.toString().equalsIgnoreCase(value)) {
+                return item;
+            }
+        }
+        return null;
+    }
+
+    @JsonValue
+    @Override
+    public String toString() {
+        return this.value;
+    }
+}