org.apache.hadoop.fs.azurebfs.extensions

Interface SASTokenProvider

@InterfaceAudience.LimitedPrivate(value="authorization-subsystems")
 @InterfaceStability.Unstable
public interface SASTokenProvider

Interface to support SAS authorization.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_ACCESS_OPERATION
static String	CREATE_DIRECTORY_OPERATION
static String	CREATE_FILE_OPERATION
static String	DELETE_OPERATION
static String	DELETE_RECURSIVE_OPERATION
static String	GET_ACL_OPERATION
static String	GET_PROPERTIES_OPERATION
static String	GET_STATUS_OPERATION
static String	LIST_OPERATION
static String	READ_OPERATION
static String	RENAME_DESTINATION_OPERATION
static String	RENAME_SOURCE_OPERATION
static String	SET_ACL_OPERATION
static String	SET_OWNER_OPERATION
static String	SET_PERMISSION_OPERATION
static String	SET_PROPERTIES_OPERATION
static String	WRITE_OPERATION

Method Summary

Modifier and Type	Method and Description
String	getSASToken(String account, String fileSystem, String path, String operation) Invokes the authorizer to obtain a SAS token.
void	initialize(org.apache.hadoop.conf.Configuration configuration, String accountName) Initialize authorizer for Azure Blob File System.

Field Detail

CHECK_ACCESS_OPERATION

static final String CHECK_ACCESS_OPERATION

See Also:

Constant Field Values

CREATE_DIRECTORY_OPERATION

static final String CREATE_DIRECTORY_OPERATION

See Also:

Constant Field Values

CREATE_FILE_OPERATION

static final String CREATE_FILE_OPERATION

See Also:

Constant Field Values

DELETE_OPERATION

static final String DELETE_OPERATION

See Also:

Constant Field Values

DELETE_RECURSIVE_OPERATION

static final String DELETE_RECURSIVE_OPERATION

See Also:

Constant Field Values

GET_ACL_OPERATION

static final String GET_ACL_OPERATION

See Also:

Constant Field Values

GET_STATUS_OPERATION

static final String GET_STATUS_OPERATION

See Also:

Constant Field Values

GET_PROPERTIES_OPERATION

static final String GET_PROPERTIES_OPERATION

See Also:

Constant Field Values

LIST_OPERATION

static final String LIST_OPERATION

See Also:

Constant Field Values

READ_OPERATION

static final String READ_OPERATION

See Also:

Constant Field Values

RENAME_SOURCE_OPERATION

static final String RENAME_SOURCE_OPERATION

See Also:

Constant Field Values

RENAME_DESTINATION_OPERATION

static final String RENAME_DESTINATION_OPERATION

See Also:

Constant Field Values

SET_ACL_OPERATION

static final String SET_ACL_OPERATION

See Also:

Constant Field Values

SET_OWNER_OPERATION

static final String SET_OWNER_OPERATION

See Also:

Constant Field Values

SET_PERMISSION_OPERATION

static final String SET_PERMISSION_OPERATION

See Also:

Constant Field Values

SET_PROPERTIES_OPERATION

static final String SET_PROPERTIES_OPERATION

See Also:

Constant Field Values

WRITE_OPERATION

static final String WRITE_OPERATION

See Also:

Constant Field Values

Method Detail

initialize

void initialize(org.apache.hadoop.conf.Configuration configuration,
                String accountName)
         throws IOException

Initialize authorizer for Azure Blob File System.

Parameters:

configuration - Configuration object

accountName - Account Name

Throws:

IOException - network problems or similar.

getSASToken

String getSASToken(String account,
                   String fileSystem,
                   String path,
                   String operation)
            throws IOException,
                   org.apache.hadoop.security.AccessControlException

Invokes the authorizer to obtain a SAS token.

Parameters:

account - the name of the storage account.

fileSystem - the name of the fileSystem.

path - the file or directory path.

operation - the operation to be performed on the path.

Returns:

a SAS token to perform the request operation.

Throws:

IOException - if there is a network error.

org.apache.hadoop.security.AccessControlException - if access is denied.