2013-12-12 22:08:59 +04:00
/* -------------------------------------------------------------------------- */
2019-01-16 13:27:59 +03:00
/* Copyright 2002-2019, OpenNebula Project, OpenNebula Systems */
2013-12-12 22:08:59 +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 ZONE_POOL_H_
# define ZONE_POOL_H_
# include "PoolSQL.h"
# include "Zone.h"
using namespace std ;
class ZonePool : public PoolSQL
{
public :
2014-01-24 21:27:36 +04:00
ZonePool ( SqlDB * db ,
2014-02-05 22:30:35 +04:00
bool is_federation_slave ) ;
2013-12-12 22:08:59 +04:00
~ ZonePool ( ) { } ;
/* ---------------------------------------------------------------------- */
/* Methods for DB management */
/* ---------------------------------------------------------------------- */
/**
* Allocates a new Zone , writing it in the pool database . No memory is
* allocated for the object .
* @ param zone_template a Template object
* @ param oid the id assigned to the Zone
* @ param error_str Returns the error reason , if any
*
* @ return the oid assigned to the object , - 1 in case of failure
*/
int allocate ( Template * zone_template ,
int * oid ,
string & error_str ) ;
/**
* Function to get a Zone from the pool , if the object is not in memory
* it is loaded from the DB
* @ param oid Zone unique id
* @ param lock locks the Zone mutex
* @ return a pointer to the Zone , 0 if the Zone could not be loaded
*/
2018-03-18 01:31:52 +03:00
Zone * get ( int oid )
2013-12-12 22:08:59 +04:00
{
2018-03-18 01:31:52 +03:00
return static_cast < Zone * > ( PoolSQL : : get ( oid ) ) ;
2013-12-12 22:08:59 +04:00
} ;
/** Update a particular Zone
* @ param zone pointer to Zone
* @ return 0 on success
*/
2015-12-10 17:39:23 +03:00
int update ( PoolObjectSQL * objsql ) ;
2013-12-12 22:08:59 +04:00
/**
* Drops the Zone from the data base . The object mutex SHOULD be
* locked .
* @ param objsql a pointer to a Zone object
* @ param error_msg Error reason , if any
* @ return 0 on success ,
* - 1 DB error ,
* - 2 object is a default Zone ( ID < 100 )
*/
int drop ( PoolObjectSQL * objsql , string & error_msg ) ;
/**
* Bootstraps the database table ( s ) associated to the Zone pool
* @ return 0 on success
*/
static int bootstrap ( SqlDB * _db )
{
return Zone : : bootstrap ( _db ) ;
} ;
/**
* Dumps the Zone 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-23 20:07:52 +04:00
* @ param limit parameters used for pagination
2018-07-24 12:41:41 +03:00
* @ param desc descending order of pool elements
2013-12-12 22:08:59 +04:00
*
* @ return 0 on success
*/
2018-10-09 12:05:08 +03:00
int dump ( string & oss , const string & where , const string & limit ,
2018-07-24 12:41:41 +03:00
bool desc )
2013-12-12 22:08:59 +04:00
{
2018-10-09 12:05:08 +03:00
return PoolSQL : : dump ( oss , " ZONE_POOL " , " body " , Zone : : table , where , limit , desc ) ;
2013-12-12 22:08:59 +04:00
} ;
2017-05-16 13:01:06 +03:00
/**
* Get the servers of a zone
* @ param zone_id of the zone
* @ param _serv list of servers and associated xml - rpc endpoints
* @ return the number of servers in the zone
*/
2017-05-16 18:08:24 +03:00
unsigned int get_zone_servers ( int zone_id , std : : map < int , std : : string > & srv ) ;
2017-05-16 13:01:06 +03:00
/**
* Return the list of zones defined
* @ param zone_ids of the zones
* @ return 0 on success
*/
int list_zones ( vector < int > & zone_ids )
{
return list ( zone_ids , Zone : : table ) ;
}
2014-01-28 21:20:59 +04:00
/**
* ID for the special local zone in stand - alone mode
*/
static const int STANDALONE_ZONE_ID ;
2017-04-30 20:56:47 +03:00
2013-12-12 22:08:59 +04:00
private :
/**
* Factory method to produce objects
* @ return a pointer to the new object
*/
PoolObjectSQL * create ( )
{
return new Zone ( - 1 , 0 ) ;
} ;
} ;
# endif /*ZONE_POOL_H_*/