PHP Class Scalr\Service\OpenStack\OpenStackConfig

Since: 06.12.2012

Author: Vitaliy Demidov ([email protected])

Exibir arquivo Open project: scalr/scalr Class Usage Examples

Public Methods

Method	Description
__construct ( string $username, string $identityEndpoint, string $region, string $apiKey = null, Closur\Closure $updateTokenCallback = null, Scalr\Service\OpenStack\Client\AuthToken $authToken = null, string $password = null, string $tenantName = null, string $domainName = null, string $identityVersion = null, array $proxySettings = null, integer $requestTimeout = null )	Convenient constructor
getApiKey ( ) : string	Gets User's API Key
getAuthQueryString ( ) : array	Gets auth query string
getAuthToken ( ) : Scalr\Service\OpenStack\Client\AuthToken	Gets an Auth Token
getDomainName ( ) : string	Gets OpenStack identity domain name
getIdentityEndpoint ( ) : string	Gets OpenStack identity endpoint
getIdentityVersion ( ) : string	Gets OpenStack API version
getPassword ( ) : string	Gets user's password
getProjectId ( ) : string	Gets OpenStack project id
getProjectName ( ) : string	Gets OpenStack project id It same as tenant name for Identity v2
getProxySettings ( )
getRegion ( ) : string	Gets region
getRequestTimeout ( ) : integer	Gets request timeout for api calls
getTenantName ( ) : string	Gets OpenStack tenant name
getUpdateTokenCallback ( ) : Closur\Closure	Gets update token callback
getUserId ( ) : string	Gets OpenStack user id
getUsername ( ) : string	Gets an username
isOpenStack ( ) : boolean	Checks whether this is OpenStack Endpoint
parseIdentityVersion ( string $keystone ) : integer \| null	Parses the version of identity endpoint url
resetRequestTimeout ( ) : OpenStackConfig	Sets default request timeout for api calls (from config)
setApiKey ( string $apiKey ) : OpenStackConfig	Sets API Key
setAuthToken ( Scalr\Service\OpenStack\Client\AuthToken $authToken = null ) : OpenStackConfig	Sets an Auth Token
setDomainName ( string $domainName ) : OpenStackConfig	Sets OpenStack identity domain name
setIdentityEndpoint ( string $identityEndpoint ) : OpenStackConfig	Sets a OpenStack identity endpoint
setIdentityVersion ( integer $version = null )	Sets OpenStack API version
setPassword ( string $password ) : OpenStackConfig	Sets user's password
setProjectId ( string $projectId )	Sets OpenStack project id
setProxySettings ( array $proxySettings = null )
setRegion ( string $region ) : OpenStackConfig	Sets OpenStack Region
setRequestTimeout ( integer $requestTimeout ) : OpenStackConfig	Sets request timeout for api calls
setTenantName ( string $tenantName ) : OpenStackConfig	Sets OpenStack tenant name
setUpdateTokenCallback ( Closur\Closure $updateTokenCallback = null )	Sets update token callback
setUserId ( string $userId )	Sets OpenStack user id
setUsername ( string $username ) : OpenStackConfig	Sets username

Method Details

__construct() public method

Convenient constructor

public __construct ( string $username, string $identityEndpoint, string $region, string $apiKey = null, Closur\Closure $updateTokenCallback = null, Scalr\Service\OpenStack\Client\AuthToken $authToken = null, string $password = null, string $tenantName = null, string $domainName = null, string $identityVersion = null, array $proxySettings = null, integer $requestTimeout = null )
$username	string	An user name
$identityEndpoint	string	OpenStack Identity Endpoint
$region	string	OpenStack Region
$apiKey	string	optional An User's API Key
$updateTokenCallback	Closur\Closure	optional Update Token Callback This function must accept one parameter AuthToken object.
$authToken	Scalr\Service\OpenStack\Client\AuthToken	optional Authentication token for the OpenStack service.
$password	string	optional An User's password
$tenantName	string	optional Either tenant name for V2 or project for V3
$domainName	string	optional The domain name
$identityVersion	string	optional The version of the identity
$proxySettings	array	optional Proxy settings
$requestTimeout	integer	optional Request timeout

getApiKey() public method

Gets User's API Key

public getApiKey ( ) : string
return	string	$apiKey Returns user API key

getAuthQueryString() public method

Gets auth query string

public getAuthQueryString ( ) : array
return	array	Returns auth query

getAuthToken() public method

Gets an Auth Token

public getAuthToken ( ) : Scalr\Service\OpenStack\Client\AuthToken
return	Scalr\Service\OpenStack\Client\AuthToken	An authentication token.

getDomainName() public method

Gets OpenStack identity domain name

public getDomainName ( ) : string
return	string	Returns OpenStack identity domain name.

getIdentityEndpoint() public method

Gets OpenStack identity endpoint

public getIdentityEndpoint ( ) : string
return	string	Returns identity endpoint

getIdentityVersion() public method

Gets OpenStack API version

public getIdentityVersion ( ) : string
return	string	Returns the version of the identity

getPassword() public method

Gets user's password

public getPassword ( ) : string
return	string	Returns user's password

getProjectId() public method

Gets OpenStack project id

public getProjectId ( ) : string
return	string

getProjectName() public method

Gets OpenStack project id It same as tenant name for Identity v2

public getProjectName ( ) : string
return	string

getProxySettings() public method

public getProxySettings ( )

getRegion() public method

Gets region

public getRegion ( ) : string
return	string	Returns OpenStack Region

getRequestTimeout() public method

Gets request timeout for api calls

public getRequestTimeout ( ) : integer
return	integer	Returns request timeout

getTenantName() public method

Gets OpenStack tenant name

public getTenantName ( ) : string
return	string	Returns OpenStack tenant name.

getUpdateTokenCallback() public method

Gets update token callback

public getUpdateTokenCallback ( ) : Closur\Closure
return	Closur\Closure	Returns update token callback

getUserId() public method

Gets OpenStack user id

public getUserId ( ) : string
return	string

getUsername() public method

Gets an username

public getUsername ( ) : string
return	string	Returns an username

isOpenStack() public method

Checks whether this is OpenStack Endpoint

public isOpenStack ( ) : boolean
return	boolean	Returns TRUE if it is OpenStack Endpoint

parseIdentityVersion() public static method

Parses the version of identity endpoint url

public static parseIdentityVersion ( string $keystone ) : integer \| null
$keystone	string	The identity endpoint url
return	integer \| null	Returns the major version number or NULL if it cannot be obtained from the specified URL

resetRequestTimeout() public method

Sets default request timeout for api calls (from config)

public resetRequestTimeout ( ) : OpenStackConfig
return	OpenStackConfig

setApiKey() public method

Sets API Key

public setApiKey ( string $apiKey ) : OpenStackConfig
$apiKey	string	An User API Key
return	OpenStackConfig

setAuthToken() public method

Sets an Auth Token

public setAuthToken ( Scalr\Service\OpenStack\Client\AuthToken $authToken = null ) : OpenStackConfig
$authToken	Scalr\Service\OpenStack\Client\AuthToken	An authentication token.
return	OpenStackConfig

setDomainName() public method

Sets OpenStack identity domain name

public setDomainName ( string $domainName ) : OpenStackConfig
$domainName	string	OpenStack identity domain name
return	OpenStackConfig

setIdentityEndpoint() public method

Sets a OpenStack identity endpoint

public setIdentityEndpoint ( string $identityEndpoint ) : OpenStackConfig
$identityEndpoint	string	OpenStack identity endpoint
return	OpenStackConfig

setIdentityVersion() public method

Sets OpenStack API version

public setIdentityVersion ( integer $version = null )
$version	integer

setPassword() public method

Sets user's password

public setPassword ( string $password ) : OpenStackConfig
$password	string	An User password.
return	OpenStackConfig

setProjectId() public method

Sets OpenStack project id

public setProjectId ( string $projectId )
$projectId	string	OpenStack project id

setProxySettings() public method

public setProxySettings ( array $proxySettings = null )
$proxySettings	array

setRegion() public method

Sets OpenStack Region

public setRegion ( string $region ) : OpenStackConfig
$region	string	OpenStack Region
return	OpenStackConfig

setRequestTimeout() public method

Sets request timeout for api calls

public setRequestTimeout ( integer $requestTimeout ) : OpenStackConfig
$requestTimeout	integer	Request timeout (in seconds)
return	OpenStackConfig

setTenantName() public method

Sets OpenStack tenant name

public setTenantName ( string $tenantName ) : OpenStackConfig
$tenantName	string	OpenStack tenant name
return	OpenStackConfig

setUpdateTokenCallback() public method

Sets update token callback

public setUpdateTokenCallback ( Closur\Closure $updateTokenCallback = null )
$updateTokenCallback	Closur\Closure	Update token callback must accept one argument - AuthToken

setUserId() public method

Sets OpenStack user id

public setUserId ( string $userId )
$userId	string	OpenStack user id

setUsername() public method

Sets username

public setUsername ( string $username ) : OpenStackConfig
$username	string	An User name.
return	OpenStackConfig