dgbuilder/nodes/dge/dgelogic/is-available.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="is-available">
  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="is-available">
  38         <p>A is-available node.</p>
  39         <p>First line of XML must contain opening tag.</p>
  40         <p>Do not include closing tag - it will be automatically generated.</p>
  41
  42 <div class="section">
  43 <h4><a name="Is-available_node"></a>Is-available node</h4>
  44 <div class="section">
  45 <h5><a name="Description"></a>Description</h5>
  46 <p>An <b>is-available</b> node is used to determine whether a particular type of resource is available. For example, this might be used to test whether any ports are available for assignment on a particular switch.</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 resource adaptor to be used</td></tr>
  53 <tr class="b">
  54 <td align="center"><b>resource</b></td>
  55 <td align="left">Type of resource to check</td></tr>
  56 <tr class="a">
  57 <td align="center"><b>key</b></td>
  58 <td align="left">SQL-like string specifying key to check for</td></tr></table></div>
  59 <div class="section">
  60 <h5><a name="Parameters"></a>Parameters</h5>
  61 <p>None</p></div>
  62 <div class="section">
  63 <h5><a name="Outcomes"></a>Outcomes</h5>
  64 <table border="1" class="table table-striped">
  65 <tr class="a">
  66 <td align="center"><b>true</b></td>
  67 <td align="left">Resource requested is available</td></tr>
  68 <tr class="b">
  69 <td align="center"><b>false</b></td>
  70 <td align="left">Resource requested is not available</td></tr></table></div>
  71 <div class="section">
  72 <h5><a name="Example"></a>Example</h5>
  73 <div class="source">
  74 <pre>&lt;is-available plugin=&quot;org.onap.ccsdk.sli.resource.samplesvc.SampleServiceResource&quot;
  75               resource=&quot;ase-port&quot;
  76               key=&quot;resource-emt-clli == $edge-device-clli and speed &gt;= $uni-cir-value&quot;&gt;
  77   &lt;outcome value=&quot;true&quot;&gt;
  78     &lt;return status=&quot;success&quot;/&gt;
  79   &lt;/outcome&gt;
  80   &lt;outcome value=&quot;false&quot;&gt;
  81     &lt;return status=&quot;failure&quot;/&gt;
  82   &lt;/outcome&gt;
  83 &lt;/is-available&gt;</pre></div></div></div>
  84
  85 </script>
  86
  87
  88 <script type="text/javascript">
  89     RED.nodes.registerType('is-available',{
  90         color:"#fdd0a2",
  91         category: 'DGElogic',
  92         defaults: {
  93             name: {value:"is-available"},
  94             xml: {value:"<is-available plugin='' resource='' key=''>\n"},
  95             comments:{value:""},
  96             outputs: {value:1}
  97         },
  98         inputs:1,
  99         outputs:1,
 100         icon: "arrow-in.png",
 101         label: function() {
 102             return this.name;
 103         },
 104         oneditprepare: function() {
 105             $( "#node-input-outputs" ).spinner({
 106                 min:1
 107             });
 108
 109
 110              var comments = $( "#node-input-comments").val();
 111              if(comments != null){
 112                 comments = comments.trim();
 113                 if(comments != ''){
 114                         $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
 115                 }
 116              }
 117
 118             function functionDialogResize(ev,ui) {
 119                 $("#node-input-xml-editor").css("height",(ui.size.height-275)+"px");
 120             };
 121
 122             $( "#dialog" ).dialog( "option", "width", 1200 );
 123             $( "#dialog" ).dialog( "option", "height", 750 );
 124             $( "#dialog" ).on("dialogresize", functionDialogResize);
 125             $( "#dialog" ).one("dialogopen", function(ev) {
 126                 var size = $( "#dialog" ).dialog('option','sizeCache-function');
 127                 if (size) {
 128                     functionDialogResize(null,{size:size});
 129                 }
 130             });
 131
 132             /* close dialog when ESC is pressed and released */
 133             $( "#dialog" ).keyup(function(event){
 134                 if(event.which == 27 ) {
 135                         $("#node-dialog-cancel").click();
 136                 }
 137             });
 138
 139             $( "#dialog" ).one("dialogclose", function(ev,ui) {
 140                 var height = $( "#dialog" ).dialog('option','height');
 141                 $( "#dialog" ).off("dialogresize",functionDialogResize);
 142             });
 143             var that = this;
 144             require(["orion/editor/edit"], function(edit) {
 145                 that.editor = edit({
 146                     parent:document.getElementById('node-input-xml-editor'),
 147                     lang:"html",
 148                     contents: $("#node-input-xml").val()
 149                 });
 150                 RED.library.create({
 151                     url:"functions", // where to get the data from
 152                     type:"function", // the type of object the library is for
 153                     editor:that.editor, // the field name the main text body goes to
 154                     fields:['name','outputs']
 155                 });
 156                 $("#node-input-name").focus();
 157                 $("#node-input-validate").click(function(){
 158                                 console.log("validate clicked.");
 159                                 //console.dir(that.editor);
 160                                 //console.log("getText:" + that.editor.getText());
 161                                 var val = that.editor.getText();
 162                                 validateXML(val);
 163                 });
 164                 $("#node-input-show-sli-values").click(function(){
 165                                 console.log("SLIValues clicked.");
 166                                 showValuesBox(that.editor,sliValuesObj);
 167                 });
 168
 169             });
 170             //for click of add comments button
 171             $("#node-input-btnComments").click(function(e){
 172                         showCommentsBox();
 173             });
 174         },
 175         oneditsave: function() {
 176             $("#node-input-xml").val(this.editor.getText());
 177                 var resp=validateXML(this.editor.getText());
 178                 if(resp){
 179                         this.status = {fill:"green",shape:"dot",text:"OK"};
 180                 }else{
 181                         this.status = {fill:"red",shape:"dot",text:"ERROR"};
 182                 }
 183                 delete this.editor;
 184         }
 185     });
 186 </script>