1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-22 13:33:52 +03:00
one/include/Zone.h

163 lines
4.9 KiB
C
Raw Normal View History

2013-12-12 22:08:59 +04:00
/* ------------------------------------------------------------------------ */
2020-04-30 16:00:02 +03:00
/* Copyright 2002-2020, 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"
#include "NebulaLog.h"
2013-12-12 22:08:59 +04:00
using namespace std;
class ZoneServers;
class ZoneServer;
2013-12-12 22:08:59 +04:00
/**
* 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 override;
2013-12-12 22:08:59 +04:00
/**
* 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) override;
2013-12-12 22:08:59 +04:00
2017-04-11 22:34:38 +03:00
/**
* Add servers to this zone
* @param tmpl with SERVER definitions
* @param sid id of the new sever
* @param xmlep endpoint of the new server
2017-04-11 22:34:38 +03:00
* @param error
*
* @return 0 on success, -1 otherwise
*/
int add_server(Template& tmpl, int& sid, string& xmlep, string& error);
2017-04-13 19:31:14 +03:00
/**
* Delete a server from this zone
* @param it of the SERVER
* @param error if any
*
* @return 0 on success, -1 otherwise
*/
int delete_server(int id, string& error);
2017-04-11 22:34:38 +03:00
/**
* @return the servers in this zone
*/
ZoneServers * get_servers()
{
return servers;
}
/**
* @param server_id
* @return the server
*/
ZoneServer * get_server(int server_id);
/**
* @return the number of servers in this zone
*/
unsigned int servers_size();
2013-12-12 22:08:59 +04:00
private:
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
friend class ZonePool;
// -------------------------------------------------------------------------
2013-12-12 22:08:59 +04:00
// Constructor
// -------------------------------------------------------------------------
2013-12-12 22:08:59 +04:00
Zone(int id, Template* zone_template);
virtual ~Zone();
2013-12-12 22:08:59 +04:00
// -------------------------------------------------------------------------
// Zone servers
// -------------------------------------------------------------------------
Template servers_template;
ZoneServers * servers;
2013-12-12 22:08:59 +04:00
// -------------------------------------------------------------------------
// DataBase implementation (Private)
// -------------------------------------------------------------------------
2013-12-12 22:08:59 +04:00
/**
* 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);
2013-12-12 22:08:59 +04:00
/**
* Writes the Zone in the database.
* @param db pointer to the db
* @return 0 on success
*/
int insert(SqlDB *db, string& error_str) override;
2013-12-12 22:08:59 +04:00
/**
* Writes/updates the Zone's data fields in the database.
* @param db pointer to the db
* @return 0 on success
*/
int update(SqlDB *db) override
2013-12-12 22:08:59 +04:00
{
string error_str;
return insert_replace(db, true, error_str);
}
/**
* Factory method for Zone templates
*/
Template * get_new_template() const override
{
return new Template;
2014-01-24 03:26: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) override;
2013-12-12 22:08:59 +04:00
};
#endif /*ZONE_H_*/