com.microsoft.azure.datalake.store

Class Core

java.lang.Object

com.microsoft.azure.datalake.store.Core

public class Core
extends Object

protocol.Core class implements the calls for the RESP API. There is one method in Core for every REST API supported by the server.

The methods in this class tend to be lower-level, exposing all the details of the underlying operation. To call the methods, instantiate a RequestOptions object first. Assign any of the member values as needed (e.g., the RetryPolicy). Then create a new OperationResponse object. The OperationResponse is used for passing the call results and stats back from the call.

Failures originating in Core methods are communicated back through the OperationResponse parameter.

Thread Safety: all static methods in this class are thread-safe

Method Summary

Modifier and Type	Method and Description
static void	append(String path, long offsetToAppendTo, byte[] contents, int offsetWithinContentsArray, int length, String leaseId, String sessionId, SyncFlag syncFlag, ADLStoreClient client, RequestOptions opts, OperationResponse resp) append bytes to an existing file created with create(String, boolean, String, byte[], int, int, String, String, boolean, SyncFlag, ADLStoreClient, RequestOptions, OperationResponse) (String, boolean, String, byte[], int, int, String, String, boolean, boolean, ADLStoreClient, RequestOptions, OperationResponse) create}.
static void	checkAccess(String path, String rwx, ADLStoreClient client, RequestOptions opts, OperationResponse resp) checks whether the calling user has the required permissions for the file.
static void	concat(String path, List<String> sources, ADLStoreClient client, boolean deleteSourceDirectory, RequestOptions opts, OperationResponse resp) Concatenate the specified list of files into the target filename.
static void	concat(String path, List<String> sources, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Concatenate the specified list of files into the target filename.
static void	concurrentAppend(String path, byte[] contents, int offsetWithinContentsArray, int length, boolean autoCreate, ADLStoreClient client, RequestOptions opts, OperationResponse resp) append bytes to a file.
static void	create(String path, boolean overwrite, String octalPermission, byte[] contents, int offsetWithinContentsArray, int length, String leaseId, String sessionId, boolean createParent, SyncFlag syncFlag, ADLStoreClient client, RequestOptions opts, OperationResponse resp) create a file and write to it.
static boolean	delete(String path, boolean recursive, ADLStoreClient client, RequestOptions opts, OperationResponse resp) delete a file or directory from Azure Data Lake.
static AclStatus	getAclStatus(String path, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Gets the current ACLs and permissions associated with a file or directory.
static AclStatus	getAclStatus(String path, UserGroupRepresentation oidOrUpn, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Gets the current ACLs and permissions associated with a file or directory.
static ContentSummary	getContentSummary(String path, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Gets the content summary of a file or directory.
static DirectoryEntry	getFileStatus(String path, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Gets the directory metadata associated with a file or directory.
static DirectoryEntry	getFileStatus(String path, UserGroupRepresentation oidOrUpn, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Gets the directory metadata associated with a file or directory.
static boolean	isValidOctal(String input)
static List<DirectoryEntry>	listStatus(String path, String listAfter, String listBefore, int listSize, ADLStoreClient client, RequestOptions opts, OperationResponse resp) enumerates the contents of a direcotry, returning a List of DirectoryEntry objects, one per file or directory in the specified directory.
static List<DirectoryEntry>	listStatus(String path, String listAfter, String listBefore, int listSize, UserGroupRepresentation oidOrUpn, ADLStoreClient client, RequestOptions opts, OperationResponse resp) enumerates the contents of a direcotry, returning a List of DirectoryEntry objects, one per file or directory in the specified directory.
static boolean	mkdirs(String path, String octalPermission, ADLStoreClient client, RequestOptions opts, OperationResponse resp) creates a directory, and all it's parent directories if they dont exist.
static void	modifyAclEntries(String path, List<AclEntry> aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Modify the acl entries for a file or directory.
static void	modifyAclEntries(String path, String aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Modify the acl entries for a file or directory.
static InputStream	open(String path, long offset, long length, String sessionId, ADLStoreClient client, RequestOptions opts, OperationResponse resp) read from a file.
static InputStream	open(String path, long offset, long length, String sessionId, boolean speculativeRead, ADLStoreClient client, RequestOptions opts, OperationResponse resp) read from a file.
static void	removeAcl(String path, ADLStoreClient client, RequestOptions opts, OperationResponse resp) removes all acl entries from a file or directory.
static void	removeAclEntries(String path, List<AclEntry> aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Removes the specified ACL entries from a file or directory.
static void	removeAclEntries(String path, String aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Removes the specified ACL entries from a file or directory.
static void	removeDefaultAcl(String path, ADLStoreClient client, RequestOptions opts, OperationResponse resp) removes all default acl entries from a directory.
static boolean	rename(String path, String destination, boolean overwrite, ADLStoreClient client, RequestOptions opts, OperationResponse resp) rename a file.
static void	setAcl(String path, List<AclEntry> aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Sets the ACLs for a file or directory.
static void	setAcl(String path, String aclSpec, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Sets the ACLs for a file or directory.
static void	setExpiryTime(String path, ExpiryOption expiryOption, long milliseconds, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Sets the expiry time on a file.
static void	setOwner(String path, String user, String group, ADLStoreClient client, RequestOptions opts, OperationResponse resp) sets the owning user and group of the file.
static void	setPermission(String path, String octalPermissions, ADLStoreClient client, RequestOptions opts, OperationResponse resp) Sets the permissions of the specified file ro directory.
static void	setTimes(String path, long atime, long mtime, ADLStoreClient client, RequestOptions opts, OperationResponse resp) sets one or both of the times (Modified and Access time) of the file or directory

Methods inherited from class java.lang.Object

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

Method Detail

create

public static void create(String path,
                          boolean overwrite,
                          String octalPermission,
                          byte[] contents,
                          int offsetWithinContentsArray,
                          int length,
                          String leaseId,
                          String sessionId,
                          boolean createParent,
                          SyncFlag syncFlag,
                          ADLStoreClient client,
                          RequestOptions opts,
                          OperationResponse resp)

create a file and write to it.

Parameters:

path - the full path of the file to create

overwrite - whether to overwrite the file if it already exists

octalPermission - permissions for the file, as octal digits (For Example, "755"). Can be null.

contents - byte array containing the contents to be written to the file. Can be null

offsetWithinContentsArray - offset within the byte array passed in contents. Bytes starting at this offset will be written to server

length - number of bytes from contents to be written

leaseId - a String containing the lease ID (generated by client). Can be null.

sessionId - a String containing the session ID (generated by client). Can be null.

createParent - if true, then parent directories of the file are created if they are missing.

syncFlag - Use SyncFlag.DATA when writing more bytes to same file path. Most performant operation. Use SyncFlag.METADATA when metadata for the file also needs to be updated especially file length retrieved from getFileStatus(String, ADLStoreClient, RequestOptions, OperationResponse) or listStatus(String, String, String, int, ADLStoreClient, RequestOptions, OperationResponse) API call. Has an overhead of updating metadata operation. Use SyncFlag.CLOSE when no more data is expected to be written in this path. Adl backend would update metadata, close the stream handle and release the lease on the path if valid leaseId is passed. Expensive operation and should be used only when last bytes are written.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

append

public static void append(String path,
                          long offsetToAppendTo,
                          byte[] contents,
                          int offsetWithinContentsArray,
                          int length,
                          String leaseId,
                          String sessionId,
                          SyncFlag syncFlag,
                          ADLStoreClient client,
                          RequestOptions opts,
                          OperationResponse resp)

append bytes to an existing file created with create(String, boolean, String, byte[], int, int, String, String, boolean, SyncFlag, ADLStoreClient, RequestOptions, OperationResponse) (String, boolean, String, byte[], int, int, String, String, boolean, boolean, ADLStoreClient, RequestOptions, OperationResponse) create}.

Parameters:

path - the full path of the file to append to. The file must already exist.

offsetToAppendTo - offset at which to append to to file. To let the server choose offset, pass -1.

contents - byte array containing the contents to be written to the file. Can be null

offsetWithinContentsArray - offset within the byte array passed in contents. Bytes starting at this offset will be written to server

length - number of bytes from contents to be written

leaseId - a String containing the lease ID (generated by client). Can be null.

sessionId - a String containing the session ID (generated by client). Can be null.

syncFlag - Use SyncFlag.DATA when writing more bytes to same file path. Most performant operation. Use SyncFlag.METADATA when metadata for the file also needs to be updated especially file length retrieved from getFileStatus(String, ADLStoreClient, RequestOptions, OperationResponse) or listStatus(String, String, String, int, ADLStoreClient, RequestOptions, OperationResponse) API call. Has an overhead of updating metadata operation. Use SyncFlag.CLOSE when no more data is expected to be written in this path. Adl backend would update metadata, close the stream handle and release the lease on the path if valid leaseId is passed. Expensive operation and should be used only when last bytes are written.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

concurrentAppend

public static void concurrentAppend(String path,
                                    byte[] contents,
                                    int offsetWithinContentsArray,
                                    int length,
                                    boolean autoCreate,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

append bytes to a file. The offset is determined by the server. This enables multiple writers to append concurrently to the same file. A file created with concurrentAppend can only be appended with concurrentAppend.

Parameters:

path - the full path of the file to append to.

contents - byte array containing the contents to be written to the file. Can be null

offsetWithinContentsArray - offset within the byte array passed in contents. Bytes starting at this offset will be written to server

length - number of bytes from contents to be written

autoCreate - boolean specifying whether to create the file if it doesn't already exist

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

open

public static InputStream open(String path,
                               long offset,
                               long length,
                               String sessionId,
                               ADLStoreClient client,
                               RequestOptions opts,
                               OperationResponse resp)

read from a file. This is the stateless read method, that reads bytes from an offset in a file.

Parameters:

path - the full path of the file to read. The file must already exist.

offset - the offset within the ADL file to read from

length - the number of bytes to read from file

sessionId - a String containing the session ID (generated by client). Can be null.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

returns an ADLFileInputStream

open

public static InputStream open(String path,
                               long offset,
                               long length,
                               String sessionId,
                               boolean speculativeRead,
                               ADLStoreClient client,
                               RequestOptions opts,
                               OperationResponse resp)

read from a file. This is the stateless read method, that reads bytes from an offset in a file.

Parameters:

path - the full path of the file to read. The file must already exist.

offset - the offset within the ADL file to read from

length - the number of bytes to read from file

sessionId - a String containing the session ID (generated by client). Can be null.

speculativeRead - indicates if the read is speculative. Currently fails the read - so dont use.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

returns an ADLFileInputStream

delete

public static boolean delete(String path,
                             boolean recursive,
                             ADLStoreClient client,
                             RequestOptions opts,
                             OperationResponse resp)

delete a file or directory from Azure Data Lake.

Parameters:

path - the full path of the file to delete. The file must already exist.

recursive - if deleting a directory, then whether to delete all files an directories in the directory hierarchy underneath

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

returns true if the delete was successful. Also check resp.successful.

rename

public static boolean rename(String path,
                             String destination,
                             boolean overwrite,
                             ADLStoreClient client,
                             RequestOptions opts,
                             OperationResponse resp)

rename a file.

Parameters:

path - the full path of the existing file to rename. (the old name)

overwrite - overwrite the destination if it already exists and is a file or an empty directory

destination - the new name of the file

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

returns true if the rename was successful. Also check resp.successful.

mkdirs

public static boolean mkdirs(String path,
                             String octalPermission,
                             ADLStoreClient client,
                             RequestOptions opts,
                             OperationResponse resp)

creates a directory, and all it's parent directories if they dont exist.

Parameters:

path - the full path of the directory to create. Any missing parents in the path will also be created.

octalPermission - permissions for the directory, as octal digits (For Example, "755"). Can be null.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

returns true if the create was successful. Also check resp.successful.

setExpiryTime

public static void setExpiryTime(String path,
                                 ExpiryOption expiryOption,
                                 long milliseconds,
                                 ADLStoreClient client,
                                 RequestOptions opts,
                                 OperationResponse resp)

Sets the expiry time on a file.

Parameters:

path - path of the file to set expiry on

expiryOption - ExpiryOption value specifying how to interpret the passed in time

milliseconds - time duration in milliseconds

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

getContentSummary

public static ContentSummary getContentSummary(String path,
                                               ADLStoreClient client,
                                               RequestOptions opts,
                                               OperationResponse resp)

Gets the content summary of a file or directory.

Parameters:

path - path of the file or directory to query

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

ContentSummary containing summary of information about the file or directory

concat

public static void concat(String path,
                          List<String> sources,
                          ADLStoreClient client,
                          RequestOptions opts,
                          OperationResponse resp)

Concatenate the specified list of files into the target filename. The target should not exist. the source files will be deleted if the concatenate succeeds.

Parameters:

path - that full path of the target file to create

sources - List of strings containing full pathnames of the files to concatenate. Cannot be null or empty.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

concat

public static void concat(String path,
                          List<String> sources,
                          ADLStoreClient client,
                          boolean deleteSourceDirectory,
                          RequestOptions opts,
                          OperationResponse resp)

Concatenate the specified list of files into the target filename. The target should not exist. the source files will be deleted if the concatenate succeeds.

Parameters:

path - that full path of the target file to create

sources - List of strings containing full pathnames of the files to concatenate. Cannot be null or empty.

deleteSourceDirectory - specify whether the directory containing the source files should be deleted. If source files specified in concat include all the files in the directory, then specifying this parameter makes the concat delete the source directory along with all the source files. Since a directory-level operation is faster than deleting all the files one-by-one on the server, this might provide a performance boost for some applications. This is a specific performance optimizations for some apps like bulk upload apps, where the needs match the functionality offered by this flag.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

getFileStatus

public static DirectoryEntry getFileStatus(String path,
                                           ADLStoreClient client,
                                           RequestOptions opts,
                                           OperationResponse resp)

Gets the directory metadata associated with a file or directory.

Parameters:

path - the file or directory to get metadata for

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

DirectoryEntry containing the metadata for the file

getFileStatus

public static DirectoryEntry getFileStatus(String path,
                                           UserGroupRepresentation oidOrUpn,
                                           ADLStoreClient client,
                                           RequestOptions opts,
                                           OperationResponse resp)

Gets the directory metadata associated with a file or directory.

Parameters:

path - the file or directory to get metadata for

oidOrUpn - UserGroupRepresentation enum specifying whether to return user and group information as OID or UPN

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

DirectoryEntry containing the metadata for the file

listStatus

public static List<DirectoryEntry> listStatus(String path,
                                              String listAfter,
                                              String listBefore,
                                              int listSize,
                                              ADLStoreClient client,
                                              RequestOptions opts,
                                              OperationResponse resp)

enumerates the contents of a direcotry, returning a List of DirectoryEntry objects, one per file or directory in the specified directory.

To avoid overwhelming the client or the server, the call may return a partial list, in which case the caller should make the call again with the last entry from the returned list specified as the listAfter parameter of the next call.

Parameters:

path - the directory to enumerate

listAfter - the filename after which to begin enumeration

listBefore - the filename before which to end the enumeration

listSize - the maximum number of entries in the returned list

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

List<DirectoryEntry> containing the contents of the directory

listStatus

public static List<DirectoryEntry> listStatus(String path,
                                              String listAfter,
                                              String listBefore,
                                              int listSize,
                                              UserGroupRepresentation oidOrUpn,
                                              ADLStoreClient client,
                                              RequestOptions opts,
                                              OperationResponse resp)

enumerates the contents of a direcotry, returning a List of DirectoryEntry objects, one per file or directory in the specified directory.

To avoid overwhelming the client or the server, the call may return a partial list, in which case the caller should make the call again with the last entry from the returned list specified as the listAfter parameter of the next call.

Parameters:

path - the directory to enumerate

listAfter - the filename after which to begin enumeration

listBefore - the filename before which to end the enumeration

listSize - the maximum number of entries in the returned list

oidOrUpn - UserGroupRepresentation enum specifying whether to return user and group information as OID or UPN

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

List<DirectoryEntry> containing the contents of the directory

setTimes

public static void setTimes(String path,
                            long atime,
                            long mtime,
                            ADLStoreClient client,
                            RequestOptions opts,
                            OperationResponse resp)

sets one or both of the times (Modified and Access time) of the file or directory

Parameters:

path - the full path of the file or directory to touch

atime - Access time as a long

mtime - Modified time as a long

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

setOwner

public static void setOwner(String path,
                            String user,
                            String group,
                            ADLStoreClient client,
                            RequestOptions opts,
                            OperationResponse resp)

sets the owning user and group of the file. If the user or group are null, then they are not changed. It is illegal to pass both user and owner as null.

Parameters:

path - the full path of the file

user - the ID of the user, or null

group - the ID of the group, or null

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

setPermission

public static void setPermission(String path,
                                 String octalPermissions,
                                 ADLStoreClient client,
                                 RequestOptions opts,
                                 OperationResponse resp)

Sets the permissions of the specified file ro directory. This sets the traditional unix read/write/execute permissions for the file/directory. To set Acl's use the setAcl call.

Parameters:

path - the full path of the file or directory ro set permissions for

octalPermissions - the permissions to set, in unix octal form. For example, '644'.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

isValidOctal

public static boolean isValidOctal(String input)

checkAccess

public static void checkAccess(String path,
                               String rwx,
                               ADLStoreClient client,
                               RequestOptions opts,
                               OperationResponse resp)

checks whether the calling user has the required permissions for the file. the permissions to check should be specified in the rwx parameter, as a unix permission string.

Parameters:

path - the full path of the file or directory to check

rwx - the permission to check for, in rwx string form. The call returns true if the caller has all the requested permissions. For example, specifying "r-x" succeeds if the caller has read and execute permissions.

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

modifyAclEntries

public static void modifyAclEntries(String path,
                                    String aclSpec,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

Modify the acl entries for a file or directory. This call merges the supplied list with existing ACLs. If an entry with the same scope, type and user already exists, then the permissions are replaced. If not, than an new ACL entry if added.

Parameters:

path - the path of the file or directory whose ACLs should be modified

aclSpec - aclspec string containing the entries to add or modify

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

modifyAclEntries

public static void modifyAclEntries(String path,
                                    List<AclEntry> aclSpec,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

Modify the acl entries for a file or directory. This call merges the supplied list with existing ACLs. If an entry with the same scope, type and user already exists, then the permissions are replaced. If not, than an new ACL entry if added.

Parameters:

path - the path of the file or directory whose ACLs should be modified

aclSpec - List of AclEntrys, containing the entries to add or modify

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

removeAclEntries

public static void removeAclEntries(String path,
                                    String aclSpec,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

Removes the specified ACL entries from a file or directory.

Parameters:

path - the fll path of the file or directory to remove ACLs from

aclSpec - aclspec string containing entries to remove

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

removeAclEntries

public static void removeAclEntries(String path,
                                    List<AclEntry> aclSpec,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

Removes the specified ACL entries from a file or directory.

Parameters:

path - the fll path of the file or directory to remove ACLs from

aclSpec - List of AclEntrys to remove

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

removeDefaultAcl

public static void removeDefaultAcl(String path,
                                    ADLStoreClient client,
                                    RequestOptions opts,
                                    OperationResponse resp)

removes all default acl entries from a directory. The access ACLs for the directory itself are not modified.

Parameters:

path - the full path of the directory from which to remove default ACLs

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

removeAcl

public static void removeAcl(String path,
                             ADLStoreClient client,
                             RequestOptions opts,
                             OperationResponse resp)

removes all acl entries from a file or directory.

Parameters:

path - the full path of the file or directory from which to remove ACLs

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

setAcl

public static void setAcl(String path,
                          String aclSpec,
                          ADLStoreClient client,
                          RequestOptions opts,
                          OperationResponse resp)

Sets the ACLs for a file or directory. If the file or directory already has any ACLs associated with it, then all the existing ACLs are removed before adding the specified ACLs.

Parameters:

path - the full path to the file or directory to set ACLs for.

aclSpec - posix aclspec string containing the ACLs to set

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

setAcl

public static void setAcl(String path,
                          List<AclEntry> aclSpec,
                          ADLStoreClient client,
                          RequestOptions opts,
                          OperationResponse resp)

Sets the ACLs for a file or directory. If the file or directory already has any ACLs associated with it, then all the existing ACLs are removed before adding the specified ACLs.

Parameters:

path - the full path to the file or directory to set ACLs for.

aclSpec - List of AclEntrys to set

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

getAclStatus

public static AclStatus getAclStatus(String path,
                                     ADLStoreClient client,
                                     RequestOptions opts,
                                     OperationResponse resp)

Gets the current ACLs and permissions associated with a file or directory. Also returns the current owning user and group for the file or directory.

Parameters:

path - the full path of the file or directory to get ACLs and permissions for

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

AclStatus object containing the ACLs, permissions and owners of the file or directory

getAclStatus

public static AclStatus getAclStatus(String path,
                                     UserGroupRepresentation oidOrUpn,
                                     ADLStoreClient client,
                                     RequestOptions opts,
                                     OperationResponse resp)

Gets the current ACLs and permissions associated with a file or directory. Also returns the current owning user and group for the file or directory.

Parameters:

path - the full path of the file or directory to get ACLs and permissions for

oidOrUpn - UserGroupRepresentation enum specifying whether to return user and group information as OID or UPN

client - the ADLStoreClient

opts - options to change the behavior of the call

resp - response from the call, and any error info generated by the call

Returns:

AclStatus object containing the ACLs, permissions and owners of the file or directory