com.microsoft.azure.storage.file

Class SharedAccessFilePolicy

java.lang.Object

com.microsoft.azure.storage.SharedAccessPolicy

com.microsoft.azure.storage.file.SharedAccessFilePolicy

public final class SharedAccessFilePolicy
extends SharedAccessPolicy

Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature.

Constructor Summary

Constructors

Constructor and Description
SharedAccessFilePolicy()

Method Summary

Modifier and Type	Method and Description
EnumSet<SharedAccessFilePermissions>	getPermissions() Gets the permissions for a shared access signature associated with this shared access policy.
String	permissionsToString() Converts this policy's permissions to a string.
void	setPermissions(EnumSet<SharedAccessFilePermissions> permissions) Sets the permissions for a shared access signature associated with this shared access policy.
void	setPermissionsFromString(String value) Sets shared access permissions using the specified permissions string.

Methods inherited from class com.microsoft.azure.storage.SharedAccessPolicy

getSharedAccessExpiryTime, getSharedAccessStartTime, setSharedAccessExpiryTime, setSharedAccessStartTime

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedAccessFilePolicy

public SharedAccessFilePolicy()

Method Detail

getPermissions

public EnumSet<SharedAccessFilePermissions> getPermissions()

Gets the permissions for a shared access signature associated with this shared access policy.

Returns:

A java.util.EnumSet object that contains SharedAccessFilePermissions values that represents the set of shared access permissions.

setPermissions

public void setPermissions(EnumSet<SharedAccessFilePermissions> permissions)

Sets the permissions for a shared access signature associated with this shared access policy.

Parameters:

permissions - The permissions, represented by a java.util.EnumSet object that contains SharedAccessFilePermissions values, to set for the shared access signature.

permissionsToString

public String permissionsToString()

Converts this policy's permissions to a string.

Specified by:

permissionsToString in class SharedAccessPolicy

Returns:

A String that represents the shared access permissions in the "rcwdl" format, which is described at setPermissionsFromString(String).

setPermissionsFromString

public void setPermissionsFromString(String value)

Sets shared access permissions using the specified permissions string.

Specified by:

setPermissionsFromString in class SharedAccessPolicy

Parameters:

value - A String that represents the shared access permissions. The string must contain one or more of the following values. Note they must all be lowercase.

• r: Read access.
• c: Create access.
• w: Write access.
• d: Delete access.
• l: List access.