PHP Class Scalr\Service\OpenStack\OpenStackConfig

Since: 06.12.2012
Author: Vitaliy Demidov ([email protected])
Afficher le fichier Open project: scalr/scalr Class Usage Examples

Méthodes publiques

Méthode 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 méthode

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 méthode

Gets User's API Key
public getApiKey ( ) : string
Résultat string $apiKey Returns user API key

getAuthQueryString() public méthode

Gets auth query string
public getAuthQueryString ( ) : array
Résultat array Returns auth query

getAuthToken() public méthode

Gets an Auth Token
public getAuthToken ( ) : Scalr\Service\OpenStack\Client\AuthToken
Résultat Scalr\Service\OpenStack\Client\AuthToken An authentication token.

getDomainName() public méthode

Gets OpenStack identity domain name
public getDomainName ( ) : string
Résultat string Returns OpenStack identity domain name.

getIdentityEndpoint() public méthode

Gets OpenStack identity endpoint
public getIdentityEndpoint ( ) : string
Résultat string Returns identity endpoint

getIdentityVersion() public méthode

Gets OpenStack API version
public getIdentityVersion ( ) : string
Résultat string Returns the version of the identity

getPassword() public méthode

Gets user's password
public getPassword ( ) : string
Résultat string Returns user's password

getProjectId() public méthode

Gets OpenStack project id
public getProjectId ( ) : string
Résultat string

getProjectName() public méthode

Gets OpenStack project id It same as tenant name for Identity v2
public getProjectName ( ) : string
Résultat string

getProxySettings() public méthode

public getProxySettings ( )

getRegion() public méthode

Gets region
public getRegion ( ) : string
Résultat string Returns OpenStack Region

getRequestTimeout() public méthode

Gets request timeout for api calls
public getRequestTimeout ( ) : integer
Résultat integer Returns request timeout

getTenantName() public méthode

Gets OpenStack tenant name
public getTenantName ( ) : string
Résultat string Returns OpenStack tenant name.

getUpdateTokenCallback() public méthode

Gets update token callback
public getUpdateTokenCallback ( ) : Closur\Closure
Résultat Closur\Closure Returns update token callback

getUserId() public méthode

Gets OpenStack user id
public getUserId ( ) : string
Résultat string

getUsername() public méthode

Gets an username
public getUsername ( ) : string
Résultat string Returns an username

isOpenStack() public méthode

Checks whether this is OpenStack Endpoint
public isOpenStack ( ) : boolean
Résultat boolean Returns TRUE if it is OpenStack Endpoint

parseIdentityVersion() public static méthode

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

resetRequestTimeout() public méthode

Sets default request timeout for api calls (from config)
public resetRequestTimeout ( ) : OpenStackConfig
Résultat OpenStackConfig

setApiKey() public méthode

Sets API Key
public setApiKey ( string $apiKey ) : OpenStackConfig
$apiKey string An User API Key
Résultat OpenStackConfig

setAuthToken() public méthode

Sets an Auth Token
public setAuthToken ( Scalr\Service\OpenStack\Client\AuthToken $authToken = null ) : OpenStackConfig
$authToken Scalr\Service\OpenStack\Client\AuthToken An authentication token.
Résultat OpenStackConfig

setDomainName() public méthode

Sets OpenStack identity domain name
public setDomainName ( string $domainName ) : OpenStackConfig
$domainName string OpenStack identity domain name
Résultat OpenStackConfig

setIdentityEndpoint() public méthode

Sets a OpenStack identity endpoint
public setIdentityEndpoint ( string $identityEndpoint ) : OpenStackConfig
$identityEndpoint string OpenStack identity endpoint
Résultat OpenStackConfig

setIdentityVersion() public méthode

Sets OpenStack API version
public setIdentityVersion ( integer $version = null )
$version integer

setPassword() public méthode

Sets user's password
public setPassword ( string $password ) : OpenStackConfig
$password string An User password.
Résultat OpenStackConfig

setProjectId() public méthode

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

setProxySettings() public méthode

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

setRegion() public méthode

Sets OpenStack Region
public setRegion ( string $region ) : OpenStackConfig
$region string OpenStack Region
Résultat OpenStackConfig

setRequestTimeout() public méthode

Sets request timeout for api calls
public setRequestTimeout ( integer $requestTimeout ) : OpenStackConfig
$requestTimeout integer Request timeout (in seconds)
Résultat OpenStackConfig

setTenantName() public méthode

Sets OpenStack tenant name
public setTenantName ( string $tenantName ) : OpenStackConfig
$tenantName string OpenStack tenant name
Résultat OpenStackConfig

setUpdateTokenCallback() public méthode

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

setUserId() public méthode

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

setUsername() public méthode

Sets username
public setUsername ( string $username ) : OpenStackConfig
$username string An User name.
Résultat OpenStackConfig