com.microsoft.azure.datalake.store.acl

Class AclEntry

java.lang.Object

com.microsoft.azure.datalake.store.acl.AclEntry

public class AclEntry
extends Object

Contains one ACL entry. An ACL entry consists of a scope (access or default), the type of the ACL (user, group, other or mask), the name of the user or group associated with this ACL (can be blank to specify the default permissions for users and groups, and must be blank for mask entries), and the action permitted by this ACL entry.

An ACL for an object consists of a List of Acl entries.

This class also provides a number of convenience methods for converting ACL entries and ACLs to and back from strings.

Field Summary

Fields

Modifier and Type	Field and Description
AclAction	action AclAction enum specifying the action permitted by this Acl entry.
String	name String specifying the name of the user or group associated with this Acl entry.
AclScope	scope AclScope specifying scope of the Acl entry (access or default)
AclType	type AclType specifying the type of the Acl entry (user, group, other or mask)

Constructor Summary

Constructors

Constructor and Description
AclEntry()
AclEntry(AclScope scope, AclType type, String name, AclAction action) creates and Acl Entry from the supplied scope, type, name and action

Method Summary

Modifier and Type	Method and Description
static String	aclListToString(List<AclEntry> list) converts a List<AclEntry> to its posix aclspec string form
static String	aclListToString(List<AclEntry> list, boolean removeAcl) converts a List<AclEntry> to its posix aclspec string form.
static AclEntry	parseAclEntry(String entryString) Parses an Acl entry from its posix string form.
static AclEntry	parseAclEntry(String entryString, boolean removeAcl) Parses a single Acl entry from its posix string form.
static List<AclEntry>	parseAclSpec(String aclString) parses a posix acl spec string into a List of AclEntrys.
String	toString() Returns the posix string form of this acl entry.
String	toString(boolean removeAcl) Returns the posix string form of this acl entry.

Methods inherited from class java.lang.Object

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

Field Detail

scope

public AclScope scope

AclScope specifying scope of the Acl entry (access or default)

type

public AclType type

AclType specifying the type of the Acl entry (user, group, other or mask)

name

public String name

String specifying the name of the user or group associated with this Acl entry. Can be blank to specify the default permissions for users and groups, and must be blank for mask entries.

action

public AclAction action

AclAction enum specifying the action permitted by this Acl entry. Has convenience methods to create value from unix-style permission string (e.g., AclAction.fromRwx("rw-")), or from unix Octal permission (e.g., AclAction.fromOctal(6)).

Constructor Detail

AclEntry

public AclEntry()

AclEntry

public AclEntry(AclScope scope,
                AclType type,
                String name,
                AclAction action)

creates and Acl Entry from the supplied scope, type, name and action

Parameters:

scope - AclScope specifying scope of the Acl entry (access or default)

type - AclType specifying the type of the Acl entry (user, group, other or mask)

name - String specifying the name of the user or group associated with this Acl entry

action - AclAction specifying the action permitted by this Acl entry

Method Detail

parseAclEntry

public static AclEntry parseAclEntry(String entryString)
                              throws IllegalArgumentException

Parses an Acl entry from its posix string form. For example: "default:user:bob:r-x"

Parameters:

entryString - Acl entry string to parse

Returns:

AclEntry parsed from the string

Throws:

IllegalArgumentException - if the string is invalid

parseAclEntry

public static AclEntry parseAclEntry(String entryString,
                                     boolean removeAcl)
                              throws IllegalArgumentException

Parses a single Acl entry from its posix string form. For example: "default:user:bob:r-x".

If the Acl string will be used to remove an existing acl from a file or folder, then the permission level does not need to be specified. Passing false to the removeAcl argument tells the parser to accept such strings.

Parameters:

entryString - Acl entry string to parse

removeAcl - boolean specifying whether to parse this string like a remove Acl (that is, with permission optional)

Returns:

AclEntry parsed from the string

Throws:

IllegalArgumentException - if the string is invalid

toString

public String toString()

Returns the posix string form of this acl entry. For example: "default:user:bob:r-x".

Overrides:

toString in class Object

Returns:

the posix string form of this acl entry

toString

public String toString(boolean removeAcl)

Returns the posix string form of this acl entry. For example: "default:user:bob:r-x".

If the Acl string will be used to remove an existing acl from a file or folder, then the permission level does not need to be specified. Passing true to the removeAcl argument omits the permission level in the output string.

Parameters:

removeAcl - passing true will result in an acl entry string with no permission specified

Returns:

the string form of the AclEntry

parseAclSpec

public static List<AclEntry> parseAclSpec(String aclString)
                                   throws IllegalArgumentException

parses a posix acl spec string into a List of AclEntrys.

Parameters:

aclString - the acl spec string tp parse

Returns:

List<AclEntry> represented by the acl spec string

Throws:

IllegalArgumentException

aclListToString

public static String aclListToString(List<AclEntry> list)

converts a List<AclEntry> to its posix aclspec string form

Parameters:

list - List<AclEntry> to covert to string

Returns:

posix acl spec string

aclListToString

public static String aclListToString(List<AclEntry> list,
                                     boolean removeAcl)

converts a List<AclEntry> to its posix aclspec string form.

If the aclspec string will be used to remove an existing acl from a file or folder, then the permission level does not need to be specified. Passing true to the removeAcl argument omits the permission level in the output string.

Parameters:

list - List<AclEntry> to covert to string

removeAcl - removeAcl passing true will result in an aclspec with no permission specified

Returns:

posix acl spec string