├── README.md ├── PLATE-API.md └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # PLATE-API-introduce 2 | This repository is used to introduce the API of the PLATE platform. 3 | 4 | * The Documentation is Here: [PLATE-API-1.0](https://github.com/endinferno/PLATE-API-introduce/blob/master/PLATE-API.md) 5 | 6 | > Version 1.0 7 | 8 | Description: First Version of The Documentation. 9 | -------------------------------------------------------------------------------- /PLATE-API.md: -------------------------------------------------------------------------------- 1 | #
PLATE-API
2 | 3 | **Version: 1.0** 4 | 5 | > API文档初始版本 6 | 7 | 8 | 9 | ##
接口规范介绍
 10 | 11 | 本规范对PLATE平台的服务内容编写、相关参数、响应进行定义。目前支持`Javascript`语言，并提供借口操作请求和响应范例。 12 | 13 | 以下所有全局变量、对象、全局函数的命名方式都采用小驼峰式命名法. 如:`firstName` 14 | 15 | 16 | 17 | ##
API索引列表
18 | 19 | * [信令服务器](#信令服务器) 20 | 21 | * [用户连接](#用户连接) 22 | 23 | * [数据传输](#数据传输) 24 | 25 | * [数据通道关闭](#数据通道关闭) 26 | 27 | * [用户注销](#用户注销) 28 | 29 | * [前端组件](#前端组件) 30 | 31 | 32 | 33 | ##
信令服务器
 34 | 35 | > 用户可以自定义自己的信令服务器，也可以使用官方定义的信令服务器 36 | 37 | ### 全局变量表 38 | 39 | **变量名** 40 | 41 | `sslOption` 42 | 43 | **变量类型** 44 | 45 | 字典(`dict`) 46 | 47 | **变量解释** 48 | 49 | 该变量用于自定义用户SSL证书，用于建立自定义信令服务器及进行加密连接. 50 | 51 | **参数列表** 52 | 53 | ```javascript 54 | { 55 | key: fs.readFileSync('文件路径'), 56 | cert: fs.readFileSync('文件路径'), 57 | } 58 | ``` 59 | 60 | **参数解释** 61 | 62 | `key`表示证书的`key`. 63 | 64 | `cert`表示证书的`cert`，可以是`cert`格式或者`pem`格式文件. 65 | 66 | 67 | 68 | --- 69 | 70 | **变量名** 71 | 72 | `serveOption` 73 | 74 | **变量类型** 75 | 76 | 字典(`dict`) 77 | 78 | **变量解释** 79 | 80 | 该变量用于建立用户自定义信令服务器. 81 | 82 | **参数列表** 83 | 84 | ```javascript 85 | { 86 | port: 9000, 87 | ssl: sslOption, 88 | path: '/', 89 | } 90 | ``` 91 | 92 | 93 | 94 | --- 95 | 96 | **变量名** 97 | 98 | `connOption` 99 | 100 | **变量类型** 101 | 102 | 字典(`dict`) 103 | 104 | **变量解释** 105 | 106 | 该变量用于用户连接信令服务器，进行注册、数据通道建立的基础工作，默认进行加密连接. 107 | 108 | **参数列表** 109 | 110 | ```javascript 111 | { 112 | host: '47.93.23.141', 113 | port: 9000, 114 | path: '/', 115 | debug: 3, 116 | } 117 | ``` 118 | 119 | **参数解释** 120 | 121 | `host`表示信令服务器的公网IP. (Default:`47.93.23.141`) 122 | 123 | `port`表示信令服务器的对应端口. (Default:`9000`) 124 | 125 | `path`表示信令服务器响应请求的根路径. (Default: `/`) 126 | 127 | `debug`表示信令服务器的调试输出等级，等级排序为`no logs;only errors;errors and warnings;all logs`，分别对应`0;1;2;3`. (Default: `3`) 128 | 129 | 130 | 131 | ##
用户注册
132 | 133 | > 用户注册采用构造对象的方式 134 | 135 | **构造对象名** 136 | 137 | `plateUser` 138 | 139 | **构造对象解释** 140 | 141 | 该对象用于在信令服务器进行注册，对象建立成功即说明已经在信令服务器注册成功. 142 | 143 | **构造对象参数列表** 144 | 145 | ```javascript 146 | (plateUserID, connOption) 147 | ``` 148 | 149 | **构造对象参数解释** 150 | 151 | `plateUserID`表示在信令服务器注册的唯一编码，若编码冲突，则会返回空对象. 152 | 153 | `connOption`表示信令服务器的连接参数，具体内容请见[信令服务器全局变量表](#信令服务器全局变量表) 154 | 155 | **返回值** 156 | 157 | 当对象在信令服务器注册成功，返回对应的对象. 158 | 159 | 若注册失败，返回一个空对象. 160 | 161 | **备注** 162 | 163 | 建议用户将其设置为全局变量，方便随时调用获取. 164 | 165 | 或者在该变量离开作用域之前，将对象与信令服务器的连接断开. 166 | 167 | 168 | 169 | ##
用户连接
 170 | 171 | **对象名** 172 | 173 | `plateDataConn` 174 | 175 | **对象解释** 176 | 177 | 该对象用于表征用户之间的数据通道，对象存在即说明数据通道已成功建立. 178 | 179 | **备注** 180 | 181 | 该对象无法采用构造对象的方式来得到，只能通过以下的`connect`以及`connectAll`方法来得到. 182 | 183 | 得到该方法的前提是需要拥有`plateUser`对象并已成功在信令服务器注册. 184 | 185 | 186 | 187 | --- 188 | 189 | **对象方法名** 190 | 191 | `isOpen` 192 | 193 | **对象方法解释** 194 | 195 | 该方法隶属于`plateDataConn`对象，该方法可以判断对象内是否存在已开放的数据通道. 196 | 197 | **对象方法参数列表** 198 | 199 | 无 200 | 201 | **返回值** 202 | 203 | `true`或`false`，表示是否存在已开放的数据通道. 204 | 205 | 206 | 207 | --- 208 | 209 | **对象方法名** 210 | 211 | `on` 212 | 213 | **对象方法解释** 214 | 215 | 该方法隶属于`plateDataConn`对象，该方法定义了数据通道连接后用户希望执行的动作. 216 | 217 | **对象方法参数列表** 218 | 219 | ```javascript 220 | (event, callback) 221 | ``` 222 | 223 | **对象方法参数解释** 224 | 225 | `event`表示事件选项，有以下选择 226 | 227 | * 'open' 228 | 229 | * 表示数据通道打开时. 230 | 231 | * 'close' 232 | 233 | * 表示数据通道关闭时. 234 | 235 | * 'error' 236 | 237 | * 表示数据通道出错时. 238 | 239 | * 'data' 240 | 241 | * 表示数据通道收到数据时. 242 | 243 | 244 | `callback`表示回调函数，可由用户自定义，其中在`open`以及`close`事件下，回调函数无函数参数；在`error`事件下，回调函数存在一个函数参数`err`；在`data`事件下，回调函数存在一个函数参数`data`. 245 | 246 | **返回值** 247 | 248 | 无 249 | 250 | 251 | 252 | --- 253 | 254 | **对象方法名** 255 | 256 | `connect` 257 | 258 | **对象方法解释** 259 | 260 | 该方法隶属于`plateUser`对象，可以在拥有该对象后，调用该对象的`connect`方法来建立数据通道. 261 | 262 | **对象方法参数列表** 263 | 264 | ```javascript 265 | (targetUserID) 266 | ``` 267 | 268 | **对象方法参数解释** 269 | 270 | `targetUserID`表示当前用户希望建立单数据通道连接的用户ID，该ID需要在信令服务器已注册. 271 | 272 | **返回值** 273 | 274 | 若对象希望连接的对方ID已在信令服务器注册，则返回`plateUserConn`对象. 275 | 276 | 若对方ID未注册，则返回空对象. 277 | 278 | 279 | 280 | --- 281 | 282 | **对象方法名** 283 | 284 | `connect` 285 | 286 | **对象方法解释** 287 | 288 | 该方法隶属于`plateUser`对象，可以在拥有该对象后，调用该对象的`connect`方法来建立数据通道. 289 | 290 | **对象方法参数列表** 291 | 292 | ```javascript 293 | (targetUserID) 294 | ``` 295 | 296 | **对象方法参数解释** 297 | 298 | `targetUserID`表示当前用户希望建立单数据通道连接的用户ID，该ID需要在信令服务器已注册. 299 | 300 | **返回值** 301 | 302 | 若对象希望连接的对方ID已在信令服务器注册，则返回`plateUserConn`对象. 303 | 304 | 若对方ID未注册，则返回空对象. 305 | 306 | 307 | 308 | --- 309 | 310 | **对象方法名** 311 | 312 | `connectAll` 313 | 314 | **对象方法解释** 315 | 316 | 该方法隶属于`plateUser`对象，可以在拥有该对象后，调用该方法的`connectAll`方法，来建立一个广播方式的数据通道. 317 | 318 | **对象方法参数列表** 319 | 320 | 无 321 | 322 | **返回值** 323 | 324 | 不论当前信令服务器是否有其他用户已注册，都会返回一个`plateDataConn`对象. 325 | 326 | **备注** 327 | 328 | 每当有新的用户在同一个信令服务器注册，都会隐式地建立一条数据通道连接并添加到`plateDataConn`对象内. 329 | 330 | 331 | 332 | ##
数据传输
 333 | 334 | **对象方法名** 335 | 336 | `send` 337 | 338 | **对象方法解释** 339 | 340 | 该方法隶属于`plateDataConn`对象，用于在对应的数据通道中传输数据. 341 | 342 | **对象方法参数列表** 343 | 344 | ```javascript 345 | (data) 346 | ``` 347 | 348 | **对象方法参数解释** 349 | 350 | `data`表示希望传输的数据，在底层会被编码为二进制包的方式传输. 351 | 352 | **返回值** 353 | 354 | 无 355 | 356 | **备注** 357 | 358 | 推荐用户以`Json`的方式传输数据. 359 | 360 | 361 | 362 | --- 363 | 364 | ### 更方便的方法 365 | 366 | **全局函数名** 367 | 368 | `sendMessage` 369 | 370 | **全局函数解释** 371 | 372 | 该方法为全局函数，用于传输数据. 373 | 374 | **全局函数参数列表** 375 | 376 | ```javascript 377 | (plateUser, plateDataConn, targetUserID, action, data) 378 | ``` 379 | 380 | **全局变量参数解释** 381 | 382 | `plateUser`表示`plateUser`对象，需要确保该对象已经存在，否则函数会直接退出. 383 | 384 | `plateDataConn`表示`plateDataConn`数据通道对象，无需确保该对象是否为空或非空，若为非空，函数内会主动建立数据通道. 385 | 386 | `targetUserID`表示希望建立连接数据通道的对象，可以是单个`targetUserID`，也可以是`targetUserID`组成的列表. 387 | 388 | `action`表示传递事件动作，该动作由用户自定义，可以用来区分数据的导向. 389 | 390 | `data`表示传输的具体数据，该动作由用户自定义. 391 | 392 | **备注** 393 | 394 | `action`并非先前提到的`open`、`close`、`error`、`data`，可以与这些定义重名. 395 | 396 | 397 | 398 | ##
数据通道关闭
 399 | 400 | **对象方法名** 401 | 402 | `close` 403 | 404 | **对象方法解释** 405 | 406 | 该方法隶属于`plateDataConn`对象，用来关闭数据通道. 407 | 408 | **对象方法参数列表** 409 | 410 | 无 411 | 412 | **返回值** 413 | 414 | 无 415 | 416 | 417 | 418 | ##
用户注销
 419 | 420 | **对象方法名** 421 | 422 | `close` 423 | 424 | **对象方法解释** 425 | 426 | 该方法隶属于`plateUser`对象，用来注销在信令服务器的注册. 427 | 428 | **对象方法参数列表** 429 | 430 | 无 431 | 432 | **返回值** 433 | 434 | 无 435 | 436 | 437 | 438 | ##
前端组件
 439 | 440 | **全局函数名** 441 | 442 | `canvasInit` 443 | 444 | **全局函数解释** 445 | 446 | 该方法为全局函数，用于初始化画板操作. 447 | 448 | **全局函数参数列表** 449 | 450 | ```javascript 451 | (canvasID, mouseDownAction, mouseMoveAction, mouseUpAction) 452 | ``` 453 | 454 | **全局变量参数解释** 455 | 456 | `canvasID`表示前端设置的`canvas`的`id`. 457 | 458 | `mouseDownAction`表示回调函数，可为空，为画板内鼠标按下的操作，回调函数含有一个函数参数`e`，其中包含了鼠标的位置坐标信息. 459 | 460 | `mouseMoveAction`表示回调函数，可为空，画板内鼠标移动的操作，回调函数含有一个函数参数`e`，其中包含了鼠标的位置坐标信息. 461 | 462 | `mouseUpAction`表示回调函数，可为空，画板内鼠标抬起的操作，回调函数含有一个函数参数`e`，其中包含了鼠标的位置坐标信息. 463 | 464 | **备注** 465 | 466 | 画板元素在前端可以以`canvas`形式实现，`mouseDownAction`、`mouseMoveAction`、`mouseUpAction`都有默认的行为，对画板行为做了整体的设计；并且初始化了画板数据的数据通道. 467 | 468 | 469 | 470 | --- 471 | 472 | **全局函数名** 473 | 474 | `imageBoardInit` 475 | 476 | **全局函数解释** 477 | 478 | 该方法为全局函数，用于初始化图板操作. 479 | 480 | **全局函数参数列表** 481 | 482 | ```javascript 483 | (imageBoardID, imageBoardCallback) 484 | ``` 485 | 486 | **全局变量参数解释** 487 | 488 | `imageBoardID`表示前端设置的`imageboard`的`id`. 489 | 490 | `imageBoardCallback`表示回调函数，可为空，可以执行用户自定义的画板操作，回调函数含有一个`imageboard`函数参数. 491 | 492 | **备注** 493 | 494 | 图板元素在前端可以以`div`形式实现，图板有默认的行为，对图板行为做了整体的设计，并且初始化了图板数据的数据通道. 495 | 496 | 497 | 498 | --- 499 | 500 | **全局函数名** 501 | 502 | `videoInit` 503 | 504 | **全局函数解释** 505 | 506 | 该方法为全局函数，用于初始化视频接口操作. 507 | 508 | **全局函数参数列表** 509 | 510 | ```javascript 511 | (videoID, videoCallback, audioCallback) 512 | ``` 513 | 514 | **全局变量参数解释** 515 | 516 | `videoID`表示前端设置的`video`的`id`. 517 | 518 | `videoCallback`表示回调函数，可为空，可以执行用户对视频流的自定义的操作，回调函数含有一个视频流`videoStream`函数参数. 519 | 520 | `audioCallback`表示回调函数，可为空，可以执行用户对音频流的自定义的操作，回调函数含有一个音频流`audioStream`函数参数. 521 | 522 | **备注** 523 | 524 | 视频元素在前端可以以`video`形式实现，视频流、音频流处理有默认的行为，对视频流、音频流行为做了整体的设计，并且初始化了视频流、音频流数据的数据通道. 525 | 526 | 527 | 528 | --- 529 | 530 | **全局函数名** 531 | 532 | `chatBoardInit` 533 | 534 | **全局函数解释** 535 | 536 | 该方法为全局函数，用于初始化聊天面板操作. 537 | 538 | **全局函数参数列表** 539 | 540 | ```javascript 541 | (chatBoardID, chatMessageCallback) 542 | ``` 543 | 544 | **全局变量参数解释** 545 | 546 | `chatBoardID`表示前端设置的`chatBoard`的`id`. 547 | 548 | `chatMessageCallback`表示回调函数，可为空，可以执行用户对对话数据的自定义的操作，回调函数含有一个对话数据`messageData`函数参数. 549 | 550 | **备注** 551 | 552 | 聊天面板元素在前端可以以`div`形式实现，对话数据处理有默认的行为，对对话数据行为做了整体的设计，并且初始化了对话数据的数据通道. 553 | 554 | 555 | 556 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------