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