com.microsoft.azure.storage.blob.BlobSASPermission Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation
Show all versions of azure-storage-blob Show documentation
The Azure Storage Java Blob library.
/*
* Copyright Microsoft Corporation
*
* 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.microsoft.azure.storage.blob;
import java.util.Locale;
/**
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting
* a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
* the values are set, this should be serialized with toString and set as the permissions field on a
* {@link ServiceSASSignatureValues} object. It is possible to construct the permissions string without this class, but
* the order of the permissions is particular and this class guarantees correctness.
*/
public final class BlobSASPermission {
/**
* Specifies Read access granted.
*/
public boolean read;
/**
* Specifies Add access granted.
*/
public boolean add;
/**
* Specifies Create access granted.
*/
public boolean create;
/**
* Specifies Write access granted.
*/
public boolean write;
/**
* Specifies Delete access granted.
*/
public boolean delete;
/**
* Initializes a {@code BlobSASPermission} object with all fields set to false.
*/
public BlobSASPermission() {}
/**
* Converts the given permissions to a {@code String}. Using this method will guarantee the permissions are in an
* order accepted by the service.
*
* @return
* A {@code String} which represents the {@code BlobSASPermission}.
*/
@Override
public String toString() {
// The order of the characters should be as specified here to ensure correctness:
// https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
final StringBuilder builder = new StringBuilder();
if (this.read) {
builder.append('r');
}
if (this.add) {
builder.append('a');
}
if (this.create) {
builder.append('c');
}
if (this.write) {
builder.append('w');
}
if (this.delete) {
builder.append('d');
}
return builder.toString();
}
/**
* Creates a {@code BlobSASPermission} from the specified permissions string. This method will throw an
* {@code IllegalArgumentException} if it encounters a character that does not correspond to a valid permission.
*
* @param permString
* A {@code String} which represents the {@code BlobSASPermission}.
* @return
* A {@code BlobSASPermission} generated from the given {@code String}.
*/
public static BlobSASPermission parse(String permString) {
BlobSASPermission permissions = new BlobSASPermission();
for (int i=0; i