Skip to content

Commit

Permalink
docs: Adding Samples for printing all Acls for a file and for a speci…
Browse files Browse the repository at this point in the history
…fic user
  • Loading branch information
sydney-munro committed Mar 4, 2022
1 parent f2aceb7 commit 31e4dd2
Show file tree
Hide file tree
Showing 4 changed files with 193 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.storage.object;

// [START storage_print_file_acl]

import com.google.cloud.storage.Acl;
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.util.List;

public class PrintFileAcl {

public static void printFileAcl(String bucketName, String blobName) {

// The ID to give your GCS bucket
// String bucketName = "your-unique-bucket-name";

// The name of the blob/file that you wish to view Acls of
// String blobName = "your-blob-name";

Storage storage = StorageOptions.newBuilder().build().getService();
Blob blob = storage.get(BlobId.of(bucketName, blobName));
List<Acl> blobAcls = blob.getAcl();

for (Acl acl : blobAcls) {

// This will give you the role.
// See https://cloud.google.com/storage/docs/access-control/lists#permissions
String role = acl.getRole().name();

// This will give you the Entity type (i.e. User, Group, Project etc.)
// See https://cloud.google.com/storage/docs/access-control/lists#scopes
String entityType = acl.getEntity().getType().name();

System.out.printf("%s: %s \n", role, entityType);
}
}

}
// [END storage_print_file_acl]
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.storage.object;

// [START storage_print_file_acl_for_user]

import com.google.cloud.storage.Acl;
import com.google.cloud.storage.Acl.User;
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;

public class PrintFileAclForUser {

public static void printFileAclForUser(String bucketName, String blobName, String userEmail) {

// The ID to give your GCS bucket
// String bucketName = "your-unique-bucket-name";

// The name of the blob/file that you wish to view Acls of
// String blobName = "your-blob-name";

// The email of the user whose acl is being retrieved.
// String userEmail = "someuser@domain.com"

Storage storage = StorageOptions.newBuilder().build().getService();
Blob blob = storage.get(BlobId.of(bucketName, blobName));
Acl blobAcl = blob.getAcl(new User(userEmail));
String userRole = blobAcl.getRole().name();

System.out.println("User " + userEmail + " has role " + userRole);
}
}
// [END storage_print_file_acl_for_user]
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.storage.object;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNotNull;

import com.example.storage.TestBase;
import com.google.cloud.storage.Acl;
import com.google.cloud.storage.Acl.Entity;
import com.google.cloud.storage.Acl.Role;
import com.google.cloud.storage.Acl.User;
import org.junit.Test;

public class PrintFileAclForUserTest extends TestBase {

public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");

@Test
public void testPrintBucketAclByUser() {
// Check for user email before the actual test.
assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);

Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
blob.createAcl(Acl.of(testUser, Role.READER));
PrintFileAclForUser.printFileAclForUser(bucketName, blobName, IT_SERVICE_ACCOUNT_EMAIL);
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL);
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(Role.READER.name());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.storage.object;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNotNull;

import com.example.storage.TestBase;
import com.google.cloud.storage.Acl;
import com.google.cloud.storage.Acl.Entity;
import com.google.cloud.storage.Acl.Role;
import com.google.cloud.storage.Acl.User;
import org.junit.Test;

public class PrintFileAclTest extends TestBase {

public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");

@Test
public void testPrintFileAcls() {
// Check for user email before the actual test.
assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);

Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
blob.createAcl(Acl.of(testUser, Role.READER));
PrintFileAcl.printFileAcl(bucketName, blobName);
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("READER: USER");
}
}

0 comments on commit 31e4dd2

Please sign in to comment.