dgbuilder/nodes/dge/dgelogic/execute.html

<!--
  Copyright 2013 IBM Corp.

  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.
-->

<script type="text/x-red" data-template-name="execute">
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-xml"><i class="fa fa-wrench"></i> Node XML</label>
        <input type="hidden" id="node-input-xml" autofocus="autofocus">
        <div style="height: 450px;" class="node-text-editor" id="node-input-xml-editor" onkeyup="resetStatus()" ></div>
    </div>
    <div class="form-row">
    <a href="#" class="btn btn-mini" id="node-input-validate" style="margin-top: 4px;"><b>Validate XML</b></a>
     <a href="#" class="btn btn-mini" id="node-input-show-sli-values" style="margin-top: 4px;"><b>Show Values</b></a> 
    <input type="hidden" id="node-input-comments">
    <a href="#" class="btn btn-mini" id="node-input-btnComments" style="margin-top: 4px;"><b>Add Comments</b></a>
    <div id="node-validate-result" class="form-tips" style="float:right;font-size:10px"></div>
    </div>
    <div class="form-tips">See the Info tab for help using this node.</div>
</script>

<script type="text/x-red" data-help-name="execute">
	<p>A execute node.</p>
	<p>Do not include closing tag - it will be automatically generated.</p>
	<div class="section">
<h3><a name="Java_Plugin_Support"></a>Java Plugin Support</h3>
<div class="section">
<h4><a name="Execute_node"></a>Execute node</h4>
<div class="section">
<h5><a name="Description"></a>Description</h5>
<p>An <b>execute</b> node is used to execute Java code supplied as a plugin</p></div>
<div class="section">
<h5><a name="Attributes"></a>Attributes</h5>
<table border="1" class="table table-striped">
<tr class="a">
<td align="center"><b>plugin</b></td>
<td align="left">Fully qualified Java class of plugin to be used</td></tr>
<tr class="b">
<td align="center"><b>method</b></td>
<td align="left">Name of method in the plugin class to execute. Method must return void, and take 2 arguments: a Map (for parameters) and a SvcLogicContext (to allow plugin read/write access to context memory)</td></tr></table></div>
<div class="section">
<h5><a name="Parameters"></a>Parameters</h5>
<p>Specific to plugin / method</p></div>
<div class="section">
<h5><a name="Outcomes"></a>Outcomes</h5>
<table border="1" class="table table-striped">
<tr class="a">
<td align="center"><b>success</b></td>
<td align="left">Device successfully configured</td></tr>
<tr class="b">
<td align="center"><b>not-found</b></td>
<td align="left">Plugin class could not be loaded</td></tr>
<tr class="a">
<td align="center"><b>unsupported-method</b></td>
<td align="left">Named method taking (Map, SvcLogicContext) could not be found</td></tr>
<tr class="b">
<td align="center"><b>failure</b></td>
<td align="left">Configure failed for some other reason</td></tr></table></div>
<div class="section">
<h5><a name="Example"></a>Example</h5>
<div class="source">
<pre>&lt;execute plugin=&quot;org.onap.ccsdk.sli.plugin.HelloWorld&quot;
           method=&quot;log&quot;&gt;
  &lt;parameter name=&quot;message&quot; value=&quot;Hello, world!&quot; /&gt;
  &lt;outcome value=&quot;success&quot;&gt;
      &lt;return status=&quot;success&quot;/&gt;
  &lt;/outcome&gt;
  &lt;outcome value=&quot;not-found&quot;&gt;
    &lt;return status=&quot;failure&quot;&gt;
      &lt;parameter name=&quot;error-code&quot; value=&quot;1590&quot; /&gt;
      &lt;parameter name=&quot;error-message&quot; value=&quot;Could not locate plugin&quot; /&gt;
    &lt;/return&gt;
  &lt;/outcome&gt;
  &lt;outcome value=&quot;Other&quot;&gt;
    &lt;return status=&quot;failure&quot;&gt;
      &lt;parameter name=&quot;error-code&quot; value=&quot;1542&quot; /&gt;
      &lt;parameter name=&quot;error-message&quot; value=&quot;Internal error&quot; /&gt;
    &lt;/return&gt;
  &lt;/outcome&gt;
&lt;/execute&gt;</pre></div></div></div></div>
</script>


<script type="text/javascript">
    RED.nodes.registerType('execute',{
        color:"#fdd0a2",
        category: 'DGElogic',
        defaults: {
            name: {value:"execute"},
            xml: {value:"<execute plugin='' method='' >\n"},
	    comments:{value:""},	
            outputs: {value:1}
        },
        inputs:1,
        outputs:1,
        icon: "arrow-in.png",
        label: function() {
            return this.name;
        },
        oneditprepare: function() {
            $( "#node-input-outputs" ).spinner({
                min:1
            });

	     var comments = $( "#node-input-comments").val();
	     if(comments != null){
		comments = comments.trim();
		if(comments != ''){
			$("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
		}
	     }


            function functionDialogResize(ev,ui) {
                $("#node-input-xml-editor").css("height",(ui.size.height-275)+"px");
            };

            $( "#dialog" ).dialog( "option", "width", 1200 );
            $( "#dialog" ).dialog( "option", "height", 750 );
            $( "#dialog" ).on("dialogresize", functionDialogResize);
            $( "#dialog" ).one("dialogopen", function(ev) {
                var size = $( "#dialog" ).dialog('option','sizeCache-function');
                if (size) {
                    functionDialogResize(null,{size:size});
                }
            });

	    /* close dialog when ESC is pressed and released */	
            $( "#dialog" ).keyup(function(event){
     		if(event.which == 27 ) {
            		$("#node-dialog-cancel").click();
		}
 	    }); 

            $( "#dialog" ).one("dialogclose", function(ev,ui) {
                var height = $( "#dialog" ).dialog('option','height');
                $( "#dialog" ).off("dialogresize",functionDialogResize);
            });
            var that = this;
            require(["orion/editor/edit"], function(edit) {
                that.editor = edit({
                    parent:document.getElementById('node-input-xml-editor'),
                    lang:"html",
                    contents: $("#node-input-xml").val()
                });
                RED.library.create({
                    url:"functions", // where to get the data from
                    type:"function", // the type of object the library is for
                    editor:that.editor, // the field name the main text body goes to
                    fields:['name','outputs']
                });
                $("#node-input-name").focus();
		$("#node-input-validate").click(function(){
				console.log("validate clicked.");
				//console.dir(that.editor);
				//console.log("getText:" + that.editor.getText());
				var val = that.editor.getText();
				validateXML(val); 
		});
		$("#node-input-show-sli-values").click(function(){
				console.log("SLIValues clicked.");
				showValuesBox(that.editor,sliValuesObj);
		});

            });
	    //for click of add comments button
	    $("#node-input-btnComments").click(function(e){
			showCommentsBox();
	    });	
        },
        oneditsave: function() {
            $("#node-input-xml").val(this.editor.getText());
		var resp=validateXML(this.editor.getText());
		if(resp){
			this.status = {fill:"green",shape:"dot",text:"OK"};
		}else{
			this.status = {fill:"red",shape:"dot",text:"ERROR"};
		}	
           	delete this.editor;
        }
    });
</script>