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/App.html | 844 ++++++++++++++++++++++ server/doc/classes/Core.html | 346 +++++++++ server/doc/classes/automating.html | 548 ++++++++++++++ server/doc/classes/compute.html | 881 +++++++++++++++++++++++ server/doc/classes/errorManagement.html | 560 +++++++++++++++ server/doc/classes/genTokenOptions.html | 1082 ++++++++++++++++++++++++++++ server/doc/classes/image.html | 824 +++++++++++++++++++++ server/doc/classes/network.html | 1191 +++++++++++++++++++++++++++++++ server/doc/classes/networkLayer3.html | 743 +++++++++++++++++++ 9 files changed, 7019 insertions(+) create mode 100644 server/doc/classes/App.html create mode 100644 server/doc/classes/Core.html create mode 100644 server/doc/classes/automating.html create mode 100644 server/doc/classes/compute.html create mode 100644 server/doc/classes/errorManagement.html create mode 100644 server/doc/classes/genTokenOptions.html create mode 100644 server/doc/classes/image.html create mode 100644 server/doc/classes/network.html create mode 100644 server/doc/classes/networkLayer3.html (limited to 'server/doc/classes') diff --git a/server/doc/classes/App.html b/server/doc/classes/App.html new file mode 100644 index 0000000..c0e8568 --- /dev/null +++ b/server/doc/classes/App.html @@ -0,0 +1,844 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\App

+

App Class of the back-end application

+

This class allow the communication between the front-end application and +the library which allow to send requests to an Openstack instance.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ setToken()
+ checkToken()
+ getLibClass()
+ authenticate()
+ deauthenticate()
+ getPostParam()
+ setPostParam()
+ setOutput()
+ getErrorInstance()
+ show()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $openstack
+ $postParams
+ $tokenClass
+ $tokenPost
+ $errorClass
+ $output
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$openstack

+ 
$openstack : \OpenStack\OpenStack
+

+ + +

Type

+ \OpenStack\OpenStack + — protected, contains the main library object
+
+ +
+ +
+
+ +
+

$postParams

+ 
$postParams : Array
+

+ + +

Type

+ Array + — protected, contains the post parameters
+
+ +
+ +
+
+ +
+

$tokenClass

+ 
$tokenClass : \genTokenOptions
+

+ + +

Type

+ \genTokenOptions + — protected, contains the class object for the authentication override of the library
+
+ +
+ +
+
+ +
+

$tokenPost

+ 
$tokenPost : String
+

+ + +

Type

+ String + — protected, contains the token given in parameter
+
+ +
+ +
+
+ +
+

$errorClass

+ 
$errorClass : \errorManagement
+

+ + +

Type

+ \errorManagement + — protected, contains the errorManagement object
+
+ +
+ +
+
+ +
+

$output

+ 
$output : Array
+

+ + +

Type

+ Array + — protected, contains the result for the API call
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(Array  $args) : \App
+

App constructor

+ + +

Parameters

+ + + + + + +
Array$args

Args for the OpenStack Library

+ + +

Returns

+ \App + —

object

+ +
+
+ +
+ +
+
+ +
+

setToken()

+ + 
setToken(String  $token)
+

Set the class var $tokenPost and load the token +into the genTokenOptions Class

+ + +

Parameters

+ + + + + + +
String$token

token to be set

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

checkToken()

+ + 
checkToken() : Boolean
+

Check the expiration of the token

+ + + + +

Returns

+ Boolean + —

if the token is not expired

+ +
+
+ +
+ +
+
+ +
+

getLibClass()

+ + 
getLibClass(String  $service) : \Core
+

Get the service Class given the name in parameter

+ + +

Parameters

+ + + + + + +
String$service

Name of the service

+ + +

Returns

+ \Core + —

object

+ +
+
+ +
+ +
+
+ +
+

authenticate()

+ + 
authenticate() : void
+

Generate the token for the different services in OpenStack

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

deauthenticate()

+ + 
deauthenticate() : void
+

Revoke the openstack services' token

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

getPostParam()

+ + 
getPostParam(String  $name) : Object
+

Retrieve a post parameter given its name

+ + +

Parameters

+ + + + + + +
String$name

Expected post parameter's name

+ + +

Returns

+ Object + —

Post value

+ +
+
+ +
+ +
+
+ +
+

setPostParam()

+ + 
setPostParam(String  $param, Object  $value) : void
+

Set a post parameter for automating task

+ + +

Parameters

+ + + + + + + + + + + +
String$param

Name for the Post entry

Object$value

Value for the Post entry

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

setOutput()

+ + 
setOutput(String  $key, Array  $out) : void
+

Set a new output message

+ + +

Parameters

+ + + + + + + + + + + +
String$key

Array key for the message

Array$out

Message's value

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

getErrorInstance()

+ + 
getErrorInstance() : \errorManagement
+

Retrieve the errorManagement instance Object

+ + + + +

Returns

+ \errorManagement + —

object

+ +
+
+ +
+ +
+
+ +
+

show()

+ + 
show() : void
+

Output the messages to be send to the client

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/Core.html b/server/doc/classes/Core.html new file mode 100644 index 0000000..47095dc --- /dev/null +++ b/server/doc/classes/Core.html @@ -0,0 +1,346 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\Core

+

Interface for the main classes of the API

+ + +
+

Summary

+
+
+ Methods +
+
+ Constants +
+
+
+
+ action()
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ N/A +
+
+
+
+ +
+ + +
+
+

Methods

+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action in the class

+ + +

Parameters

+ + + + + + +
String$action

Function to be called

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/automating.html b/server/doc/classes/automating.html new file mode 100644 index 0000000..e8e88b7 --- /dev/null +++ b/server/doc/classes/automating.html @@ -0,0 +1,548 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\automating

+

automating Class of the back-end application

+

Contains the different function to automate some action

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $compute
+ $image
+ $network
+ $networkLayer3
+ $app
+
+
+ N/A +
+
+
+
+ createPublicServer()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$compute

+ 
$compute : \App
+

+ + +

Type

+ \App + — protected, contains a Core compute object
+
+ +
+ +
+
+ +
+

$image

+ 
$image : \App
+

+ + +

Type

+ \App + — protected, contains a Core image object
+
+ +
+ +
+
+ +
+

$network

+ 
$network : \App
+

+ + +

Type

+ \App + — protected, contains a Core network object
+
+ +
+ +
+
+ +
+

$networkLayer3

+ 
$networkLayer3 : \App
+

+ + +

Type

+ \App + — protected, contains a Core networkLayer3 object
+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \automating
+

automating class constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \automating + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

createPublicServer()

+ + 
createPublicServer() : void
+

create a new server and associate a public ip

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/compute.html b/server/doc/classes/compute.html new file mode 100644 index 0000000..e6bd0ed --- /dev/null +++ b/server/doc/classes/compute.html @@ -0,0 +1,881 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\compute

+

Compute Class of the back-end application

+

Management of Servers

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+ listServers()
+ listFlavors()
+ listImages()
+ getServer()
+ getFlavor()
+ getImage()
+ createServer()
+ updateServer()
+ deleteServer()
+ changePassword()
+ reboot()
+ rebuild()
+ resize()
+ confirmResize()
+ revertResize()
+ listAddresses()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ +
+
+ +
+

$libClass

+ 
$libClass : \OpenStack\Compute
+

+ + +

Type

+ \OpenStack\Compute + — protected, contains the library Compute object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(  $app) : \compute
+

Compute constructor

+ + +

Parameters

+ + + + + + +
$app
+ + +

Returns

+ \compute + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

listServers()

+ + 
listServers() : void
+

List servers.

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

listFlavors()

+ + 
listFlavors() : void
+

List flavors.

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

listImages()

+ + 
listImages() : void
+

List images.

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

getServer()

+ + 
getServer() : void
+

Get server details.

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

getFlavor()

+ + 
getFlavor() : void
+

Get flavor details.

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

getImage()

+ + 
getImage() : array
+

Get image details.

+ + + + +

Returns

+ array + +
+
+ +
+ +
+
+ +
+

createServer()

+ + 
createServer() : void
+

Create server.

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

updateServer()

+ + 
updateServer() : void
+

update a server

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

deleteServer()

+ + 
deleteServer() : void
+

Delete a server

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

changePassword()

+ + 
changePassword() : void
+

Change the password of a server

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

reboot()

+ + 
reboot() : void
+

Reboot a server

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

rebuild()

+ + 
rebuild() : void
+

Rebuild a server

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

resize()

+ + 
resize() : void
+

Resize a server

+

A call to this method has to be followed by either confirmResize or revertResize

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

confirmResize()

+ + 
confirmResize() : void
+

Confirm resize operation on a server

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

revertResize()

+ + 
revertResize() : void
+

Revert resize operation on a server

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

listAddresses()

+ + 
listAddresses() : void
+

List private and public addresses of a server

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/errorManagement.html b/server/doc/classes/errorManagement.html new file mode 100644 index 0000000..ca73563 --- /dev/null +++ b/server/doc/classes/errorManagement.html @@ -0,0 +1,560 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\errorManagement

+

errorManagement Class of the back-end application

+

Management of error

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ BaseErrorHandler()
+ BadResponseHandler()
+ NotImplementedHandler()
+ UserInputHandler()
+ OtherException()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $args) : \ErrorManagement
+

ErrorManagemement constructor

+ + +

Parameters

+ + + + + + +
\App$args

the main app object

+ + +

Returns

+ \ErrorManagement + —

Object

+ +
+
+ +
+ +
+
+ +
+

BaseErrorHandler()

+ + 
BaseErrorHandler(\Exception  $error) : void
+

Put an error message corresponding to a base error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

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

BadResponseHandler()

+ + 
BadResponseHandler(\Exception  $error) : void
+

Put an error message corresponding to a bad response in function of the status code in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

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

NotImplementedHandler()

+ + 
NotImplementedHandler(\Exception  $error) : void
+

Put an error message corresponding to a not implemented yet error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

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

UserInputHandler()

+ + 
UserInputHandler(\Exception  $error) : void
+

Put an error message corresponding to a user input error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

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

OtherException()

+ + 
OtherException(\Exception  $error) : void
+

Put an error message corresponding to an other error in the output

+ + +

Parameters

+ + + + + + +
\Exception$error

the exception triggered

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + 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

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/image.html b/server/doc/classes/image.html new file mode 100644 index 0000000..872d453 --- /dev/null +++ b/server/doc/classes/image.html @@ -0,0 +1,824 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\image

+

Image Class of the back-end application

+

Management of images

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ createImage()
+ listImage()
+ detailsImage()
+ updateImage()
+ deleteImage()
+ reactivateImage()
+ desactivateImage()
+ uploadImage()
+ downloadImage()
+ addMemberImage()
+ listMemberImage()
+ detailMemberImage()
+ removeMemberImage()
+ updateMemberImage()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ +
+
+ +
+

$libClass

+ 
$libClass : \OpenStack\Image
+

+ + +

Type

+ \OpenStack\Image + — protected, contains the library Image object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \image
+

Image constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \image + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

createImage()

+ + 
createImage() : void
+

Create a new image

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

listImage()

+ + 
listImage() : void
+

List the images of the server

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

detailsImage()

+ + 
detailsImage() : void
+

Details about an image

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

updateImage()

+ + 
updateImage() : void
+

Update informations about an image

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

deleteImage()

+ + 
deleteImage() : void
+

Delete an image

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

reactivateImage()

+ + 
reactivateImage() : void
+

Reactive an image

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

desactivateImage()

+ + 
desactivateImage() : void
+

Desactivaate an image

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

uploadImage()

+ + 
uploadImage() : void
+

Upload an image

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

downloadImage()

+ + 
downloadImage() : void
+

Download an image

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

addMemberImage()

+ + 
addMemberImage() : void
+

Add a member to image

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

listMemberImage()

+ + 
listMemberImage() : void
+

List members of an image

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

detailMemberImage()

+ + 
detailMemberImage() : void
+

Show details of a member of an image

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

removeMemberImage()

+ + 
removeMemberImage() : void
+

Remove a member of an image

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

updateMemberImage()

+ + 
updateMemberImage() : void
+

Update a member of an image

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/network.html b/server/doc/classes/network.html new file mode 100644 index 0000000..ab4d845 --- /dev/null +++ b/server/doc/classes/network.html @@ -0,0 +1,1191 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\network

+

Network Class of the back-end application

+

Management of Networks

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ create_network()
+ create_subnet()
+ list_network_ids()
+ list_network_names()
+ list_cidr()
+ getNetwork()
+ getNetworkP()
+ getSubnet()
+ getSubnetP()
+ updateNetwork()
+ updateSubnet()
+ deleteNetwork()
+ deleteSubnet()
+ createPort()
+ listPorts()
+ getPort()
+ getPortP()
+ updatePort()
+ deletePort()
+ createSecurityGroup()
+ createSecurityGroupRule()
+ listSecurityGroupe()
+ listSecurityGroupeRule()
+ getSecurityGroupe()
+ getSecurityGroupeP()
+ deleteSecurityGroupe()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ +
+
+ +
+

$libClass

+ 
$libClass : \OpenStack\Network
+

+ + +

Type

+ \OpenStack\Network + — protected, contains the library Network object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \network
+

Network constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \network + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

create_network()

+ + 
create_network() : void
+

Create a new network

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

create_subnet()

+ + 
create_subnet() : void
+

Create a new subnet

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

list_network_ids()

+ + 
list_network_ids() : void
+

List the ID of the NETWORKS

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

list_network_names()

+ + 
list_network_names() : \List
+

List the name of the NETWORKS

+ + + + +

Returns

+ \List + —

of Networks name

+ +
+
+ +
+ +
+
+ +
+

list_cidr()

+ + 
list_cidr() : void
+

List the CIDR of the SUBNETS

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

getNetwork()

+ + 
getNetwork() : void
+

retrieve a specific network

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

getNetworkP()

+ + 
getNetworkP(  $netId) : \OpenStack\Network
+

internal function

+ + +

Parameters

+ + + + + + +
$netId
+ + +

Returns

+ \OpenStack\Network + +
+
+ +
+ +
+
+ +
+

getSubnet()

+ + 
getSubnet() : void
+

retrieve a specific subnet

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

getSubnetP()

+ + 
getSubnetP(  $subnetId) : \OpenStack\Subnet
+

internal function

+ + +

Parameters

+ + + + + + +
$subnetId
+ + +

Returns

+ \OpenStack\Subnet + +
+
+ +
+ +
+
+ +
+

updateNetwork()

+ + 
updateNetwork() : void
+

Update a network given

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

updateSubnet()

+ + 
updateSubnet() : void
+

Update a subnet given

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

deleteNetwork()

+ + 
deleteNetwork() : void
+

Delete a network given

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

deleteSubnet()

+ + 
deleteSubnet() : void
+

Delete a subnet given

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

createPort()

+ + 
createPort() : void
+

Create a new port

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

listPorts()

+ + 
listPorts() : void
+

List the of ports

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

getPort()

+ + 
getPort() : void
+

retrieve a specific port given

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

getPortP()

+ + 
getPortP(  $portId) : \port
+

internal function

+

retrieve a specific port given

+ +

Parameters

+ + + + + + +
$portId
+ + +

Returns

+ \port + +
+
+ +
+ +
+
+ +
+

updatePort()

+ + 
updatePort() : void
+

Update port given

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

deletePort()

+ + 
deletePort() : void
+

Delete a port given

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

createSecurityGroup()

+ + 
createSecurityGroup() : void
+

Create a new security groupe

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

createSecurityGroupRule()

+ + 
createSecurityGroupRule() : void
+

Create a new security groupe

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

listSecurityGroupe()

+ + 
listSecurityGroupe() : void
+

List of Security Groupes

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

listSecurityGroupeRule()

+ + 
listSecurityGroupeRule() : void
+

List of Security Groupe Rules

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

getSecurityGroupe()

+ + 
getSecurityGroupe() : void
+

retrieve a specific Security Groupe given

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

getSecurityGroupeP()

+ + 
getSecurityGroupeP(  $securityGroupeId) : \securityGroup
+

internal function

+

retrieve a specific Security Groupe given

+ +

Parameters

+ + + + + + +
$securityGroupeId
+ + +

Returns

+ \securityGroup + +
+
+ +
+ +
+
+ +
+

deleteSecurityGroupe()

+ + 
deleteSecurityGroupe() : void
+

Delete a specific Security Groupe given

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/server/doc/classes/networkLayer3.html b/server/doc/classes/networkLayer3.html new file mode 100644 index 0000000..2b36a19 --- /dev/null +++ b/server/doc/classes/networkLayer3.html @@ -0,0 +1,743 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\networkLayer3

+

networkLayer3 Class of the back-end application

+

Management of networkLayer3

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ listFloatingIp()
+ createFloatingIp()
+ getFloatingIp()
+ updateFloatingIp()
+ deleteFloatingIp()
+ retrieveFloatingIp()
+ createRouter()
+ listRouters()
+ getRouter()
+ deleteRouter()
+ updateRouter()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ +
+
+ +
+

$libClass

+ 
$libClass : \OpenStack\NetworkLayer3
+

+ + +

Type

+ \OpenStack\NetworkLayer3 + — protected, contains the library NetworkLayer3 object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \networkLayer3
+

networkLayer3 constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \networkLayer3 + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

listFloatingIp()

+ + 
listFloatingIp() : void
+

List floatingip

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

createFloatingIp()

+ + 
createFloatingIp() : void
+

Create a new floating IP adress

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

getFloatingIp()

+ + 
getFloatingIp() : void
+

Show floatingip details

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

updateFloatingIp()

+ + 
updateFloatingIp() : void
+

Update floating ip

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

deleteFloatingIp()

+ + 
deleteFloatingIp() : void
+

Delete a floating ip

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

retrieveFloatingIp()

+ + 
retrieveFloatingIp() : void
+

Retrieve a floating ip

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

createRouter()

+ + 
createRouter() : void
+

Create a new router

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

listRouters()

+ + 
listRouters() : void
+

List routers

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

getRouter()

+ + 
getRouter() : void
+

Show router details

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

deleteRouter()

+ + 
deleteRouter() : void
+

Delete a router

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

updateRouter()

+ + 
updateRouter() : void
+

Update router

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