com.microsoft.azure.storage.blob

Class AccountSASResourceType

java.lang.Object

com.microsoft.azure.storage.blob.AccountSASResourceType

public final class AccountSASResourceType
extends Object

This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an AccountSASSignatureValues object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness.

Constructor Summary

Constructors

Constructor and Description
AccountSASResourceType() Initializes an AccountSASResourceType object with all fields set to false.

Method Summary

Modifier and Type	Method and Description
boolean	container() Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
boolean	object() Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
static AccountSASResourceType	parse(String resourceTypesString) Creates an AccountSASResourceType from the specified resource types string.
boolean	service() Permission to access service level APIs granted.
String	toString() Converts the given resource types to a String.
AccountSASResourceType	withContainer(boolean container) Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
AccountSASResourceType	withObject(boolean object) Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
AccountSASResourceType	withService(boolean service) Permission to access service level APIs granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountSASResourceType

public AccountSASResourceType()

Initializes an AccountSASResourceType object with all fields set to false.

Method Detail

service

public boolean service()

Permission to access service level APIs granted.

withService

public AccountSASResourceType withService(boolean service)

Permission to access service level APIs granted.

container

public boolean container()

Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.

withContainer

public AccountSASResourceType withContainer(boolean container)

Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.

object

public boolean object()

Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.

withObject

public AccountSASResourceType withObject(boolean object)

Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.

toString

public String toString()

Converts the given resource types to a String. Using this method will guarantee the resource types are in an order accepted by the service.

Overrides:

toString in class Object

Returns:

A String which represents the AccountSASResourceTypes.

parse

public static AccountSASResourceType parse(String resourceTypesString)

Creates an AccountSASResourceType from the specified resource types string. This method will throw an IllegalArgumentException if it encounters a character that does not correspond to a valid resource type.

Parameters:

resourceTypesString - A String which represents the AccountSASResourceTypes.

Returns:

A AccountSASResourceType generated from the given String.