PHP 클래스 Scalr\Service\OpenStack\OpenStackConfig

부터: 06.12.2012

저자: Vitaliy Demidov ([email protected])

공개 메소드들

메소드	설명
__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

메소드 상세

__construct() 공개 메소드

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() 공개 메소드

Gets User's API Key

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

getAuthQueryString() 공개 메소드

Gets auth query string

public getAuthQueryString ( ) : array
리턴	array	Returns auth query

getAuthToken() 공개 메소드

Gets an Auth Token

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

getDomainName() 공개 메소드

Gets OpenStack identity domain name

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

getIdentityEndpoint() 공개 메소드

Gets OpenStack identity endpoint

public getIdentityEndpoint ( ) : string
리턴	string	Returns identity endpoint

getIdentityVersion() 공개 메소드

Gets OpenStack API version

public getIdentityVersion ( ) : string
리턴	string	Returns the version of the identity

getPassword() 공개 메소드

Gets user's password

public getPassword ( ) : string
리턴	string	Returns user's password

getProjectId() 공개 메소드

Gets OpenStack project id

public getProjectId ( ) : string
리턴	string

getProjectName() 공개 메소드

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

public getProjectName ( ) : string
리턴	string

getProxySettings() 공개 메소드

public getProxySettings ( )

getRegion() 공개 메소드

Gets region

public getRegion ( ) : string
리턴	string	Returns OpenStack Region

getRequestTimeout() 공개 메소드

Gets request timeout for api calls

public getRequestTimeout ( ) : integer
리턴	integer	Returns request timeout

getTenantName() 공개 메소드

Gets OpenStack tenant name

public getTenantName ( ) : string
리턴	string	Returns OpenStack tenant name.

getUpdateTokenCallback() 공개 메소드

Gets update token callback

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

getUserId() 공개 메소드

Gets OpenStack user id

public getUserId ( ) : string
리턴	string

getUsername() 공개 메소드

Gets an username

public getUsername ( ) : string
리턴	string	Returns an username

isOpenStack() 공개 메소드

Checks whether this is OpenStack Endpoint

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

parseIdentityVersion() 공개 정적인 메소드

Parses the version of identity endpoint url

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

resetRequestTimeout() 공개 메소드

Sets default request timeout for api calls (from config)

public resetRequestTimeout ( ) : OpenStackConfig
리턴	OpenStackConfig

setApiKey() 공개 메소드

Sets API Key

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

setAuthToken() 공개 메소드

Sets an Auth Token

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

setDomainName() 공개 메소드

Sets OpenStack identity domain name

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

setIdentityEndpoint() 공개 메소드

Sets a OpenStack identity endpoint

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

setIdentityVersion() 공개 메소드

Sets OpenStack API version

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

setPassword() 공개 메소드

Sets user's password

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

setProjectId() 공개 메소드

Sets OpenStack project id

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

setProxySettings() 공개 메소드

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

setRegion() 공개 메소드

Sets OpenStack Region

public setRegion ( string $region ) : OpenStackConfig
$region	string	OpenStack Region
리턴	OpenStackConfig

setRequestTimeout() 공개 메소드

Sets request timeout for api calls

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

setTenantName() 공개 메소드

Sets OpenStack tenant name

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

setUpdateTokenCallback() 공개 메소드

Sets update token callback

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

setUserId() 공개 메소드

Sets OpenStack user id

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

setUsername() 공개 메소드

Sets username

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