-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathJSTACK.Comm.html
More file actions
160 lines (123 loc) · 21.4 KB
/
Copy pathJSTACK.Comm.html
File metadata and controls
160 lines (123 loc) · 21.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!DOCTYPE html> <html> <head> <title>JSTACK.Comm.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="JSTACK.Comm.html"> JSTACK.Comm.js </a> <a class="source" href="JSTACK.Glance.html"> JSTACK.Glance.js </a> <a class="source" href="JSTACK.Keystone.html"> JSTACK.Keystone.js </a> <a class="source" href="JSTACK.Nova.Volume.html"> JSTACK.Nova.Volume.js </a> <a class="source" href="JSTACK.Nova.html"> JSTACK.Nova.js </a> <a class="source" href="JSTACK.Utils.html"> JSTACK.Utils.js </a> <a class="source" href="JSTACK.html"> JSTACK.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> JSTACK.Comm.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="cm">/*</span>
<span class="cm">The MIT License</span>
<span class="cm">Copyright (c) 2012 Universidad Politecnica de Madrid</span>
<span class="cm">Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<span class="cm">of this software and associated documentation files (the "Software"), to deal</span>
<span class="cm">in the Software without restriction, including without limitation the rights</span>
<span class="cm">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<span class="cm">copies of the Software, and to permit persons to whom the Software is</span>
<span class="cm">furnished to do so, subject to the following conditions:</span>
<span class="cm">The above copyright notice and this permission notice shall be included in</span>
<span class="cm">all copies or substantial portions of the Software.</span>
<span class="cm">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<span class="cm">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<span class="cm">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<span class="cm">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<span class="cm">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<span class="cm">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<span class="cm">THE SOFTWARE.</span>
<span class="cm">*/</span>
</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h2>JSTACK Communication Module</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>This module provides functions to send GET, POST, PUT and DELETE HTTP requests
to OpenStack components. It is compatible with the token-based authentication
proposed by Keystone.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">JSTACK</span><span class="p">.</span><span class="nx">Comm</span> <span class="o">=</span> <span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">JS</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="s2">"use strict"</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">send</span><span class="p">,</span> <span class="nx">get</span><span class="p">,</span> <span class="nx">post</span><span class="p">,</span> <span class="nx">put</span><span class="p">,</span> <span class="nx">del</span><span class="p">;</span>
</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>Private functions</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>Function <code>_send</code> is internally used to make detailed low-level requests
to components.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">send</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">method</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callBackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">xhr</span><span class="p">,</span> <span class="nx">body</span><span class="p">,</span> <span class="nx">result</span><span class="p">;</span>
</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>This function receives a <code>method</code> that can be "GET", "POST", "PUT", or
"DELETE". It also receives the <code>url</code> to which it has to send the request,
the <code>data</code> to be sent, that has to be a JSON object, the ´token´ to
authenticate the request, and success and error callbacks.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">xhr</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">XMLHttpRequest</span><span class="p">();</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="nx">method</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">setRequestHeader</span><span class="p">(</span><span class="s2">"Content-Type"</span><span class="p">,</span> <span class="s2">"application/json"</span><span class="p">);</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">setRequestHeader</span><span class="p">(</span><span class="s2">"Accept"</span><span class="p">,</span> <span class="s2">"application/json"</span><span class="p">);</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">onreadystatechange</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">xhr</span><span class="p">.</span><span class="nx">readyState</span> <span class="o">===</span> <span class="mi">4</span><span class="p">)</span> <span class="p">{</span>
<span class="k">switch</span> <span class="p">(</span><span class="nx">xhr</span><span class="p">.</span><span class="nx">status</span><span class="p">)</span> <span class="p">{</span>
</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <p>In case of successful response it calls the <code>callbackOK</code> function.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="k">case</span> <span class="mi">100</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">200</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">201</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">202</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">203</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">204</span><span class="o">:</span>
<span class="k">case</span> <span class="mi">205</span><span class="o">:</span>
<span class="nx">result</span> <span class="o">=</span> <span class="kc">undefined</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">xhr</span><span class="p">.</span><span class="nx">responseText</span> <span class="o">!==</span> <span class="kc">undefined</span> <span class="o">&&</span> <span class="nx">xhr</span><span class="p">.</span><span class="nx">responseText</span> <span class="o">!==</span> <span class="s1">''</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">result</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">xhr</span><span class="p">.</span><span class="nx">responseText</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">callBackOK</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="k">break</span><span class="p">;</span>
</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <p>In case of error it sends an error message to <code>callbackError</code>.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="k">case</span> <span class="mi">400</span><span class="o">:</span>
<span class="nx">callbackError</span><span class="p">(</span><span class="s2">"400 Bad Request"</span><span class="p">);</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">case</span> <span class="mi">401</span><span class="o">:</span>
<span class="nx">callbackError</span><span class="p">(</span><span class="s2">"401 Unauthorized"</span><span class="p">);</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">case</span> <span class="mi">403</span><span class="o">:</span>
<span class="nx">callbackError</span><span class="p">(</span><span class="s2">"403 Forbidden"</span><span class="p">);</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">default</span><span class="o">:</span>
<span class="nx">callbackError</span><span class="p">(</span><span class="nx">xhr</span><span class="p">.</span><span class="nx">status</span> <span class="o">+</span> <span class="s2">" Error"</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">token</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">setRequestHeader</span><span class="p">(</span><span class="s1">'X-Auth-Token'</span><span class="p">,</span> <span class="nx">token</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">data</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">body</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">data</span><span class="p">);</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">send</span><span class="p">(</span><span class="nx">body</span><span class="p">);</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="nx">xhr</span><span class="p">.</span><span class="nx">send</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>Public functions</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <ul>
<li>Function <em>get</em> receives the <code>url</code>, the authentication token
(which is optional), and callbacks. It sends a HTTP GET request,
so it does not send any data.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">get</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">send</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <ul>
<li>Function <em>post</em> receives the <code>url</code>, the authentication token
(which is optional), the data to be sent (a JSON Object), and
callbacks. It sends a HTTP POST request.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">post</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">send</span><span class="p">(</span><span class="s2">"POST"</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <ul>
<li>Function <em>put</em> receives the same parameters as post. It sends
a HTTP PUT request.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">put</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">send</span><span class="p">(</span><span class="s2">"PUT"</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <ul>
<li>Function <em>del</em> receives the same paramaters as get. It sends a
HTTP DELETE request.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">del</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">send</span><span class="p">(</span><span class="s2">"DELETE"</span><span class="p">,</span> <span class="nx">url</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">,</span> <span class="nx">token</span><span class="p">,</span> <span class="nx">callbackOK</span><span class="p">,</span> <span class="nx">callbackError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <h2>Public Functions and Variables</h2>
<p>This is the list of available public functions and variables</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="k">return</span> <span class="p">{</span>
</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <p>Functions:</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">get</span> <span class="o">:</span> <span class="nx">get</span><span class="p">,</span>
<span class="nx">post</span> <span class="o">:</span> <span class="nx">post</span><span class="p">,</span>
<span class="nx">put</span> <span class="o">:</span> <span class="nx">put</span><span class="p">,</span>
<span class="nx">del</span> <span class="o">:</span> <span class="nx">del</span>
<span class="p">};</span>
<span class="p">}(</span><span class="nx">JSTACK</span><span class="p">));</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>