Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Service_WindowsAzure_Credentials_SharedAccessSignature Class Reference

Public Member Functions

 __construct ($accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false, $permissionSet=array())
 Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance.
 
 getPermissionSet ()
 Get permission set.
 
 setPermissionSet ($value=array())
 Set permisison set.
 
 createSignature ($path= '/', $resource= 'b', $permissions= 'r', $start= '', $expiry= '', $identifier= '')
 Create signature.
 
 createSignedQueryString ($path= '/', $queryString= '', $resource= 'b', $permissions= 'r', $start= '', $expiry= '', $identifier= '')
 Create signed query string.
 
 permissionMatchesRequest ($permissionUrl= '', $requestUrl= '', $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ)
 Permission matches request?
 
 signRequestUrl ($requestUrl= '', $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ)
 Sign request URL with credentials.
 
 signRequestHeaders ($httpVerb=Zend_Http_Client::GET, $path= '/', $queryString= '', $headers=null, $forTableStorage=false, $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ, $rawData=null)
 Sign request with credentials.
 
- Public Member Functions inherited from Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
 __construct ($accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false)
 Creates a new Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance.
 
 setAccountName ($value=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT)
 Set account name for Windows Azure.
 
 setAccountkey ($value=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY)
 Set account key for Windows Azure.
 
 setUsePathStyleUri ($value=false)
 Set use path-style URI's.
 
 signRequestUrl ($requestUrl= '', $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ)
 Sign request URL with credentials.
 
 signRequestHeaders ($httpVerb=Zend_Http_Client::GET, $path= '/', $queryString= '', $headers=null, $forTableStorage=false, $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ, $rawData=null)
 Sign request headers with credentials.
 

Protected Attributes

 $_permissionSet = array()
 
- Protected Attributes inherited from Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
 $_accountName = ''
 
 $_accountKey = ''
 
 $_usePathStyleUri = false
 

Additional Inherited Members

- Public Attributes inherited from Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
const DEVSTORE_ACCOUNT = "devstoreaccount1"
 Development storage account and key.
 
const DEVSTORE_KEY = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
 
const PREFIX_PROPERTIES = "x-ms-prop-"
 HTTP header prefixes.
 
const PREFIX_METADATA = "x-ms-meta-"
 
const PREFIX_STORAGE_HEADER = "x-ms-"
 
const PERMISSION_READ = "r"
 Permissions.
 
const PERMISSION_WRITE = "w"
 
const PERMISSION_DELETE = "d"
 
const PERMISSION_LIST = "l"
 
- Protected Member Functions inherited from Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
 _prepareQueryStringForSigning ($value)
 Prepare query string for signing.
 
 _makeArrayOfQueryString ($value)
 Make array of query string.
 
 _issetOr ($array, $key, $valueIfNotSet)
 Returns an array value if the key is set, otherwide returns $valueIfNotSet.
 

Constructor & Destructor Documentation

__construct (   $accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT,
  $accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY,
  $usePathStyleUri = false,
  $permissionSet = array() 
)

Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance.

Parameters
string$accountNameAccount name for Windows Azure
string$accountKeyAccount key for Windows Azure
boolean$usePathStyleUriUse path-style URI's
array$permissionSetPermission set

Member Function Documentation

createSignature (   $path = '/',
  $resource = 'b',
  $permissions = 'r',
  $start = '',
  $expiry = '',
  $identifier = '' 
)

Create signature.

Parameters
string$pathPath for the request
string$resourceSigned resource - container (c) - blob (b)
string$permissionsSigned permissions - read (r), write (w), delete (d) and list (l)
string$startThe time at which the Shared Access Signature becomes valid.
string$expiryThe time at which the Shared Access Signature becomes invalid.
string$identifierSigned identifier
Returns
string
createSignedQueryString (   $path = '/',
  $queryString = '',
  $resource = 'b',
  $permissions = 'r',
  $start = '',
  $expiry = '',
  $identifier = '' 
)

Create signed query string.

Parameters
string$pathPath for the request
string$queryStringQuery string for the request
string$resourceSigned resource - container (c) - blob (b)
string$permissionsSigned permissions - read (r), write (w), delete (d) and list (l)
string$startThe time at which the Shared Access Signature becomes valid.
string$expiryThe time at which the Shared Access Signature becomes invalid.
string$identifierSigned identifier
Returns
string
getPermissionSet ( )

Get permission set.

Returns
array
permissionMatchesRequest (   $permissionUrl = '',
  $requestUrl = '',
  $resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
  $requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ 
)

Permission matches request?

Parameters
string$permissionUrlPermission URL
string$requestUrlRequest URL
string$resourceTypeResource type
string$requiredPermissionRequired permission
Returns
string Signed request URL
setPermissionSet (   $value = array())

Set permisison set.

Warning: fine-grained permissions should be added prior to coarse-grained permissions. For example: first add blob permissions, end with container-wide permissions.

Warning: the signed access signature URL must match the account name of the Zend_Service_WindowsAzure_Credentials_Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance

Parameters
array$valuePermission set
Returns
void
signRequestHeaders (   $httpVerb = Zend_Http_Client::GET,
  $path = '/',
  $queryString = '',
  $headers = null,
  $forTableStorage = false,
  $resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
  $requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ,
  $rawData = null 
)

Sign request with credentials.

Parameters
string$httpVerbHTTP verb the request will use
string$pathPath for the request
string$queryStringQuery string for the request
array$headersx-ms headers to add
boolean$forTableStorageIs the request for table storage?
string$resourceTypeResource type
string$requiredPermissionRequired permission
mixed$rawDataRaw post data
Returns
array Array of headers
signRequestUrl (   $requestUrl = '',
  $resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
  $requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ 
)

Sign request URL with credentials.

Parameters
string$requestUrlRequest URL
string$resourceTypeResource type
string$requiredPermissionRequired permission
Returns
string Signed request URL

Member Data Documentation

$_permissionSet = array()
protected