com.microsoft.azure.storage.blob

Class SharedKeyCredentials

java.lang.Object

com.microsoft.azure.storage.blob.SharedKeyCredentials

All Implemented Interfaces:

ICredentials, com.microsoft.rest.v2.policy.RequestPolicyFactory

public final class SharedKeyCredentials
extends Object
implements ICredentials

SharedKeyCredentials are a means of signing and authenticating storage requests. The key can be obtained from the Azure portal. This factory will create policies which take care of all the details of creating strings to sign, signing them, and setting the Authentication header. While this is a common way of authenticating with the service, recommended practice is using TokenCredentials. Pass this as the credentials in the construction of a new HttpPipeline via the StorageURL type.

Constructor Summary

Constructors

Constructor and Description
SharedKeyCredentials(String accountName, String accountKey) Initializes a new instance of SharedKeyCredentials contains an account's name and its primary or secondary accountKey.

Method Summary

Modifier and Type	Method and Description
com.microsoft.rest.v2.policy.RequestPolicy	create(com.microsoft.rest.v2.policy.RequestPolicy nextRequestPolicy, com.microsoft.rest.v2.policy.RequestPolicyOptions options)
String	getAccountName() Gets the account name associated with the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedKeyCredentials

public SharedKeyCredentials(String accountName,
                            String accountKey)
                     throws InvalidKeyException

Initializes a new instance of SharedKeyCredentials contains an account's name and its primary or secondary accountKey.

Parameters:

accountName - The account name associated with the request.

accountKey - The account access key used to authenticate the request.

Throws:

InvalidKeyException - Thrown when the accountKey is ill-formatted.

Method Detail

getAccountName

public String getAccountName()

Gets the account name associated with the request.

Returns:

The account name.

create

public com.microsoft.rest.v2.policy.RequestPolicy create(com.microsoft.rest.v2.policy.RequestPolicy nextRequestPolicy,
                                                         com.microsoft.rest.v2.policy.RequestPolicyOptions options)

Specified by:

create in interface com.microsoft.rest.v2.policy.RequestPolicyFactory