2011-03-30 21:03:49 +04:00
/* -------------------------------------------------------------------------- */
2018-01-02 20:27:37 +03:00
/* Copyright 2002-2018, OpenNebula Project, OpenNebula Systems */
2011-03-30 21:03:49 +04:00
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); you may */
/* not use this file except in compliance with the License. You may obtain */
/* a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* -------------------------------------------------------------------------- */
# ifndef VMTEMPLATE_POOL_H_
# define VMTEMPLATE_POOL_H_
# include "PoolSQL.h"
# include "VMTemplate.h"
/**
* The VMTemplate Pool class .
*/
class VMTemplatePool : public PoolSQL
{
public :
2017-06-21 04:22:56 +03:00
VMTemplatePool ( SqlDB * db ) : PoolSQL ( db , VMTemplate : : table ) { } ;
2011-03-30 21:03:49 +04:00
~ VMTemplatePool ( ) { } ;
/**
* Allocates a new object , writting it in the pool database . No memory is
* allocated for the object .
* @ param uid user id ( the owner of the Template )
Feature #407: Add 'GID' attribute to some pool objects; change *pool.info XML-RPC flag meaning; update onedb migrator; fix tests.
* VM, VMTEMPLATE, VNET & IMAGE objects have a GID attribute, and a table column. The group id is inherited from the user creating the object, except for VMs created from Templates, that inherit the Template's group.
* The new flag meaning has been modified in src/rm sources and CLI commands for one.(vm,template,vnet,image)pool.info . It changes from
-2 all, -1 mine & public, >=0 UID
to
-3 mine, -2 all, -1 mine & group
* USER has a group, but not secondary ones. The user_pool table doesn't have a GID column, we'll deal with it later when the group-users relations are implemented.
* onedb migrator 1.rb: deleted USERNAME, and GID added.
2011-05-16 19:00:27 +04:00
* @ param gid the id of the group this object is assigned to
2013-01-18 21:34:51 +04:00
* @ param uname user name
* @ param gname group name
* @ param umask permissions umask
2011-03-30 21:03:49 +04:00
* @ param template_contents a VM Template object
* @ param oid the id assigned to the Template
* @ param error_str Returns the error reason , if any
*
* @ return the oid assigned to the object , - 1 in case of failure
*/
int allocate ( int uid ,
Feature #407: Add 'GID' attribute to some pool objects; change *pool.info XML-RPC flag meaning; update onedb migrator; fix tests.
* VM, VMTEMPLATE, VNET & IMAGE objects have a GID attribute, and a table column. The group id is inherited from the user creating the object, except for VMs created from Templates, that inherit the Template's group.
* The new flag meaning has been modified in src/rm sources and CLI commands for one.(vm,template,vnet,image)pool.info . It changes from
-2 all, -1 mine & public, >=0 UID
to
-3 mine, -2 all, -1 mine & group
* USER has a group, but not secondary ones. The user_pool table doesn't have a GID column, we'll deal with it later when the group-users relations are implemented.
* onedb migrator 1.rb: deleted USERNAME, and GID added.
2011-05-16 19:00:27 +04:00
int gid ,
2011-06-30 13:31:00 +04:00
const string & uname ,
const string & gname ,
2013-01-18 21:34:51 +04:00
int umask ,
2011-03-30 21:03:49 +04:00
VirtualMachineTemplate * template_contents ,
int * oid ,
string & error_str ) ;
/**
* Gets an object from the pool ( if needed the object is loaded from the
* database ) .
* @ param oid the object unique identifier
* @ param lock locks the object if true
*
* @ return a pointer to the object , 0 in case of failure
*/
2018-03-18 01:31:52 +03:00
VMTemplate * get ( int oid )
2011-03-30 21:03:49 +04:00
{
2018-03-18 01:31:52 +03:00
return static_cast < VMTemplate * > ( PoolSQL : : get ( oid ) ) ;
2011-03-30 21:03:49 +04:00
} ;
/**
* Dumps the pool in XML format . A filter can be also added to the
* query
* @ param oss the output stream to dump the pool contents
* @ param where filter for the objects , defaults to all
2014-01-13 19:30:43 +04:00
* @ param limit parameters used for pagination
2018-07-24 12:41:41 +03:00
* @ param desc descending order of pool elements
2011-03-30 21:03:49 +04:00
*
* @ return 0 on success
*/
2018-07-24 12:41:41 +03:00
int dump ( ostringstream & oss , const string & where , const string & limit ,
bool desc )
2011-03-30 21:03:49 +04:00
{
2014-01-13 19:30:43 +04:00
return PoolSQL : : dump ( oss , " VMTEMPLATE_POOL " , VMTemplate : : table , where ,
2018-07-24 12:41:41 +03:00
limit , desc ) ;
2011-03-30 21:03:49 +04:00
} ;
/**
* Bootstraps the database table ( s ) associated to the pool
2011-10-10 17:14:46 +04:00
* @ return 0 on success
2011-03-30 21:03:49 +04:00
*/
2011-10-10 17:14:46 +04:00
static int bootstrap ( SqlDB * _db )
2011-03-30 21:03:49 +04:00
{
2011-10-10 17:14:46 +04:00
return VMTemplate : : bootstrap ( _db ) ;
2011-03-30 21:03:49 +04:00
} ;
private :
/**
* Factory method to produce Image objects
* @ return a pointer to the new Image
*/
PoolObjectSQL * create ( )
{
2013-01-18 21:34:51 +04:00
return new VMTemplate ( - 1 , - 1 , - 1 , " " , " " , 0 , 0 ) ;
2011-03-30 21:03:49 +04:00
} ;
} ;
# endif /*VMTEMPLATE_POOL_H_*/