dgbuilder/nodes/dge/dgelogic/execute.html

   1 <!--
   2   Copyright 2013 IBM Corp.
   3
   4   Licensed under the Apache License, Version 2.0 (the "License");
   5   you may not use this file except in compliance with the License.
   6   You may obtain a copy of the License at
   7
   8   http://www.apache.org/licenses/LICENSE-2.0
   9
  10   Unless required by applicable law or agreed to in writing, software
  11   distributed under the License is distributed on an "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   See the License for the specific language governing permissions and
  14   limitations under the License.
  15 -->
  16
  17 <script type="text/x-red" data-template-name="execute">
  18     <div class="form-row">
  19         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  20         <input type="text" id="node-input-name" placeholder="Name">
  21     </div>
  22     <div class="form-row">
  23         <label for="node-input-xml"><i class="fa fa-wrench"></i> Node XML</label>
  24         <input type="hidden" id="node-input-xml" autofocus="autofocus">
  25         <div style="height: 450px;" class="node-text-editor" id="node-input-xml-editor" onkeyup="resetStatus()" ></div>
  26     </div>
  27     <div class="form-row">
  28     <a href="#" class="btn btn-mini" id="node-input-validate" style="margin-top: 4px;"><b>Validate XML</b></a>
  29      <a href="#" class="btn btn-mini" id="node-input-show-sli-values" style="margin-top: 4px;"><b>Show Values</b></a>
  30     <input type="hidden" id="node-input-comments">
  31     <a href="#" class="btn btn-mini" id="node-input-btnComments" style="margin-top: 4px;"><b>Add Comments</b></a>
  32     <div id="node-validate-result" class="form-tips" style="float:right;font-size:10px"></div>
  33     </div>
  34     <div class="form-tips">See the Info tab for help using this node.</div>
  35 </script>
  36
  37 <script type="text/x-red" data-help-name="execute">
  38         <p>A execute node.</p>
  39         <p>Do not include closing tag - it will be automatically generated.</p>
  40         <div class="section">
  41 <h3><a name="Java_Plugin_Support"></a>Java Plugin Support</h3>
  42 <div class="section">
  43 <h4><a name="Execute_node"></a>Execute node</h4>
  44 <div class="section">
  45 <h5><a name="Description"></a>Description</h5>
  46 <p>An <b>execute</b> node is used to execute Java code supplied as a plugin</p></div>
  47 <div class="section">
  48 <h5><a name="Attributes"></a>Attributes</h5>
  49 <table border="1" class="table table-striped">
  50 <tr class="a">
  51 <td align="center"><b>plugin</b></td>
  52 <td align="left">Fully qualified Java class of plugin to be used</td></tr>
  53 <tr class="b">
  54 <td align="center"><b>method</b></td>
  55 <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>
  56 <div class="section">
  57 <h5><a name="Parameters"></a>Parameters</h5>
  58 <p>Specific to plugin / method</p></div>
  59 <div class="section">
  60 <h5><a name="Outcomes"></a>Outcomes</h5>
  61 <table border="1" class="table table-striped">
  62 <tr class="a">
  63 <td align="center"><b>success</b></td>
  64 <td align="left">Device successfully configured</td></tr>
  65 <tr class="b">
  66 <td align="center"><b>not-found</b></td>
  67 <td align="left">Plugin class could not be loaded</td></tr>
  68 <tr class="a">
  69 <td align="center"><b>unsupported-method</b></td>
  70 <td align="left">Named method taking (Map, SvcLogicContext) could not be found</td></tr>
  71 <tr class="b">
  72 <td align="center"><b>failure</b></td>
  73 <td align="left">Configure failed for some other reason</td></tr></table></div>
  74 <div class="section">
  75 <h5><a name="Example"></a>Example</h5>
  76 <div class="source">
  77 <pre>&lt;execute plugin=&quot;org.onap.ccsdk.sli.plugin.HelloWorld&quot;
  78            method=&quot;log&quot;&gt;
  79   &lt;parameter name=&quot;message&quot; value=&quot;Hello, world!&quot; /&gt;
  80   &lt;outcome value=&quot;success&quot;&gt;
  81       &lt;return status=&quot;success&quot;/&gt;
  82   &lt;/outcome&gt;
  83   &lt;outcome value=&quot;not-found&quot;&gt;
  84     &lt;return status=&quot;failure&quot;&gt;
  85       &lt;parameter name=&quot;error-code&quot; value=&quot;1590&quot; /&gt;
  86       &lt;parameter name=&quot;error-message&quot; value=&quot;Could not locate plugin&quot; /&gt;
  87     &lt;/return&gt;
  88   &lt;/outcome&gt;
  89   &lt;outcome value=&quot;Other&quot;&gt;
  90     &lt;return status=&quot;failure&quot;&gt;
  91       &lt;parameter name=&quot;error-code&quot; value=&quot;1542&quot; /&gt;
  92       &lt;parameter name=&quot;error-message&quot; value=&quot;Internal error&quot; /&gt;
  93     &lt;/return&gt;
  94   &lt;/outcome&gt;
  95 &lt;/execute&gt;</pre></div></div></div></div>
  96 </script>
  97
  98
  99 <script type="text/javascript">
 100     RED.nodes.registerType('execute',{
 101         color:"#fdd0a2",
 102         category: 'DGElogic',
 103         defaults: {
 104             name: {value:"execute"},
 105             xml: {value:"<execute plugin='' method='' >\n"},
 106             comments:{value:""},
 107             outputs: {value:1}
 108         },
 109         inputs:1,
 110         outputs:1,
 111         icon: "arrow-in.png",
 112         label: function() {
 113             return this.name;
 114         },
 115         oneditprepare: function() {
 116             var that = this;
 117             $( "#node-input-outputs" ).spinner({
 118                 min:1
 119             });
 120              var comments = $( "#node-input-comments").val();
 121              if(comments != null){
 122                 comments = comments.trim();
 123                 if(comments != ''){
 124                         $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
 125                 }
 126              }
 127
 128             function functionDialogResize() {
 129                 var rows = $("#dialog-form>div:not(.node-text-editor-row)");
 130                 var height = $("#dialog-form").height();
 131                 for (var i=0;i<rows.size();i++) {
 132                     height -= $(rows[i]).outerHeight(true);
 133                 }
 134                 var editorRow = $("#dialog-form>div.node-text-editor-row");
 135                 height -= (parseInt(editorRow.css("marginTop"))+parseInt(editorRow.css("marginBottom")));
 136                 $(".node-text-editor").css("height",height+"px");
 137                 that.editor.resize();
 138             };
 139             $( "#dialog" ).on("dialogresize", functionDialogResize);
 140             $( "#dialog" ).one("dialogopen", function(ev) {
 141                 var size = $( "#dialog" ).dialog('option','sizeCache-function');
 142                 if (size) {
 143                     $("#dialog").dialog('option','width',size.width);
 144                     $("#dialog").dialog('option','height',size.height);
 145                     functionDialogResize();
 146                 }
 147             });
 148             $( "#dialog" ).one("dialogclose", function(ev,ui) {
 149                 var height = $( "#dialog" ).dialog('option','height');
 150                 $( "#dialog" ).off("dialogresize",functionDialogResize);
 151             });
 152
 153             this.editor = RED.editor.createEditor({
 154                 id: 'node-input-xml-editor',
 155                 mode: 'ace/mode/html'
 156             });
 157             this.editor.setValue($("#node-input-xml").val(),-1);
 158         /*
 159             RED.library.create({
 160                 url:"functions", // where to get the data from
 161                 type:"function", // the type of object the library is for
 162                 editor:this.editor, // the field name the main text body goes to
 163                 mode:"ace/mode/html",
 164                 fields:['name','outputs']
 165             });
 166         */
 167             this.editor.focus();
 168             /* close dialog when ESC is pressed and released */
 169             $( "#node-input-xml-editor" ).keyup(function(event){
 170                 if(event.which == 27 ) {
 171                         $("#node-dialog-cancel").click();
 172                 }
 173             });
 174                 $("#node-input-validate").click(function(){
 175                                 console.log("validate clicked.");
 176                                 //console.dir(that.editor);
 177                                 //console.log("getText:" + that.editor.getText());
 178                                 var val = that.editor.getValue();
 179                                 validateXML(val);
 180                 });
 181                 $("#node-input-show-sli-values").click(function(){
 182                         //console.log("show Values clicked.");
 183                         showValuesBox(that.editor,sliValuesObj);
 184                 });
 185             //for click of add comments button
 186             $("#node-input-btnComments").click(function(e){
 187                         showCommentsBox();
 188             });
 189         },
 190         oneditsave: function() {
 191             $("#node-input-xml").val(this.editor.getValue());
 192                 var resp=validateXML(this.editor.getValue());
 193                 if(resp){
 194                         this.status = {fill:"green",shape:"dot",text:"OK"};
 195                 }else{
 196                         this.status = {fill:"red",shape:"dot",text:"ERROR"};
 197                 }
 198                 delete this.editor;
 199         }
 200     });
 201 </script>