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="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">
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="execute">
38 <p>A execute node.</p>
39 <p>Do not include closing tag - it will be automatically generated.</p>
41 <h3><a name="Java_Plugin_Support"></a>Java Plugin Support</h3>
43 <h4><a name="Execute_node"></a>Execute node</h4>
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>
48 <h5><a name="Attributes"></a>Attributes</h5>
49 <table border="1" class="table table-striped">
51 <td align="center"><b>plugin</b></td>
52 <td align="left">Fully qualified Java class of plugin to be used</td></tr>
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>
57 <h5><a name="Parameters"></a>Parameters</h5>
58 <p>Specific to plugin / method</p></div>
60 <h5><a name="Outcomes"></a>Outcomes</h5>
61 <table border="1" class="table table-striped">
63 <td align="center"><b>success</b></td>
64 <td align="left">Device successfully configured</td></tr>
66 <td align="center"><b>not-found</b></td>
67 <td align="left">Plugin class could not be loaded</td></tr>
69 <td align="center"><b>unsupported-method</b></td>
70 <td align="left">Named method taking (Map, SvcLogicContext) could not be found</td></tr>
72 <td align="center"><b>failure</b></td>
73 <td align="left">Configure failed for some other reason</td></tr></table></div>
75 <h5><a name="Example"></a>Example</h5>
77 <pre><execute plugin="org.onap.ccsdk.sli.plugin.HelloWorld"
78 method="log">
79 <parameter name="message" value="Hello, world!" />
80 <outcome value="success">
81 <return status="success"/>
83 <outcome value="not-found">
84 <return status="failure">
85 <parameter name="error-code" value="1590" />
86 <parameter name="error-message" value="Could not locate plugin" />
89 <outcome value="Other">
90 <return status="failure">
91 <parameter name="error-code" value="1542" />
92 <parameter name="error-message" value="Internal error" />
95 </execute></pre></div></div></div></div>
99 <script type="text/javascript">
100 RED.nodes.registerType('execute',{
102 category: 'DGElogic',
104 name: {value:"execute"},
105 xml: {value:"<execute plugin='' method='' >\n"},
111 icon: "arrow-in.png",
115 oneditprepare: function() {
117 $( "#node-input-outputs" ).spinner({
120 var comments = $( "#node-input-comments").val();
121 if(comments != null){
122 comments = comments.trim();
124 $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
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);
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();
139 $( "#dialog" ).on("dialogresize", functionDialogResize);
140 $( "#dialog" ).one("dialogopen", function(ev) {
141 var size = $( "#dialog" ).dialog('option','sizeCache-function');
143 $("#dialog").dialog('option','width',size.width);
144 $("#dialog").dialog('option','height',size.height);
145 functionDialogResize();
148 $( "#dialog" ).one("dialogclose", function(ev,ui) {
149 var height = $( "#dialog" ).dialog('option','height');
150 $( "#dialog" ).off("dialogresize",functionDialogResize);
153 this.editor = RED.editor.createEditor({
154 id: 'node-input-xml-editor',
155 mode: 'ace/mode/html'
157 this.editor.setValue($("#node-input-xml").val(),-1);
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']
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();
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();
181 $("#node-input-show-sli-values").click(function(){
182 //console.log("show Values clicked.");
183 showValuesBox(that.editor,sliValuesObj);
185 //for click of add comments button
186 $("#node-input-btnComments").click(function(e){
190 oneditsave: function() {
191 $("#node-input-xml").val(this.editor.getValue());
192 var resp=validateXML(this.editor.getValue());
194 this.status = {fill:"green",shape:"dot",text:"OK"};
196 this.status = {fill:"red",shape:"dot",text:"ERROR"};