2 Copyright 2013 IBM Corp.
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
8 http://www.apache.org/licenses/LICENSE-2.0
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.
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">
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>
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>
34 <div class="form-tips">See the Info tab for help using this node.</div>
37 <script type="text/x-red" data-help-name="notify">
39 <p>Do not include closing tag - it will be automatically generated.</p>
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>
45 <h5><a name="Attributes"></a>Attributes</h5>
46 <table border="1" class="table table-striped">
48 <td align="center"><b>plugin</b></td>
49 <td align="left">Fully qualified Java class of plugin to be used</td></tr>
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>
54 <h5><a name="Parameters"></a>Parameters</h5>
55 <p>Specific to plugin / method</p></div>
57 <h5><a name="Outcomes"></a>Outcomes</h5>
58 <table border="1" class="table table-striped">
60 <td align="center"><b>success</b></td>
61 <td align="left">Device successfully configured</td></tr>
63 <td align="center"><b>not-found</b></td>
64 <td align="left">Plugin class could not be loaded</td></tr>
66 <td align="center"><b>unsupported-method</b></td>
67 <td align="left">Named method taking (Map, SvcLogicContext) could not be found</td></tr>
69 <td align="center"><b>failure</b></td>
70 <td align="left">Configure failed for some other reason</td></tr></table></div>
72 <h5><a name="Example"></a>Example</h5>
74 <pre><notify plugin="org.onap.ccsdk.sli.resource.samplesvc.SampleServiceResource"
75 resource="network-connection" action="DELETE" >
76 <parameter name="message" value="Hello, world!" />
77 <outcome value="success">
78 <return status="success"/>
80 <outcome value="not-found">
81 <return status="failure">
82 <parameter name="error-code" value="1590" />
83 <parameter name="error-message" value="Could not locate plugin" />
86 <outcome value="Other">
87 <return status="failure">
88 <parameter name="error-code" value="1542" />
89 <parameter name="error-message" value="Internal error" />
92 </notify></pre></div></div></div></div>
97 <script type="text/javascript">
98 RED.nodes.registerType('notify',{
100 category: 'DGElogic',
102 name: {value:"notify"},
103 xml: {value:"<notify plugin='' resource='' action='' >\n"},
109 icon: "arrow-in.png",
113 oneditprepare: function() {
115 $( "#node-input-outputs" ).spinner({
118 var comments = $( "#node-input-comments").val();
119 if(comments != null){
120 comments = comments.trim();
122 $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
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);
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();
137 $( "#dialog" ).on("dialogresize", functionDialogResize);
138 $( "#dialog" ).one("dialogopen", function(ev) {
139 var size = $( "#dialog" ).dialog('option','sizeCache-function');
141 $("#dialog").dialog('option','width',size.width);
142 $("#dialog").dialog('option','height',size.height);
143 functionDialogResize();
146 $( "#dialog" ).one("dialogclose", function(ev,ui) {
147 var height = $( "#dialog" ).dialog('option','height');
148 $( "#dialog" ).off("dialogresize",functionDialogResize);
151 this.editor = RED.editor.createEditor({
152 id: 'node-input-xml-editor',
153 mode: 'ace/mode/html'
155 this.editor.setValue($("#node-input-xml").val(),-1);
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']
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();
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();
179 $("#node-input-show-sli-values").click(function(){
180 //console.log("show Values clicked.");
181 showValuesBox(that.editor,sliValuesObj);
183 //for click of add comments button
184 $("#node-input-btnComments").click(function(e){
188 oneditsave: function() {
189 $("#node-input-xml").val(this.editor.getValue());
190 var resp=validateXML(this.editor.getValue());
192 this.status = {fill:"green",shape:"dot",text:"OK"};
194 this.status = {fill:"red",shape:"dot",text:"ERROR"};