dgbuilder/nodes/dge/dgelogic/notify.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="notify">
  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="notify">
  38         <p>A notify node.</p>
  39         <p>Do not include closing tag - it will be automatically generated.</p>
  40 <!--
  41 <div class="section">
  42 <h5><a name="Description"></a>Description</h5>
  43 <p>An <b>notify</b> node is used to execute Java code supplied as a plugin</p></div>
  44 <div class="section">
  45 <h5><a name="Attributes"></a>Attributes</h5>
  46 <table border="1" class="table table-striped">
  47 <tr class="a">
  48 <td align="center"><b>plugin</b></td>
  49 <td align="left">Fully qualified Java class of plugin to be used</td></tr>
  50 <tr class="b">
  51 <td align="center"><b>method</b></td>
  52 <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>
  53 <div class="section">
  54 <h5><a name="Parameters"></a>Parameters</h5>
  55 <p>Specific to plugin / method</p></div>
  56 <div class="section">
  57 <h5><a name="Outcomes"></a>Outcomes</h5>
  58 <table border="1" class="table table-striped">
  59 <tr class="a">
  60 <td align="center"><b>success</b></td>
  61 <td align="left">Device successfully configured</td></tr>
  62 <tr class="b">
  63 <td align="center"><b>not-found</b></td>
  64 <td align="left">Plugin class could not be loaded</td></tr>
  65 <tr class="a">
  66 <td align="center"><b>unsupported-method</b></td>
  67 <td align="left">Named method taking (Map, SvcLogicContext) could not be found</td></tr>
  68 <tr class="b">
  69 <td align="center"><b>failure</b></td>
  70 <td align="left">Configure failed for some other reason</td></tr></table></div>
  71 <div class="section">
  72 <h5><a name="Example"></a>Example</h5>
  73 <div class="source">
  74 <pre>&lt;notify plugin=&quot;org.onap.ccsdk.sli.resource.samplesvc.SampleServiceResource&quot;
  75             resource=&quot;network-connection&quot; action=&quot;DELETE&quot; &gt;
  76   &lt;parameter name=&quot;message&quot; value=&quot;Hello, world!&quot; /&gt;
  77   &lt;outcome value=&quot;success&quot;&gt;
  78       &lt;return status=&quot;success&quot;/&gt;
  79   &lt;/outcome&gt;
  80   &lt;outcome value=&quot;not-found&quot;&gt;
  81     &lt;return status=&quot;failure&quot;&gt;
  82       &lt;parameter name=&quot;error-code&quot; value=&quot;1590&quot; /&gt;
  83       &lt;parameter name=&quot;error-message&quot; value=&quot;Could not locate plugin&quot; /&gt;
  84     &lt;/return&gt;
  85   &lt;/outcome&gt;
  86   &lt;outcome value=&quot;Other&quot;&gt;
  87     &lt;return status=&quot;failure&quot;&gt;
  88       &lt;parameter name=&quot;error-code&quot; value=&quot;1542&quot; /&gt;
  89       &lt;parameter name=&quot;error-message&quot; value=&quot;Internal error&quot; /&gt;
  90     &lt;/return&gt;
  91   &lt;/outcome&gt;
  92 &lt;/notify&gt;</pre></div></div></div></div>
  93 -->
  94 </script>
  95
  96
  97 <script type="text/javascript">
  98     RED.nodes.registerType('notify',{
  99         color:"#fdd0a2",
 100         category: 'DGElogic',
 101         defaults: {
 102             name: {value:"notify"},
 103             xml: {value:"<notify plugin='' resource='' action='' >\n"},
 104             comments:{value:""},
 105             outputs: {value:1}
 106         },
 107         inputs:1,
 108         outputs:1,
 109         icon: "arrow-in.png",
 110         label: function() {
 111             return this.name;
 112         },
 113         oneditprepare: function() {
 114             var that = this;
 115             $( "#node-input-outputs" ).spinner({
 116                 min:1
 117             });
 118              var comments = $( "#node-input-comments").val();
 119              if(comments != null){
 120                 comments = comments.trim();
 121                 if(comments != ''){
 122                         $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
 123                 }
 124              }
 125
 126             function functionDialogResize() {
 127                 var rows = $("#dialog-form>div:not(.node-text-editor-row)");
 128                 var height = $("#dialog-form").height();
 129                 for (var i=0;i<rows.size();i++) {
 130                     height -= $(rows[i]).outerHeight(true);
 131                 }
 132                 var editorRow = $("#dialog-form>div.node-text-editor-row");
 133                 height -= (parseInt(editorRow.css("marginTop"))+parseInt(editorRow.css("marginBottom")));
 134                 $(".node-text-editor").css("height",height+"px");
 135                 that.editor.resize();
 136             };
 137             $( "#dialog" ).on("dialogresize", functionDialogResize);
 138             $( "#dialog" ).one("dialogopen", function(ev) {
 139                 var size = $( "#dialog" ).dialog('option','sizeCache-function');
 140                 if (size) {
 141                     $("#dialog").dialog('option','width',size.width);
 142                     $("#dialog").dialog('option','height',size.height);
 143                     functionDialogResize();
 144                 }
 145             });
 146             $( "#dialog" ).one("dialogclose", function(ev,ui) {
 147                 var height = $( "#dialog" ).dialog('option','height');
 148                 $( "#dialog" ).off("dialogresize",functionDialogResize);
 149             });
 150
 151             this.editor = RED.editor.createEditor({
 152                 id: 'node-input-xml-editor',
 153                 mode: 'ace/mode/html'
 154             });
 155             this.editor.setValue($("#node-input-xml").val(),-1);
 156         /*
 157             RED.library.create({
 158                 url:"functions", // where to get the data from
 159                 type:"function", // the type of object the library is for
 160                 editor:this.editor, // the field name the main text body goes to
 161                 mode:"ace/mode/html",
 162                 fields:['name','outputs']
 163             });
 164         */
 165             this.editor.focus();
 166             /* close dialog when ESC is pressed and released */
 167             $( "#node-input-xml-editor" ).keyup(function(event){
 168                 if(event.which == 27 ) {
 169                         $("#node-dialog-cancel").click();
 170                 }
 171             });
 172                 $("#node-input-validate").click(function(){
 173                                 console.log("validate clicked.");
 174                                 //console.dir(that.editor);
 175                                 //console.log("getText:" + that.editor.getText());
 176                                 var val = that.editor.getValue();
 177                                 validateXML(val);
 178                 });
 179                 $("#node-input-show-sli-values").click(function(){
 180                         //console.log("show Values clicked.");
 181                         showValuesBox(that.editor,sliValuesObj);
 182                 });
 183             //for click of add comments button
 184             $("#node-input-btnComments").click(function(e){
 185                         showCommentsBox();
 186             });
 187         },
 188         oneditsave: function() {
 189             $("#node-input-xml").val(this.editor.getValue());
 190                 var resp=validateXML(this.editor.getValue());
 191                 if(resp){
 192                         this.status = {fill:"green",shape:"dot",text:"OK"};
 193                 }else{
 194                         this.status = {fill:"red",shape:"dot",text:"ERROR"};
 195                 }
 196                 delete this.editor;
 197         }
 198     });
 199 </script>