softwarecontainer  0.18.0-739e8d7 2017-05-04
filegatewaysettingstore.h
1 /*
2  * Copyright (C) 2016-2017 Pelagicore AB
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
9  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
10  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
11  * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
12  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
13  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
14  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
15  * SOFTWARE.
16  *
17  * For further information see LICENSE
18  */
19 
20 #pragma once
21 
22 #include "filegatewayparser.h"
23 
24 namespace softwarecontainer {
25 
27 {
28  LOG_DECLARE_CLASS_CONTEXT("FGWR", "File Gateway Rule Engine");
29 
30 public:
31  /*
32  * @brief Construct a new empty setting store
33  */
35 
36  /*
37  * @brief Destruct the setting store
38  */
40 
41  /*
42  * @brief Add a new setting to the store
43  *
44  * @param setting the file setting to be added
45  * @return false if the setting conflicts with any existing settings
46  * @return true otherwise
47  */
48  bool addSetting(const FileGatewayParser::FileSetting &setting);
49 
50  /*
51  * @brief Get the list of settings
52  *
53  * @return A list of well-formed file settings, ready to be applied
54  */
55  const std::vector<FileGatewayParser::FileSetting> &getSettings();
56 
57 private:
58  // The internal storage of settings
59  std::vector<FileGatewayParser::FileSetting> m_settings;
60 };
61 
62 } // namespace softwarecontainer
Developers guide to adding a config item: