WAAuthenticationCredential Class Reference
Inherits from | NSObject |
Conforms to | NSXMLParserDelegate |
Declared in | WAAuthenticationCredential.h |
Overview
A class that represents an authentication object that can be passed to the WACloudStorageClient. The class can be initialized using a Windows Azure account name and key, or with a proxy server URL, username, and password.
Tasks
-
usesProxy
Determines whether this authentication credential uses a proxy service. The default value is NO.
property -
proxyURL
The URL of the proxy service.
property -
token
The seesion token returned from authentication with the proxy service.
property -
accountName
The account name for Windows Azure storage or nil if not authenticating directly.
property -
accessKey
The account access key for Windows Azure storage or nil if not authenticating directly.
property -
tableServiceURL
The URL of the table service endpoint, if authenticating with a proxy service.
property -
blobServiceURL
The URL of the blob service endpoint, if authenticating with a proxy service.
property -
+ credentialWithAzureServiceAccount:accessKey:
Initializes a newly created WAAuthenticationCredential with a specified account name and access key obtained from the Windows Azure portal.
-
+ authenticateCredentialSynchronousWithProxyURL:user:password:error:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service, and an NSError object that will contain the error information if the authentication fails.
-
+ authenticateCredentialSynchronousWithProxyURL:tableServiceURL:blobServiceURL:user:password:error:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the table service URL, the blob service URL, the user name and password for the proxy service, and an NSError object that will contain the error information if the authentication fails.
-
+ authenticateCredentialWithProxyURL:user:password:delegate:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service, and a delegate to callback when authentication completes.
-
+ authenticateCredentialWithProxyURL:user:password:withCompletionHandler:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service.
-
+ authenticateCredentialWithProxyURL:accessToken:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL and access token. The access token is the result of using Windows Azure Access Control Service.
Properties
accessKey
The account access key for Windows Azure storage or nil if not authenticating directly.
@property (nonatomic, readonly) NSString *accessKey
Declared In
WAAuthenticationCredential.h
accountName
The account name for Windows Azure storage or nil if not authenticating directly.
@property (nonatomic, readonly) NSString *accountName
Declared In
WAAuthenticationCredential.h
blobServiceURL
The URL of the blob service endpoint, if authenticating with a proxy service.
@property (nonatomic, readonly) NSURL *blobServiceURL
Declared In
WAAuthenticationCredential.h
proxyURL
The URL of the proxy service.
@property (nonatomic, readonly) NSURL *proxyURL
Declared In
WAAuthenticationCredential.h
tableServiceURL
The URL of the table service endpoint, if authenticating with a proxy service.
@property (nonatomic, readonly) NSURL *tableServiceURL
Declared In
WAAuthenticationCredential.h
token
The seesion token returned from authentication with the proxy service.
@property (nonatomic, readonly) NSString *token
Declared In
WAAuthenticationCredential.h
Class Methods
authenticateCredentialSynchronousWithProxyURL:tableServiceURL:blobServiceURL:user:password:error:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the table service URL, the blob service URL, the user name and password for the proxy service, and an NSError object that will contain the error information if the authentication fails.
+ (WAAuthenticationCredential *)authenticateCredentialSynchronousWithProxyURL:(NSURL *)proxyURL tableServiceURL:(NSURL *)tablesURL blobServiceURL:(NSURL *)blobsURL user:(NSString *)user password:(NSString *)password error:(NSError **)returnError
Parameters
- proxyURL
The URL address of the proxy service.
- tablesURL
The URL address of the table service.
- blobsURL
The URL address of the blob service.
- user
The user name for the proxy service.
- password
The password for the proxy service.
- returnError
An NSError object that will contain the error if the authentication fails.
Return Value
The newly initialized WAAuthenticationCredential object.
Declared In
WAAuthenticationCredential.h
authenticateCredentialSynchronousWithProxyURL:user:password:error:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service, and an NSError object that will contain the error information if the authentication fails.
+ (WAAuthenticationCredential *)authenticateCredentialSynchronousWithProxyURL:(NSURL *)proxyURL user:(NSString *)user password:(NSString *)password error:(NSError **)returnError
Parameters
- proxyURL
The URL address of the proxy service.
- user
The user name for the proxy service.
- password
The password for the proxy service.
- returnError
An NSError object that will contain the error if the authentication fails.
Return Value
The newly initialized WAAuthenticationCredential object.
Declared In
WAAuthenticationCredential.h
authenticateCredentialWithProxyURL:accessToken:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL and access token. The access token is the result of using Windows Azure Access Control Service.
+ (WAAuthenticationCredential *)authenticateCredentialWithProxyURL:(NSURL *)proxyURL accessToken:(WACloudAccessToken *)accessToken
Parameters
- proxyURL
The URL address of the proxy service.
- accessToken
The WACloudAccessToken used to authenticate.
Return Value
The newly initialized WAAuthenticationCredential object.
See Also
Declared In
WAAuthenticationCredential.h
authenticateCredentialWithProxyURL:user:password:delegate:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service, and a delegate to callback when authentication completes.
+ (WAAuthenticationCredential *)authenticateCredentialWithProxyURL:(NSURL *)proxyURL user:(NSString *)user password:(NSString *)password delegate:(id<WAAuthenticationDelegate>)delegate
Parameters
- proxyURL
The URL address of the proxy service.
- user
The user name for the proxy service.
- password
The password for the proxy service.
- delegate
The delegate to use.
Return Value
The newly initialized WAAuthenticationCredential object.
See Also
Declared In
WAAuthenticationCredential.h
authenticateCredentialWithProxyURL:user:password:withCompletionHandler:
Initializes a newly created WAAuthenticationCredential with a specified proxy URL, the user name and password for the proxy service.
+ (WAAuthenticationCredential *)authenticateCredentialWithProxyURL:(NSURL *)proxyURL user:(NSString *)user password:(NSString *)password withCompletionHandler:(void ( ^ ) ( NSError *error ))block
Parameters
- proxyURL
The URL address of the proxy service.
- user
The user name for the proxy service.
- password
The password for the proxy service.
- block
A block object that is called with the authentication completes. The block will contain an NSError
Return Value
The newly initialized WAAuthenticationCredential object.
Declared In
WAAuthenticationCredential.h
credentialWithAzureServiceAccount:accessKey:
Initializes a newly created WAAuthenticationCredential with a specified account name and access key obtained from the Windows Azure portal.
+ (WAAuthenticationCredential *)credentialWithAzureServiceAccount:(NSString *)accountName accessKey:(NSString *)accessKey
Parameters
- accountName
The Windows Azure storage account name.
- accessKey
The access key for the given account.
Return Value
The newly initialized WAAuthenticationCredential object.
Declared In
WAAuthenticationCredential.h