Package org.apache.hadoop.fs.azurebfs.extensions

Interface SASTokenProvider

All Known Implementing Classes:

FixedSASTokenProvider

@LimitedPrivate("authorization-subsystems")
@Unstable
public interface SASTokenProvider

Interface to support SAS authorization.

Field Summary

Fields

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

Method Summary

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

Field Detail

CHECK_ACCESS_OPERATION

static final java.lang.String CHECK_ACCESS_OPERATION

See Also:

Constant Field Values

CREATE_DIRECTORY_OPERATION

static final java.lang.String CREATE_DIRECTORY_OPERATION

See Also:

Constant Field Values

CREATE_FILE_OPERATION

static final java.lang.String CREATE_FILE_OPERATION

See Also:

Constant Field Values

DELETE_OPERATION

static final java.lang.String DELETE_OPERATION

See Also:

Constant Field Values

DELETE_RECURSIVE_OPERATION

static final java.lang.String DELETE_RECURSIVE_OPERATION

See Also:

Constant Field Values

GET_ACL_OPERATION

static final java.lang.String GET_ACL_OPERATION

See Also:

Constant Field Values

GET_STATUS_OPERATION

static final java.lang.String GET_STATUS_OPERATION

See Also:

Constant Field Values

GET_PROPERTIES_OPERATION

static final java.lang.String GET_PROPERTIES_OPERATION

See Also:

Constant Field Values

LIST_OPERATION

static final java.lang.String LIST_OPERATION

See Also:

Constant Field Values

READ_OPERATION

static final java.lang.String READ_OPERATION

See Also:

Constant Field Values

RENAME_SOURCE_OPERATION

static final java.lang.String RENAME_SOURCE_OPERATION

See Also:

Constant Field Values

RENAME_DESTINATION_OPERATION

static final java.lang.String RENAME_DESTINATION_OPERATION

See Also:

Constant Field Values

SET_ACL_OPERATION

static final java.lang.String SET_ACL_OPERATION

See Also:

Constant Field Values

SET_OWNER_OPERATION

static final java.lang.String SET_OWNER_OPERATION

See Also:

Constant Field Values

SET_PERMISSION_OPERATION

static final java.lang.String SET_PERMISSION_OPERATION

See Also:

Constant Field Values

SET_PROPERTIES_OPERATION

static final java.lang.String SET_PROPERTIES_OPERATION

See Also:

Constant Field Values

WRITE_OPERATION

static final java.lang.String WRITE_OPERATION

See Also:

Constant Field Values

Method Detail

initialize

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

Initialize authorizer for Azure Blob File System.

Parameters:

configuration - Configuration object

accountName - Account Name

Throws:

java.io.IOException - network problems or similar.

getSASToken

java.lang.String getSASToken(java.lang.String account,
                             java.lang.String fileSystem,
                             java.lang.String path,
                             java.lang.String operation)
                      throws java.io.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:

java.io.IOException - if there is a network error.

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