PFW: Add setDomainsXML command to import domains from string
BZ: 55694
Unable possibility to import the configurable domains from a string
Create one command that can be called through the command
line of the parameter-framework. The command setDomainXML
allows to import configurable domains with settings from
a string provided as first argument containing the xml description.
Change-Id: I6db7ccb8ba61b5e4c8ba81579a68f40e887d1534
Signed-off-by: Georges-Henri Baron <georges-henrix.baron@intel.com>
Reviewed-on: http://android.intel.com:8080/65408
Reviewed-by: cactus <cactus@intel.com>
Reviewed-by: Dixon, CharlesX <charlesx.dixon@intel.com>
Reviewed-by: Rocard, KevinX <kevinx.rocard@intel.com>
Tested-by: Dixon, CharlesX <charlesx.dixon@intel.com>
Reviewed-by: buildbot <buildbot@intel.com>
Tested-by: buildbot <buildbot@intel.com>
diff --git a/xmlserializer/XmlFileDocSource.h b/xmlserializer/XmlFileDocSource.h
index 46c5230..98ba6e3 100644
--- a/xmlserializer/XmlFileDocSource.h
+++ b/xmlserializer/XmlFileDocSource.h
@@ -1,6 +1,6 @@
/*
* INTEL CONFIDENTIAL
- * Copyright © 2011 Intel
+ * Copyright © 2013 Intel
* Corporation All Rights Reserved.
*
* The source code contained or described herein and all documents related to
@@ -18,49 +18,64 @@
* of the Materials, either expressly, by implication, inducement, estoppel or
* otherwise. Any license under such intellectual property rights must be
* express and approved by Intel in writing.
- *
- * CREATED: 2012-08-10
*/
#pragma once
-
#include "XmlDocSource.h"
-#include "XmlSource.h"
+#include <string>
-struct _xmlError;
-
+/**
+ * Source class that read a file to get an xml document.
+ * Its base class will validate the document.
+ */
class CXmlFileDocSource : public CXmlDocSource
{
public:
- CXmlFileDocSource(const string& strXmlInstanceFile, const string& strXmlSchemaFile, const string& strRootElementType, const string& strRootElementName, const string& strNameAttrituteName);
-
+ /**
+ * Constructor
+ *
+ * @param[in] strXmlInstanceFile a string containing the path to the xml file
+ * @param[in] strXmlSchemaFile a string containing the path to the schema file
+ * @param[in] strRootElementType a string containing the root element type
+ * @param[in] strRootElementName a string containing the root element name
+ * @param[in] strNameAttributeName a string containing the name of the root name attribute
+ */
+ CXmlFileDocSource(const string& strXmlInstanceFile,
+ const string& strXmlSchemaFile,
+ const string& strRootElementType,
+ const string& strRootElementName,
+ const string& strNameAttrituteName);
+ /**
+ * Constructor
+ *
+ * @param[in] strXmlInstanceFile a string containing the path to the xml file
+ * @param[in] strXmlSchemaFile a string containing the path to the schema file
+ * @param[in] strRootElementType a string containing the root element type
+ */
CXmlFileDocSource(const string& strXmlInstanceFile, const string& strXmlSchemaFile, const string& strRootElementType);
-
- // CXmlDocSource method implemented
+ /**
+ * CXmlDocSource method implementation.
+ *
+ * @param[out] serializingContext is used as error output
+ *
+ * @return false if any error occurs
+ */
virtual bool populate(CXmlSerializingContext& serializingContext);
- // Check that the file exists and is readable
+ /**
+ * Method that checks that the file exists and is readable.
+ *
+ * @param[out] serializingContext is used as error output
+ *
+ * @return false if any error occurs during the parsing
+ */
virtual bool isParsable(CXmlSerializingContext& serializingContext) const;
private:
- // Validation of the document with the xsd file
- bool isInstanceDocumentValid();
-
- static void schemaValidityStructuredErrorFunc(void* pUserData, _xmlError* pError);
-
- // Instance file
+ /**
+ * Instance file
+ */
string _strXmlInstanceFile;
- // Schema file
- string _strXmlSchemaFile;
- // Element type info
- string _strRootElementType;
- // Element name info
- string _strRootElementName;
- // Element name attribute info
- string _strNameAttrituteName;
-
- bool _bNameCheck;
-
};