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

229 lines
6.2 KiB
C
Raw Normal View History

2013-12-12 22:08:59 +04:00
/* ------------------------------------------------------------------------ */
2023-01-09 14:23:19 +03:00
/* Copyright 2002-2023, 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"
class ZoneServers;
class ZoneServer;
2013-12-12 22:08:59 +04:00
/**
* The Zone class.
*/
class Zone : public PoolObjectSQL
{
public:
enum ZoneState
{
ENABLED = 0, /**< Enabled */
DISABLED = 1, /**< Disabled, only read-only commmands are executed */
};
/**
* Functions to convert to/from string the Zone states
*/
static int str_to_state(std::string& st, ZoneState& state)
{
one_util::toupper(st);
state = ENABLED;
if ( st == "ENABLED" ) {
state = ENABLED;
} else if ( st == "DISABLED" ) {
state = DISABLED;
}
else
{
return -1;
}
return 0;
}
static std::string state_to_str(ZoneState state)
{
std::string st = "";
switch (state)
{
case ENABLED:
st = "ENABLED";
break;
case DISABLED:
st = "DISABLED";
break;
}
return st;
}
virtual ~Zone();
2013-12-12 22:08:59 +04:00
/**
* 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
*/
std::string& to_xml(std::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 std::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,
std::string& xmlep, std::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, std::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) const;
/**
* @return the number of servers in this zone
*/
unsigned int servers_size() const;
ZoneState get_state() const
{
return state;
}
/**
* Enable the zone
*/
void enable()
{
state = ENABLED;
}
/**
* Disable the zone, only read_only commands are allowed
*/
void disable()
{
state = DISABLED;
}
2013-12-12 22:08:59 +04:00
private:
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
friend class ZonePool;
// -------------------------------------------------------------------------
2013-12-12 22:08:59 +04:00
// Constructor
// -------------------------------------------------------------------------
Zone(int id, std::unique_ptr<Template> zone_template);
2013-12-12 22:08:59 +04:00
ZoneState state;
// -------------------------------------------------------------------------
// 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, std::string& error_str);
2013-12-12 22:08:59 +04:00
/**
* 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, std::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
{
std::string error_str;
2013-12-12 22:08:59 +04:00
return insert_replace(db, true, error_str);
}
/**
* Factory method for Zone templates
*/
std::unique_ptr<Template> get_new_template() const override
{
return std::make_unique<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(std::string& error) override;
2013-12-12 22:08:59 +04:00
};
#endif /*ZONE_H_*/