From f4d12bf72a943d6a8965f21a11eefbb05d2a5483 Mon Sep 17 00:00:00 2001 From: Eole Date: Wed, 27 Apr 2016 22:52:25 +0200 Subject: Add Documentation --- server/doc/classes/genTokenOptions.html | 1082 +++++++++++++++++++++++++++++++ 1 file changed, 1082 insertions(+) create mode 100644 server/doc/classes/genTokenOptions.html (limited to 'server/doc/classes/genTokenOptions.html') diff --git a/server/doc/classes/genTokenOptions.html b/server/doc/classes/genTokenOptions.html new file mode 100644 index 0000000..3643503 --- /dev/null +++ b/server/doc/classes/genTokenOptions.html @@ -0,0 +1,1082 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\genTokenOptions

+

genTokenOptions Class

+

This class allow the generation of tokens for openstack, and to inject +those tokens into the library. Which allow to do a proper login only once +and not for each request

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ checkToken()
+ genIdentityToken()
+ revokeIdentityToken()
+ loadIdentityBackup()
+ genImageToken()
+ revokeImageToken()
+ loadImageBackup()
+ genNetworkToken()
+ revokeNetworkToken()
+ loadNetworkBackup()
+ genComputeToken()
+ revokeComputeToken()
+ loadComputeBackup()
+ getBackup()
+ loadBackup()
+ getOptions()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ addDebugMiddleware()
+ saveBackup()
+ serializeToken()
+ unserializeToken()
+
+
+ $optionsGlobal
+ $backup
+ $httpClient
+
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$optionsGlobal

+ 
$optionsGlobal : Array
+

+ + +

Type

+ Array + — private, contains the options common for the different tokens
+
+ +
+ +
+
+ +
+

$backup

+ 
$backup : Array
+

+ + +

Type

+ Array + — private, contains all the informations about the different tokens. It contains the information send to the clients
+
+ +
+ +
+
+ +
+

$httpClient

+ 
$httpClient : \GuzzleHttp\Client
+

+ + +

Type

+ \GuzzleHttp\Client + — private, contains a default Client to construct some OpenStack library object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(Array  $options) : \genTokenOptions
+

genTokenOptions constructor

+ + +

Parameters

+ + + + + + +
Array$options

Options to create the objects in the library +AuthUrl is the main options required

+ + +

Returns

+ \genTokenOptions + —

Object

+ +
+
+ +
+ +
+
+ +
+

checkToken()

+ + 
checkToken() : boolean
+

Check the expiration time of a token

+ + + + +

Returns

+ boolean + —

if the token is not expired

+ +
+
+ +
+ +
+
+ +
+

genIdentityToken()

+ + 
genIdentityToken() : void
+

Generate a new token for the Identity service

+ + + + + +
+
+ +
+ +
+
+ +
+

revokeIdentityToken()

+ + 
revokeIdentityToken() : void
+

Revoke the token for the Identity Service

+ + + + + +
+
+ +
+ +
+
+ +
+

loadIdentityBackup()

+ + 
loadIdentityBackup(String  $opt) : void
+

Load a token for the Identity Service

+ + +

Parameters

+ + + + + + +
String$opt

serialized token

+ + + +
+
+ +
+ +
+
+ +
+

genImageToken()

+ + 
genImageToken() : void
+

Generate a new token for the Image service

+ + + + + +
+
+ +
+ +
+
+ +
+

revokeImageToken()

+ + 
revokeImageToken() : void
+

Revoke the token for the Image Service

+ + + + + +
+
+ +
+ +
+
+ +
+

loadImageBackup()

+ + 
loadImageBackup(String  $opt) : void
+

Load a token for the Image Service

+ + +

Parameters

+ + + + + + +
String$opt

serialized token

+ + + +
+
+ +
+ +
+
+ +
+

genNetworkToken()

+ + 
genNetworkToken() : void
+

Generate a new token for the Metwork service

+ + + + + +
+
+ +
+ +
+
+ +
+

revokeNetworkToken()

+ + 
revokeNetworkToken() : void
+

Revoke the token for the Network Service

+ + + + + +
+
+ +
+ +
+
+ +
+

loadNetworkBackup()

+ + 
loadNetworkBackup(String  $opt) : void
+

Load a token for the Network Service

+ + +

Parameters

+ + + + + + +
String$opt

serialized token

+ + + +
+
+ +
+ +
+
+ +
+

genComputeToken()

+ + 
genComputeToken() : void
+

Generate a new token for the Compute service

+ + + + + +
+
+ +
+ +
+
+ +
+

revokeComputeToken()

+ + 
revokeComputeToken() : void
+

Revoke the token for the Compute Service

+ + + + + +
+
+ +
+ +
+
+ +
+

loadComputeBackup()

+ + 
loadComputeBackup(String  $opt) : void
+

Load a token for the Compute Service

+ + +

Parameters

+ + + + + + +
String$opt

serialized token

+ + + +
+
+ +
+ +
+
+ +
+

getBackup()

+ + 
getBackup() : String
+

Retrieve the tokens saved

+ + + + +

Returns

+ String + —

tokens serialized

+ +
+
+ +
+ +
+
+ +
+

loadBackup()

+ + 
loadBackup(String  $back) : void
+

Load tokens into the library

+ + +

Parameters

+ + + + + + +
String$back

tokens serialized

+ + + +
+
+ +
+ +
+
+ +
+

getOptions()

+ + 
getOptions(String  $service) : array
+

Retrieve the common options for a service

+ + +

Parameters

+ + + + + + +
String$service

name of the service

+ + +

Returns

+ array + —

Options to create the library class corresponding to this service

+ +
+
+ +
+ +
+
+ +
+

addDebugMiddleware()

+ + 
addDebugMiddleware(array  $options, \OpenCloud\Common\Transport\HandlerStack  $stack) : void
+

Add a debug for the library

+ + +

Parameters

+ + + + + + + + + + + +
array$options

Debug options, cf library

\OpenCloud\Common\Transport\HandlerStack$stack

pointer to a HandlerStack object

+ + + +
+
+ +
+ +
+
+ +
+

saveBackup()

+ + 
saveBackup(String  $name, Array  $data) : void
+

Save the token given a service name

+ + +

Parameters

+ + + + + + + + + + + +
String$name

name of the service to save

Array$data

token and baseUrl for the service

+ + + +
+
+ +
+ +
+
+ +
+

serializeToken()

+ + 
serializeToken(Array  $token) : String
+

Serialize a given token

+ + +

Parameters

+ + + + + + +
Array$token

token to be serialized

+ + +

Returns

+ String + —

token serialized

+ +
+
+ +
+ +
+
+ +
+

unserializeToken()

+ + 
unserializeToken(String  $tokenSerialized) : \OpenCloud\Common\Auth\Token
+

Unserialize a token

+

Unserialize a token and recreate the architecture of the library token

+ +

Parameters

+ + + + + + +
String$tokenSerialized

the token to be unserialized

+ + +

Returns

+ \OpenCloud\Common\Auth\Token + —

the token unserialized

+ +
+
+ +
+ +
+
+ + + + +
+ + + -- cgit v1.2.3