mirror of
https://github.com/OpenNebula/one.git
synced 2025-01-21 18:03:38 +03:00
82 lines
2.8 KiB
C++
82 lines
2.8 KiB
C++
/* -------------------------------------------------------------------------- */
|
|
/* Copyright 2002-2022, OpenNebula Project, OpenNebula Systems */
|
|
/* */
|
|
/* 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 NEBULA_TEMPLATE_H_
|
|
#define NEBULA_TEMPLATE_H_
|
|
|
|
#include "Template.h"
|
|
|
|
#include <map>
|
|
|
|
/**
|
|
* This class provides the basic abstraction for OpenNebula configuration files
|
|
*/
|
|
class NebulaTemplate : public Template
|
|
{
|
|
public:
|
|
NebulaTemplate(const std::string& etc_location, const char * _conf_name,
|
|
const char * root_name)
|
|
: Template(false, '=', root_name)
|
|
, conf_file(etc_location + _conf_name)
|
|
, hidden_attributes{ { "DB", { "PASSWD" } } }
|
|
{
|
|
}
|
|
|
|
virtual ~NebulaTemplate() = default;
|
|
|
|
/**
|
|
* Parse and loads the configuration in the template
|
|
*/
|
|
virtual int load_configuration();
|
|
|
|
std::string& to_str(std::string& str) const override;
|
|
|
|
protected:
|
|
/**
|
|
* Full path to the configuration file
|
|
*/
|
|
std::string conf_file;
|
|
|
|
/**
|
|
* Defaults for the configuration file
|
|
*/
|
|
std::multimap<std::string, Attribute*> conf_default;
|
|
|
|
/**
|
|
* Hidden attributes, which shouldn't be displayed to non-admin users
|
|
* For Simple attributes use { "PORT". {} }
|
|
* For Vector attributes use { "DB", { "USER", "PASSWD"} }
|
|
*/
|
|
std::map<std::string, std::set<std::string>> hidden_attributes;
|
|
|
|
/**
|
|
* Sets the defaults value for the template
|
|
*/
|
|
virtual void set_conf_default() = 0;
|
|
|
|
/**
|
|
* Sets the defaults value for multiple attributes
|
|
*/
|
|
virtual void set_multiple_conf_default() = 0;
|
|
|
|
/**
|
|
* Sets a default single attribute value
|
|
*/
|
|
void set_conf_single(const std::string& attr, const std::string& value);
|
|
};
|
|
|
|
#endif /*NEBULA_TEMPLATE_H_*/
|