Share via

SharedAccessFilePolicy Class

  • Reference
Package:
com.microsoft.azure.storage.file
  • java.lang.Object

public class SharedAccessFilePolicy extends SharedAccessPolicy

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

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(final EnumSet<SharedAccessFilePermissions> permissions)

Sets the permissions for a shared access signature associated with this shared access policy.
void setPermissionsFromString(final String value)

Sets shared access permissions using the specified permissions string.

Inherited Members

SharedAccessPolicy.getSharedAccessExpiryTime() SharedAccessPolicy.getSharedAccessStartTime() SharedAccessPolicy.setSharedAccessExpiryTime(final Date sharedAccessExpiryTime) SharedAccessPolicy.setSharedAccessStartTime(final Date sharedAccessStartTime) SharedAccessPolicy.SharedAccessPolicy()

Method Details

getPermissions

public EnumSet 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.

permissionsToString

public String permissionsToString()

Converts this policy's permissions to a string.

Returns:

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

setPermissions

public void setPermissions(final EnumSet 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.

setPermissionsFromString

public void setPermissionsFromString(final String value)

Sets shared access permissions using the specified permissions string.

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.

Applies to