parse

splunkjs.ModularInputs.ValidationDefinition.parse

Creates a ValidationDefinition from a provided string containing XML.

This function will throw an exception if str contains unexpected XML.

The XML typically will look like this

<items> <server_host>myHost</server_host> <server_uri>https://127.0.0.1:8089</server_uri>; <session_key>123102983109283019283</session_key> <checkpoint_dir>/opt/splunk/var/lib/splunk/modinputs</checkpoint_dir> <item name="myScheme"> <param name="param1">value1</param> <param_list name="param2"> <value>value2</value> <value>value3</value> <value>value4</value> </param_list> </item> </items>

Syntax

ValidationDefinition.parse = function(str)

Parameters

Name	Type	Description
str	String	A string containing XML to parse.

Source (lib/modularinputs/validationdefinition.js:62)

ValidationDefinition.parse = function(str) {
        var definition = new ValidationDefinition();
        var rootChildren = ET.parse(str).getroot().getchildren();

        for (var i = 0; i < rootChildren.length; i++) {
            var node = rootChildren[i];            
            if (node.tag === "item") {
                definition.metadata["name"] = node.get("name");
                definition.parameters = utils.parseXMLData(node, "");
            }
            else {
                definition.metadata[node.tag] = node.text;
            }
        }
        return definition;
    };
    
    module.exports = ValidationDefinition;
})();