2013-12-12 22:08:59 +04:00
/* ------------------------------------------------------------------------ */
2015-09-23 16:03:22 +03:00
/* Copyright 2002-2015, 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_H_
# define ZONE_H_
# include "PoolObjectSQL.h"
2014-01-13 21:26:21 +04:00
# include "NebulaLog.h"
2013-12-12 22:08:59 +04:00
using namespace std ;
/**
* The Zone class .
*/
class Zone : public PoolObjectSQL
{
public :
/**
* Function to print the Zone object into a string in XML format
* @ param xml the resulting XML string
* @ return a reference to the generated string
*/
string & to_xml ( string & xml ) const ;
/**
* Rebuilds the object from an xml formatted string
* @ param xml_str The xml - formatted string
*
* @ return 0 on success , - 1 otherwise
*/
int from_xml ( const string & xml_str ) ;
private :
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
friend class ZonePool ;
// *************************************************************************
// Constructor
// *************************************************************************
Zone ( int id , Template * zone_template ) ;
~ Zone ( ) ;
// *************************************************************************
// DataBase implementation (Private)
// *************************************************************************
static const char * db_names ;
static const char * db_bootstrap ;
static const char * table ;
/**
* Execute an INSERT or REPLACE Sql query .
* @ param db The SQL DB
* @ param replace Execute an INSERT or a REPLACE
* @ param error_str Returns the error reason , if any
* @ return 0 one success
*/
int insert_replace ( SqlDB * db , bool replace , string & error_str ) ;
/**
* Bootstraps the database table ( s ) associated to the Zone
* @ return 0 on success
*/
static int bootstrap ( SqlDB * db )
{
ostringstream oss ( Zone : : db_bootstrap ) ;
return db - > exec ( oss ) ;
} ;
/**
* Writes the Zone in the database .
* @ param db pointer to the db
* @ return 0 on success
*/
int insert ( SqlDB * db , string & error_str ) ;
/**
* Writes / updates the Zone ' s data fields in the database .
* @ param db pointer to the db
* @ return 0 on success
*/
int update ( SqlDB * db )
{
string error_str ;
return insert_replace ( db , true , error_str ) ;
}
2014-01-13 21:26:21 +04:00
/**
* Factory method for Zone templates
*/
Template * get_new_template ( ) const
{
return new Template ;
2014-01-24 03:26:44 +04:00
}
2014-10-20 18:05:44 +04:00
/**
* Child classes can process the new template set with replace_template or
* append_template with this method
* @ param error string describing the error if any
* @ return 0 on success
*/
int post_update_template ( string & error ) ;
2013-12-12 22:08:59 +04:00
} ;
# endif /*ZONE_H_*/