Service/Amazon/Ec2/Abstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Amazon  
Subpackage
Ec2  
Version
$Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Amazon_Ec2_Abstract

Package: Zend\Service\Amazon\Ec2
Provides the basic functionality to send a request to the Amazon Ec2 Query API
Parent(s)
\Zend_Service_Amazon_Abstract < \Zend_Service_Abstract
Children
\Zend_Service_Amazon_Ec2_Keypair
\Zend_Service_Amazon_Ec2_CloudWatch
\Zend_Service_Amazon_Ec2_Instance_Reserved
\Zend_Service_Amazon_Ec2_Instance_Windows
\Zend_Service_Amazon_Ec2_Elasticip
\Zend_Service_Amazon_Ec2_Image
\Zend_Service_Amazon_Ec2_Region
\Zend_Service_Amazon_Ec2_Instance
\Zend_Service_Amazon_Ec2_Availabilityzones
\Zend_Service_Amazon_Ec2_Securitygroups
\Zend_Service_Amazon_Ec2_Ebs
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_accessKey
inherited

Amazon Access Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_accessKey
Details
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_accessKey  
>VPropertyprotectedstring $_defaultAccessKey = null
staticinherited

Amazon Access Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_defaultAccessKey
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_defaultAccessKey  
>VPropertyprotectedstring $_defaultRegion = null
static

Amazon Region

Default valuenullDetails
Type
string
>VPropertyprotectedstring $_defaultSecretKey = null
staticinherited

Amazon Secret Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_defaultSecretKey
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_defaultSecretKey  
>VPropertyprotected$_ec2ApiVersion = '2009-04-04'
The API version to use
Default value'2009-04-04'Details
Type
n/a
>VPropertyprotected$_ec2Endpoint = 'ec2.amazonaws.com'
The HTTP query server
Default value'ec2.amazonaws.com'Details
Type
n/a
>VPropertyprotected$_ec2SignatureMethod = 'HmacSHA256'
Signature Encoding Method
Default value'HmacSHA256'Details
Type
n/a
>VPropertyprotected$_ec2SignatureVersion = '2'
Signature Version
Default value'2'Details
Type
n/a
>VPropertyprotected\Zend_Http_Client $_httpClient = null
staticinherited
HTTP Client used to query all web services
Inherited from: \Zend_Service_Abstract::$$_httpClient\Zend_Service_Amazon_Abstract::$$_httpClient
>VPropertyprotected$_httpTimeout = 10
Period after which HTTP request will timeout in seconds
Default value10Details
Type
n/a
>VPropertyprotectedstring $_region

Amazon Region

Details
Type
string
>VPropertyprotectedstring $_secretKey
inherited

Amazon Secret Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_secretKey
Details
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_secretKey  
>VPropertyprotectedarray $_validEc2Regions = array('eu-west-1', 'us-east-1')
static
An array that contains all the valid Amazon Ec2 Regions.
Default valuearray('eu-west-1', 'us-east-1')Details
Type
array

Methods

methodpublic__construct( $accessKey = null,  $secretKey = null, string $region = null) : void

Create Amazon client.

Parameters
NameTypeDescription
$accessKey
$secretKey
$regionstring

Sets the AWS Region

methodprotected_getAccessKey() : string
inherited

Method to fetch the Access Key

Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()
Returns
TypeDescription
string
methodprotected_getRegion() : string

Method to fetch the AWS Region

Returns
TypeDescription
string
methodprotected_getSecretKey() : string
inherited

Method to fetch the Secret AWS Key

Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()
Returns
TypeDescription
string
methodprotectedaddRequiredParameters(array $parameters) : array

Adds required authentication and version parameters to an array of parameters

The required parameters are: - AWSAccessKey - SignatureVersion - Timestamp - Version and - Signature

If a required parameter is already set in the $parameters array, it is overwritten.

Parameters
NameTypeDescription
$parametersarray

the array to which to add the required parameters.

Returns
TypeDescription
array
methodprivatecheckForErrors(\Zend_Service_Amazon_Ec2_Response $response) : void

Checks for errors responses from Amazon

Parameters
NameTypeDescription
$response\Zend_Service_Amazon_Ec2_Response

the response object to check.

Throws
ExceptionDescription
\Zend_Service_Amazon_Ec2_Exceptionif one or more errors are returned from Amazon.
methodpublicgetHttpClient() : \Zend_Http_Client
staticfinalinherited

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Service_Amazon_Abstract::getHttpClient()
Returns
TypeDescription
\Zend_Http_Client
methodprotectedsendRequest(array $params = array()) : \Zend_Service_Amazon_Ec2_Response

Sends a HTTP request to the queue service using Zend_Http_Client

Parameters
NameTypeDescription
$paramsarray

List of parameters to send with the request

Returns
TypeDescription
\Zend_Service_Amazon_Ec2_Response
Throws
ExceptionDescription
\Zend_Service_Amazon_Ec2_Exception
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : void
staticfinalinherited

Sets the HTTP client object to use for retrieving the feeds.

Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Service_Amazon_Abstract::setHttpClient()

If none is set, the default Zend_Http_Client will be used.

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
methodpublicsetKeys( $accessKey,  $secretKey) : void
staticinherited

Set the keys to use when accessing SQS.

Inherited from: \Zend_Service_Amazon_Abstract::setKeys()
Parameters
NameTypeDescription
$accessKey
$secretKey
methodpublicsetRegion(string $region) : void
static

Set which region you are working in.

It will append the end point automaticly

Parameters
NameTypeDescription
$regionstring
methodprotectedsignParameters( $paramaters) : string

Computes the RFC 2104-compliant HMAC signature for request parameters

This implements the Amazon Web Services signature, as per the following specification:

  1. Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.

  2. Iterate over the sorted list and append the parameter name (in its original case) and then its value. Do not URL-encode the parameter values before constructing this string. Do not use any separator characters when appending strings.

Parameters
NameTypeDescription
$paramaters
Returns
TypeDescription
stringthe signed data.
Documentation was generated by phpDocumentor 2.0.0a12.