AccountSasService Class

  • java.lang.Object
    • com.azure.storage.common.sas.AccountSasService

public final class AccountSasService

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

Constructor Summary

Constructor Description
AccountSasService()

Initializes an AccountSasService object with all fields set to false.

Method Summary

Modifier and Type Method and Description
boolean hasBlobAccess()
boolean hasFileAccess()
boolean hasQueueAccess()
boolean hasTableAccess()
static AccountSasService parse(String servicesString)

Creates an AccountSasService from the specified services string.

AccountSasService setBlobAccess(boolean blob)

Sets the access status for blob resources.

AccountSasService setFileAccess(boolean file)

Sets the access status for file resources.

AccountSasService setQueueAccess(boolean queue)

Sets the access status for queue resources.

AccountSasService setTableAccess(boolean table)

Sets the access status for table resources.

String toString()

Converts the given services to a String.

Methods inherited from java.lang.Object

Constructor Details

AccountSasService

public AccountSasService()

Initializes an AccountSasService object with all fields set to false.

Method Details

hasBlobAccess

public boolean hasBlobAccess()

Returns:

the access status for blob resources.

hasFileAccess

public boolean hasFileAccess()

Returns:

the access status for file resources.

hasQueueAccess

public boolean hasQueueAccess()

Returns:

the access status for queue resources.

hasTableAccess

public boolean hasTableAccess()

Returns:

the access status for table resources.

parse

public static AccountSasService parse(String servicesString)

Creates an AccountSasService from the specified services string. This method will throw an IllegalArgumentException if it encounters a character that does not correspond to a valid service.

Parameters:

servicesString - A String which represents the SharedAccessAccountServices.

Returns:

A AccountSasService generated from the given String.

setBlobAccess

public AccountSasService setBlobAccess(boolean blob)

Sets the access status for blob resources.

Parameters:

blob - Access status to set

Returns:

the updated AccountSasService object.

setFileAccess

public AccountSasService setFileAccess(boolean file)

Sets the access status for file resources.

Parameters:

file - Access status to set

Returns:

the updated AccountSasService object.

setQueueAccess

public AccountSasService setQueueAccess(boolean queue)

Sets the access status for queue resources.

Parameters:

queue - Access status to set

Returns:

the updated AccountSasService object.

setTableAccess

public AccountSasService setTableAccess(boolean table)

Sets the access status for table resources.

Parameters:

table - Access status to set

Returns:

the updated AccountSasService object.

toString

public String toString()

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

Overrides:

AccountSasService.toString()

Returns:

A String which represents the AccountSASServices.

Applies to