@sap/async-xsjs 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +37 -0
  3. package/README.md +445 -0
  4. package/differences.md +162 -0
  5. package/docs/$.Application.html +262 -0
  6. package/docs/$.Session.html +674 -0
  7. package/docs/$.db.CallableStatement.html +2524 -0
  8. package/docs/$.db.Connection.html +511 -0
  9. package/docs/$.db.ParameterMetaData.html +805 -0
  10. package/docs/$.db.PreparedStatement.html +1796 -0
  11. package/docs/$.db.ResultSet.html +1308 -0
  12. package/docs/$.db.ResultSetMetaData.html +800 -0
  13. package/docs/$.db.SQLException.html +259 -0
  14. package/docs/$.db.html +773 -0
  15. package/docs/$.hdb.ColumnMetadata.html +438 -0
  16. package/docs/$.hdb.Connection.html +663 -0
  17. package/docs/$.hdb.ProcedureResult.html +280 -0
  18. package/docs/$.hdb.ResultSet.html +324 -0
  19. package/docs/$.hdb.ResultSetIterator.html +315 -0
  20. package/docs/$.hdb.ResultSetMetaData.html +259 -0
  21. package/docs/$.hdb.SQLException.html +259 -0
  22. package/docs/$.hdb.html +557 -0
  23. package/docs/$.html +471 -0
  24. package/docs/$.jobs.Job.html +783 -0
  25. package/docs/$.jobs.JobLog.html +380 -0
  26. package/docs/$.jobs.JobSchedules.html +852 -0
  27. package/docs/$.jobs.html +238 -0
  28. package/docs/$.net.Destination.html +304 -0
  29. package/docs/$.net.Mail.Part.html +510 -0
  30. package/docs/$.net.Mail.html +504 -0
  31. package/docs/$.net.SMTPConnection.html +347 -0
  32. package/docs/$.net.html +749 -0
  33. package/docs/$.net.http.Client.html +562 -0
  34. package/docs/$.net.http.Destination.html +237 -0
  35. package/docs/$.net.http.Request.html +567 -0
  36. package/docs/$.net.http.html +292 -0
  37. package/docs/$.security.AntiVirus.html +361 -0
  38. package/docs/$.security.Store.html +636 -0
  39. package/docs/$.security.crypto.html +414 -0
  40. package/docs/$.security.html +247 -0
  41. package/docs/$.security.x509.html +373 -0
  42. package/docs/$.text.analysis.Session.html +983 -0
  43. package/docs/$.text.analysis.html +242 -0
  44. package/docs/$.text.html +246 -0
  45. package/docs/$.text.mining.Session.html +2018 -0
  46. package/docs/$.text.mining.html +242 -0
  47. package/docs/$.trace.html +525 -0
  48. package/docs/$.util.SAXParser.html +955 -0
  49. package/docs/$.util.Zip.html +474 -0
  50. package/docs/$.util.codec.html +414 -0
  51. package/docs/$.util.compression.html +357 -0
  52. package/docs/$.util.html +325 -0
  53. package/docs/$.util.sql.html +290 -0
  54. package/docs/$.web.Body.html +333 -0
  55. package/docs/$.web.EntityList.html +296 -0
  56. package/docs/$.web.TupelList.html +496 -0
  57. package/docs/$.web.WebEntityRequest.html +393 -0
  58. package/docs/$.web.WebEntityResponse.html +392 -0
  59. package/docs/$.web.WebRequest.html +560 -0
  60. package/docs/$.web.WebResponse.html +609 -0
  61. package/docs/$.web.html +246 -0
  62. package/docs/Copyright-SAP.html +39 -0
  63. package/docs/Disclaimer-SAP.html +55 -0
  64. package/docs/index.html +232 -0
  65. package/docs/styles/jsdoc-default.css +382 -0
  66. package/lib/AppConfig.js +36 -0
  67. package/lib/AuditLogger.js +41 -0
  68. package/lib/cacert.js +26 -0
  69. package/lib/ctypes.js +153 -0
  70. package/lib/destinations/dest-provider.js +57 -0
  71. package/lib/index.js +235 -0
  72. package/lib/jobs/Action.js +40 -0
  73. package/lib/jobs/Job.js +100 -0
  74. package/lib/jobs/JobManager.js +150 -0
  75. package/lib/jobs/JobsRuntime.js +133 -0
  76. package/lib/jobs/SqlScriptJobRunner.js +36 -0
  77. package/lib/jobs/XsjsJobRunner.js +78 -0
  78. package/lib/jobs/index.js +11 -0
  79. package/lib/logging.js +16 -0
  80. package/lib/middleware.js +125 -0
  81. package/lib/odata/ODataService.js +125 -0
  82. package/lib/odata/index.js +7 -0
  83. package/lib/odata/service-factory.js +26 -0
  84. package/lib/passport-noauth.js +17 -0
  85. package/lib/routes.js +115 -0
  86. package/lib/runtime.js +740 -0
  87. package/lib/sandbox.js +40 -0
  88. package/lib/utils/XsJsFunctionRunner.js +57 -0
  89. package/lib/utils/XsJsLibFunctionRunner.js +57 -0
  90. package/lib/utils/buffer-utils.js +77 -0
  91. package/lib/utils/compression-utils.js +14 -0
  92. package/lib/utils/date-utils.js +104 -0
  93. package/lib/utils/errors/HttpError.js +20 -0
  94. package/lib/utils/errors/wrap-app-error.js +18 -0
  95. package/lib/utils/index.js +17 -0
  96. package/lib/utils/xs-function-runner.js +51 -0
  97. package/lib/utils/xs-types.js +21 -0
  98. package/lib/utils/xspath.js +36 -0
  99. package/lib/utils/xsstack.js +28 -0
  100. package/lib/views/error.html +28 -0
  101. package/lib/xsjs/Application.js +28 -0
  102. package/lib/xsjs/Locale.js +53 -0
  103. package/lib/xsjs/Session.js +31 -0
  104. package/lib/xsjs/constants.js +71 -0
  105. package/lib/xsjs/db/common/DbBase.js +85 -0
  106. package/lib/xsjs/db/common/DbOptions.js +163 -0
  107. package/lib/xsjs/db/common/arguments-validation.js +102 -0
  108. package/lib/xsjs/db/common/connection.js +12 -0
  109. package/lib/xsjs/db/common/enums.js +93 -0
  110. package/lib/xsjs/db/common/execute-batch.js +38 -0
  111. package/lib/xsjs/db/common/parse-time.js +139 -0
  112. package/lib/xsjs/db/dbapi/CallableStatement.js +192 -0
  113. package/lib/xsjs/db/dbapi/Connection.js +78 -0
  114. package/lib/xsjs/db/dbapi/DB.js +39 -0
  115. package/lib/xsjs/db/dbapi/ParameterMetaData.js +118 -0
  116. package/lib/xsjs/db/dbapi/PreparedStatement.js +78 -0
  117. package/lib/xsjs/db/dbapi/ResultSet.js +220 -0
  118. package/lib/xsjs/db/dbapi/ResultSetMetaData.js +116 -0
  119. package/lib/xsjs/db/dbapi/Statement.js +514 -0
  120. package/lib/xsjs/db/dbapi/conversions.js +113 -0
  121. package/lib/xsjs/db/dbapi/fetch-rows.js +32 -0
  122. package/lib/xsjs/db/hdbapi/Connection.js +525 -0
  123. package/lib/xsjs/db/hdbapi/HDB.js +32 -0
  124. package/lib/xsjs/db/hdbapi/ResultSetIterator.js +40 -0
  125. package/lib/xsjs/db/hdbapi/convert.js +77 -0
  126. package/lib/xsjs/db/hdbapi/table-string-parser.js +52 -0
  127. package/lib/xsjs/db/index.js +4 -0
  128. package/lib/xsjs/index.js +13 -0
  129. package/lib/xsjs/jobs/Job.js +228 -0
  130. package/lib/xsjs/jobs/Jobs.js +11 -0
  131. package/lib/xsjs/jobs/Logs.js +127 -0
  132. package/lib/xsjs/jobs/Schedule.js +110 -0
  133. package/lib/xsjs/jobs/Schedules.js +108 -0
  134. package/lib/xsjs/net/Destination.js +43 -0
  135. package/lib/xsjs/net/http/Client.js +220 -0
  136. package/lib/xsjs/net/http/HTTP.js +72 -0
  137. package/lib/xsjs/net/index.js +5 -0
  138. package/lib/xsjs/net/smtp/Mail.js +38 -0
  139. package/lib/xsjs/net/smtp/Part.js +30 -0
  140. package/lib/xsjs/net/smtp/SMTPConnection.js +39 -0
  141. package/lib/xsjs/net/smtp/index.js +18 -0
  142. package/lib/xsjs/net/smtp/nodemailer-util.js +77 -0
  143. package/lib/xsjs/require.js +39 -0
  144. package/lib/xsjs/security/AntiVirus.js +31 -0
  145. package/lib/xsjs/security/Store.js +119 -0
  146. package/lib/xsjs/security/crypto.js +23 -0
  147. package/lib/xsjs/security/index.js +5 -0
  148. package/lib/xsjs/security/x509.js +12 -0
  149. package/lib/xsjs/text/analysis/Session.js +128 -0
  150. package/lib/xsjs/text/index.js +30 -0
  151. package/lib/xsjs/text/mining/Session.js +82 -0
  152. package/lib/xsjs/trace/trace.js +41 -0
  153. package/lib/xsjs/util/SAXParser.js +174 -0
  154. package/lib/xsjs/util/Zip.js +220 -0
  155. package/lib/xsjs/util/codec.js +33 -0
  156. package/lib/xsjs/util/compression.js +24 -0
  157. package/lib/xsjs/util/index.js +22 -0
  158. package/lib/xsjs/web/BasicWebEntity.js +41 -0
  159. package/lib/xsjs/web/EntityList.js +11 -0
  160. package/lib/xsjs/web/TupelLists/CookiesTupelList.js +47 -0
  161. package/lib/xsjs/web/TupelLists/HeadersTupelList.js +55 -0
  162. package/lib/xsjs/web/TupelLists/ParametersTupelList.js +83 -0
  163. package/lib/xsjs/web/TupelLists/TupelListBase.js +45 -0
  164. package/lib/xsjs/web/WebBody.js +135 -0
  165. package/lib/xsjs/web/WebEntityRequest.js +40 -0
  166. package/lib/xsjs/web/WebEntityResponse.js +26 -0
  167. package/lib/xsjs/web/WebRequest.js +209 -0
  168. package/lib/xsjs/web/WebResponse.js +183 -0
  169. package/lib/xsjs/web/index.js +4 -0
  170. package/lib/xsjs/web/utils/HeadersParser.js +53 -0
  171. package/lib/xsjs/web/utils/HttpRequestParser.js +93 -0
  172. package/lib/xsjs/web/utils/MultipartParser.js +163 -0
  173. package/lib/xsjs/web/utils/MultipartResponseBuilder.js +73 -0
  174. package/lib/xsjs/web/utils/SetCookieParser.js +32 -0
  175. package/lib/xsjslib/TextBundleWrapper.js +46 -0
  176. package/lib/xsjslib/index.js +11 -0
  177. package/npm-shrinkwrap.json +11540 -0
  178. package/package.json +84 -0
@@ -0,0 +1,292 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Namespace: http</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.net.http.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Namespace: http</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.net.html">.net</a>.</span>
23
+ http
24
+ </h2>
25
+ </header>
26
+ <article>
27
+ <div class="container-overview">
28
+ <div class="description">Namespace: http</div>
29
+ <dl class="details">
30
+ </dl>
31
+ </div>
32
+ <h3 class="subsection-title">Classes</h3>
33
+ <dl>
34
+ <dt><a href="$.net.http.Client.html">Client</a></dt>
35
+ <dd></dd>
36
+ <dt><a href="$.net.http.Destination.html">Destination</a></dt>
37
+ <dd></dd>
38
+ <dt><a href="$.net.http.Request.html">Request</a></dt>
39
+ <dd></dd>
40
+ </dl>
41
+ <h3 class="subsection-title">Methods</h3>
42
+ <dl>
43
+ <dt>
44
+ <h4 class="name" id="readDestination"><span class="type-signature">&lt;static> async </span>readDestination<span
45
+ class="signature">(package, objectName)</span><span class="type-signature"> &rarr; {<a
46
+ href="$.net.http.Destination.html">$.net.http.Destination</a>}</span></h4>
47
+ </dt>
48
+ <dd>
49
+ <div class="description">
50
+ Returns the HTTP destination with the given name
51
+ </div>
52
+ <h5>Parameters:</h5>
53
+ <table class="params">
54
+ <thead>
55
+ <tr>
56
+ <th>Name</th>
57
+ <th>Type</th>
58
+ <th class="last">Description</th>
59
+ </tr>
60
+ </thead>
61
+ <tbody>
62
+ <tr>
63
+ <td class="name"><code>package</code></td>
64
+ <td class="type">
65
+ <span class="param-type">String</span>
66
+ </td>
67
+ <td class="description last">The package where the destination is located</td>
68
+ </tr>
69
+ <tr>
70
+ <td class="name"><code>objectName</code></td>
71
+ <td class="type">
72
+ <span class="param-type">String</span>
73
+ </td>
74
+ <td class="description last">The name of the destination file</td>
75
+ </tr>
76
+ </tbody>
77
+ </table>
78
+ <dl class="details">
79
+ </dl>
80
+ <h5>Throws:</h5>
81
+ <div class="param-desc">
82
+ Throws an error if no valid HTTP Destination is found with the given name
83
+ </div>
84
+ <h5>Returns:</h5>
85
+ <dl>
86
+ <dt>
87
+ Type
88
+ </dt>
89
+ <dd>
90
+ <span class="param-type"><a
91
+ href="$.net.http.Destination.html">$.net.http.Destination</a></span>
92
+ </dd>
93
+ </dl>
94
+ </dd>
95
+ </dl>
96
+ </article>
97
+ </section>
98
+ </div>
99
+ <nav>
100
+ <h2><a href="index.html">Index</a></h2>
101
+ <h3>Classes</h3>
102
+ <table>
103
+ <tr>
104
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
105
+ <td class="oblique">$.security</td>
106
+ </tr>
107
+ <tr>
108
+ <td><a href="$.Application.html">Application</a></td>
109
+ <td class="oblique">$</td>
110
+ </tr>
111
+ <tr>
112
+ <td><a href="$.web.Body.html">Body</a></td>
113
+ <td class="oblique">$.web</td>
114
+ </tr>
115
+ <tr>
116
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
117
+ <td class="oblique">$.db</td>
118
+ </tr>
119
+ <tr>
120
+ <td><a href="$.net.http.Client.html">Client</a></td>
121
+ <td class="oblique">$.net.http</td>
122
+ </tr>
123
+ <tr>
124
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
125
+ <td class="oblique">$.hdb</td>
126
+ </tr>
127
+ <tr>
128
+ <td><a href="$.db.Connection.html">Connection</a></td>
129
+ <td class="oblique">$.db</td>
130
+ </tr>
131
+ <tr>
132
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
133
+ <td class="oblique">$.hdb</td>
134
+ </tr>
135
+ <tr>
136
+ <td><a href="$.net.Destination.html">Destination</a></td>
137
+ <td class="oblique">$.net</td>
138
+ </tr>
139
+ <tr>
140
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
141
+ <td class="oblique">$.net.http</td>
142
+ </tr>
143
+ <tr>
144
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
145
+ <td class="oblique">$.web</td>
146
+ </tr>
147
+ <tr>
148
+ <td><a href="$.jobs.Job.html">Job</a></td>
149
+ <td class="oblique">$.jobs</td>
150
+ </tr>
151
+ <tr>
152
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
153
+ <td class="oblique">$.jobs</td>
154
+ </tr>
155
+ <tr>
156
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
157
+ <td class="oblique">$.jobs</td>
158
+ </tr>
159
+ <tr>
160
+ <td><a href="$.net.Mail.html">Mail</a></td>
161
+ <td class="oblique">$.net</td>
162
+ </tr>
163
+ <tr>
164
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
165
+ <td class="oblique">$.db</td>
166
+ </tr>
167
+ <tr>
168
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
169
+ <td class="oblique">$.net.Mail</td>
170
+ </tr>
171
+ <tr>
172
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
173
+ <td class="oblique">$.db</td>
174
+ </tr>
175
+ <tr>
176
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
177
+ <td class="oblique">$.hdb</td>
178
+ </tr>
179
+ <tr>
180
+ <td><a href="$.net.http.Request.html">Request</a></td>
181
+ <td class="oblique">$.net.http</td>
182
+ </tr>
183
+ <tr>
184
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
185
+ <td class="oblique">$.db</td>
186
+ </tr>
187
+ <tr>
188
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
189
+ <td class="oblique">$.hdb</td>
190
+ </tr>
191
+ <tr>
192
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
193
+ <td class="oblique">$.hdb</td>
194
+ </tr>
195
+ <tr>
196
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
197
+ <td class="oblique">$.db</td>
198
+ </tr>
199
+ <tr>
200
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
201
+ <td class="oblique">$.hdb</td>
202
+ </tr>
203
+ <tr>
204
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
205
+ <td class="oblique">$.util</td>
206
+ </tr>
207
+ <tr>
208
+ <td><a href="$.Session.html">Session</a></td>
209
+ <td class="oblique">$</td>
210
+ </tr>
211
+ <tr>
212
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
213
+ <td class="oblique">$.text.analysis</td>
214
+ </tr>
215
+ <tr>
216
+ <td><a href="$.text.mining.Session.html">Session</a></td>
217
+ <td class="oblique">$.text.mining</td>
218
+ </tr>
219
+ <tr>
220
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
221
+ <td class="oblique">$.net</td>
222
+ </tr>
223
+ <tr>
224
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
225
+ <td class="oblique">$.db</td>
226
+ </tr>
227
+ <tr>
228
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
229
+ <td class="oblique">$.hdb</td>
230
+ </tr>
231
+ <tr>
232
+ <td><a href="$.security.Store.html">Store</a></td>
233
+ <td class="oblique">$.security</td>
234
+ </tr>
235
+ <tr>
236
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
237
+ <td class="oblique">$.web</td>
238
+ </tr>
239
+ <tr>
240
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
241
+ <td class="oblique">$.web</td>
242
+ </tr>
243
+ <tr>
244
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
245
+ <td class="oblique">$.web</td>
246
+ </tr>
247
+ <tr>
248
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
249
+ <td class="oblique">$.web</td>
250
+ </tr>
251
+ <tr>
252
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
253
+ <td class="oblique">$.web</td>
254
+ </tr>
255
+ <tr>
256
+ <td><a href="$.util.Zip.html">Zip</a></td>
257
+ <td class="oblique">$.util</td>
258
+ </tr>
259
+ </table>
260
+ <h3>Namespaces</h3>
261
+ <ul>
262
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
263
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
264
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
265
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
266
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
267
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
268
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
269
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
270
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
271
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
272
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
273
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
274
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
275
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
276
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
277
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
278
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
279
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
280
+ </ul>
281
+ </nav>
282
+ <br clear="both">
283
+ <footer>
284
+ <a href="Copyright-SAP.html">Copyright</a>
285
+ &
286
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
287
+ </footer>
288
+ <script>prettyPrint();</script>
289
+ <script src="scripts/linenumber.js"></script>
290
+ </body>
291
+
292
+ </html>
@@ -0,0 +1,361 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Class: AntiVirus</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.security.AntiVirus.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Class: AntiVirus</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.security.html">.security</a>.</span>
23
+ AntiVirus
24
+ </h2>
25
+ <div class="class-description">Class for checking data with external Anti-Virus (AV) engines.
26
+ The scan needs a Virus Scan Adapter (VSA) to be installed on the host.
27
+ The setup and configuration is available with SAP note <a
28
+ href="http://service.sap.com/sap/support/notes/2081108" target="_blank">2081108</a>.
29
+ This class uses the SAP certified interface NW-VSI 2.00 (see SAP note <a
30
+ href="http://service.sap.com/sap/support/notes/1883424" target="_blank">1883424</a>).
31
+ For a list of the AV products supported, see SAP note <a
32
+ href="http://service.sap.com/sap/support/notes/1494278" target="_blank">1494278</a>.
33
+ </div>
34
+ </header>
35
+ <article>
36
+ <div class="container-overview">
37
+ <dt>
38
+ <h4 class="name" id="AntiVirus"><span class="type-signature"></span>new AntiVirus<span
39
+ class="signature">(<span class="optional">Profile</span>)</span><span
40
+ class="type-signature"></span></h4>
41
+ </dt>
42
+ <dd>
43
+ <h5>Parameters:</h5>
44
+ <table class="params">
45
+ <thead>
46
+ <tr>
47
+ <th>Name</th>
48
+ <th>Type</th>
49
+ <th>Argument</th>
50
+ <th class="last">Description</th>
51
+ </tr>
52
+ </thead>
53
+ <tbody>
54
+ <tr>
55
+ <td class="name"><code>Profile</code></td>
56
+ <td class="type">
57
+ <span class="param-type">String</span>
58
+ </td>
59
+ <td class="attributes">
60
+ &lt;optional><br>
61
+ </td>
62
+ <td class="description last">The profile name for the scan instance. If no profile is
63
+ specified, the default profile is used.
64
+ </td>
65
+ </tr>
66
+ </tbody>
67
+ </table>
68
+ <dl class="details">
69
+ </dl>
70
+ <h5>Throws:</h5>
71
+ <div class="param-desc">
72
+ Throws an error if the profile is invalid
73
+ </div>
74
+ <h5>Examples</h5>
75
+ <pre class="prettyprint"><code>//create a new $.security.AntiVirus object using the default profile
76
+ var av = new $.security.AntiVirus();</code></pre>
77
+ <pre class="prettyprint"><code>//scan a buffer with own "upload" profile
78
+ var av = new $.security.AntiVirus("upload");
79
+ av.scan(buffer);</code></pre>
80
+ </dd>
81
+ </div>
82
+ <h3 class="subsection-title">Methods</h3>
83
+ <dl>
84
+ <dt>
85
+ <h4 class="name" id="isAvailable"><span class="type-signature"></span>isAvailable<span
86
+ class="signature">()</span><span class="type-signature"></span></h4>
87
+ </dt>
88
+ <dd>
89
+ <div class="description">
90
+ Check the AV engine and return true if this is ready to scan.
91
+ Return false if the engine is not loaded, the profile is not active or contains configuration
92
+ errors and so on.
93
+ </div>
94
+ <dl class="details">
95
+ </dl>
96
+ </dd>
97
+ <dt>
98
+ <h4 class="name" id="scan"><span class="type-signature"></span>scan<span
99
+ class="signature">(data, <span class="optional">objectName</span>)</span><span
100
+ class="type-signature"></span></h4>
101
+ </dt>
102
+ <dd>
103
+ <div class="description">
104
+ This method performs an AV check with VSI, using one of the external AV engines listed in SAP
105
+ note 1494278. The optional objectName parameter should be passed to the function whenever
106
+ available,
107
+ for example, in a file upload; the result of the AV scan depends on the file type (MIME type).
108
+ </div>
109
+ <h5>Parameters:</h5>
110
+ <table class="params">
111
+ <thead>
112
+ <tr>
113
+ <th>Name</th>
114
+ <th>Type</th>
115
+ <th>Argument</th>
116
+ <th class="last">Description</th>
117
+ </tr>
118
+ </thead>
119
+ <tbody>
120
+ <tr>
121
+ <td class="name"><code>data</code></td>
122
+ <td class="type">
123
+ <span class="param-type">String</span>
124
+ |
125
+ <span class="param-type">ArrayBuffer</span>
126
+ |
127
+ <span class="param-type"><a href="$.db.ResultSet.html">$.db.ResultSet</a></span>
128
+ </td>
129
+ <td class="attributes">
130
+ </td>
131
+ <td class="description last">Data to be scanned</td>
132
+ </tr>
133
+ <tr>
134
+ <td class="name"><code>objectName</code></td>
135
+ <td class="type">
136
+ <span class="param-type">String</span>
137
+ </td>
138
+ <td class="attributes">
139
+ &lt;optional><br>
140
+ </td>
141
+ <td class="description last">Name of the object</td>
142
+ </tr>
143
+ </tbody>
144
+ </table>
145
+ <dl class="details">
146
+ </dl>
147
+ <h5>Throws:</h5>
148
+ <div class="param-desc">
149
+ Throws an error if an infection was found or a problem occurred during the AV scan
150
+ </div>
151
+ <h5>Examples</h5>
152
+ <pre class="prettyprint"><code>var data = //Some data to be checked
153
+ var av = new $.security.AntiVirus();
154
+
155
+ //... peform AV check
156
+ av.scan(data);</code></pre>
157
+ <pre class="prettyprint"><code>var data = //Some data to be checked
158
+ var av = new $.security.AntiVirus();
159
+
160
+ //... check data as Word document
161
+ av.scan(data, "myDocument.docx");</code></pre>
162
+ </dd>
163
+ </dl>
164
+ </article>
165
+ </section>
166
+ </div>
167
+ <nav>
168
+ <h2><a href="index.html">Index</a></h2>
169
+ <h3>Classes</h3>
170
+ <table>
171
+ <tr>
172
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
173
+ <td class="oblique">$.security</td>
174
+ </tr>
175
+ <tr>
176
+ <td><a href="$.Application.html">Application</a></td>
177
+ <td class="oblique">$</td>
178
+ </tr>
179
+ <tr>
180
+ <td><a href="$.web.Body.html">Body</a></td>
181
+ <td class="oblique">$.web</td>
182
+ </tr>
183
+ <tr>
184
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
185
+ <td class="oblique">$.db</td>
186
+ </tr>
187
+ <tr>
188
+ <td><a href="$.net.http.Client.html">Client</a></td>
189
+ <td class="oblique">$.net.http</td>
190
+ </tr>
191
+ <tr>
192
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
193
+ <td class="oblique">$.hdb</td>
194
+ </tr>
195
+ <tr>
196
+ <td><a href="$.db.Connection.html">Connection</a></td>
197
+ <td class="oblique">$.db</td>
198
+ </tr>
199
+ <tr>
200
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
201
+ <td class="oblique">$.hdb</td>
202
+ </tr>
203
+ <tr>
204
+ <td><a href="$.net.Destination.html">Destination</a></td>
205
+ <td class="oblique">$.net</td>
206
+ </tr>
207
+ <tr>
208
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
209
+ <td class="oblique">$.net.http</td>
210
+ </tr>
211
+ <tr>
212
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
213
+ <td class="oblique">$.web</td>
214
+ </tr>
215
+ <tr>
216
+ <td><a href="$.jobs.Job.html">Job</a></td>
217
+ <td class="oblique">$.jobs</td>
218
+ </tr>
219
+ <tr>
220
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
221
+ <td class="oblique">$.jobs</td>
222
+ </tr>
223
+ <tr>
224
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
225
+ <td class="oblique">$.jobs</td>
226
+ </tr>
227
+ <tr>
228
+ <td><a href="$.net.Mail.html">Mail</a></td>
229
+ <td class="oblique">$.net</td>
230
+ </tr>
231
+ <tr>
232
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
233
+ <td class="oblique">$.db</td>
234
+ </tr>
235
+ <tr>
236
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
237
+ <td class="oblique">$.net.Mail</td>
238
+ </tr>
239
+ <tr>
240
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
241
+ <td class="oblique">$.db</td>
242
+ </tr>
243
+ <tr>
244
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
245
+ <td class="oblique">$.hdb</td>
246
+ </tr>
247
+ <tr>
248
+ <td><a href="$.net.http.Request.html">Request</a></td>
249
+ <td class="oblique">$.net.http</td>
250
+ </tr>
251
+ <tr>
252
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
253
+ <td class="oblique">$.db</td>
254
+ </tr>
255
+ <tr>
256
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
257
+ <td class="oblique">$.hdb</td>
258
+ </tr>
259
+ <tr>
260
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
261
+ <td class="oblique">$.hdb</td>
262
+ </tr>
263
+ <tr>
264
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
265
+ <td class="oblique">$.db</td>
266
+ </tr>
267
+ <tr>
268
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
269
+ <td class="oblique">$.hdb</td>
270
+ </tr>
271
+ <tr>
272
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
273
+ <td class="oblique">$.util</td>
274
+ </tr>
275
+ <tr>
276
+ <td><a href="$.Session.html">Session</a></td>
277
+ <td class="oblique">$</td>
278
+ </tr>
279
+ <tr>
280
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
281
+ <td class="oblique">$.text.analysis</td>
282
+ </tr>
283
+ <tr>
284
+ <td><a href="$.text.mining.Session.html">Session</a></td>
285
+ <td class="oblique">$.text.mining</td>
286
+ </tr>
287
+ <tr>
288
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
289
+ <td class="oblique">$.net</td>
290
+ </tr>
291
+ <tr>
292
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
293
+ <td class="oblique">$.db</td>
294
+ </tr>
295
+ <tr>
296
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
297
+ <td class="oblique">$.hdb</td>
298
+ </tr>
299
+ <tr>
300
+ <td><a href="$.security.Store.html">Store</a></td>
301
+ <td class="oblique">$.security</td>
302
+ </tr>
303
+ <tr>
304
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
305
+ <td class="oblique">$.web</td>
306
+ </tr>
307
+ <tr>
308
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
309
+ <td class="oblique">$.web</td>
310
+ </tr>
311
+ <tr>
312
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
313
+ <td class="oblique">$.web</td>
314
+ </tr>
315
+ <tr>
316
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
317
+ <td class="oblique">$.web</td>
318
+ </tr>
319
+ <tr>
320
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
321
+ <td class="oblique">$.web</td>
322
+ </tr>
323
+ <tr>
324
+ <td><a href="$.util.Zip.html">Zip</a></td>
325
+ <td class="oblique">$.util</td>
326
+ </tr>
327
+ </table>
328
+ <h3>Namespaces</h3>
329
+ <ul>
330
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
331
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
332
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
333
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
334
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
335
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
336
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
337
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
338
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
339
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
340
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
341
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
342
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
343
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
344
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
345
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
346
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
347
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
348
+ </ul>
349
+ </nav>
350
+ <br clear="both">
351
+ <footer>
352
+ <a href="Copyright-SAP.html">Copyright</a>
353
+ &
354
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
355
+ </footer>
356
+ <script>prettyPrint();</script>
357
+ <script src="scripts/linenumber.js"></script>
358
+
359
+ </body>
360
+
361
+ </html>