Scheme of work
This method is invoked only once when the browser page connects to the WCS server via the Websocket protocol.
...
- On the browser side, Flashphoner.createSession() is executed. After that the browser attempts to establish connection to WCS
- WCS calls the connect REST method
- WCS receives 200 OK response and based on the answer, authorizes this connection attempt.
- WCS sends a confirmation to the browser as a ConnectionStatusEvent event with the ESTABLISHED status.
Example:
2 | 3 |
|---|
| Code Block |
|---|
| POST /EchoApp/connect HTTP/1.1
Accept: application/json, application/*+json
Content-Type: application/json;charset=UTF-8
User-Agent: Java/1.8.0_45
Host: localhost:9091
Connection: keep-alive
Content-Length: 537
{
"nodeId":"H4gfHeULtX6ddGGUWwZxhUNyqZHUFH8j@192.168.1.59",
"appKey":"defaultApp",
"sessionId":"/192.168.1.38:64604/192.168.1.59:8443",
"useWsTunnel":false,
"useWsTunnelPacketization2":false,
"useBase64BinaryEncoding":false,
"mediaProviders":[
"WebRTC",
"WSPlayer"
],
"clientVersion":"0.5.16",
"clientOSVersion":"5.0 (Windows NT 6.3; WOW64)",
"clientBrowserVersion":"Mozilla/5.0 (Windows NT 6.3; WOW64)"
} |
| | Code Block |
|---|
| HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 26 Feb 2017 23:54:06 GMT
{
"nodeId":"H4gfHeULtX6ddGGUWwZxhUNyqZHUFH8j@192.168.1.59",
"appKey":"defaultApp",
"sessionId":"/192.168.1.38:64604/192.168.1.59:8443",
"useWsTunnel":false,
"useWsTunnelPacketization2":false,
"useBase64BinaryEncoding":false,
"mediaProviders":[
"WebRTC",
"WSPlayer"
],
"clientVersion":"0.5.16",
"clientOSVersion":"5.0 (Windows NT 6.3; WOW64)",
"clientBrowserVersion":"Mozilla/5.0 (Windows NT 6.3; WOW64)"
} |
|
Authentication
By default, WCS successfully authenticates all Websocket connections. That is, the built-in server at http://localhost:9091/EchoApp/connect always returns 200 OK.
...
WCS transfers this field to the web server as the JSON body, and the web server can decide whether or not to authenticate based on these data.
Example:
2 | 3 |
|---|
| Code Block |
|---|
| POST /rest/my_api/connect HTTP/1.1
Accept: application/json, application/*+json
Content-Type: application/json;charset=UTF-8
User-Agent: Java/1.8.0_111
Host: 192.168.1.101
Connection: keep-alive
Content-Length: 578
{
"nodeId":"Hw47CFMBEchVOpBMDr29IxjudnJ1sjOY@192.168.1.101",
"appKey":"defaultApp",
"sessionId":"/192.168.1.102:60204/192.168.1.101:8443",
"useWsTunnel":false,
"useWsTunnelPacketization2":false,
"useBase64BinaryEncoding":false,
"mediaProviders":[
"WebRTC",
"WSPlayer"
],
"clientVersion":"0.5.16",
"clientOSVersion":"5.0 (Windows NT 6.3; Win64; x64)",
"clientBrowserVersion":"Mozilla/5.0 (Windows NT 6.3; Win64; x64)",
"custom":{
"token":"abcdef"
}
} |
| | Code Block |
|---|
| HTTP/1.1 403 Forbidden
Date: Tue, 28 Feb 2017 09:05:56 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: PHP/5.3.3
Content-Length: 0
Connection: close
Content-Type: text/html; charset=UTF-8 |
|
Configuring other REST methods
...
This setting is only applied if the previous restPolicy is set to OVERWRITE, that is it does not allow redefining fields with data received in the JSON body of the 200 OK response. The current value is empty, which means no fields can be redefined. To redefine a field, the list of fields must be specified explicitly, for example: restOverwrite="name,width"
Example:
2 | 3 |
|---|
| Code Block |
|---|
| POST /rest/my_api/connect HTTP/1.1
Accept: application/json, application/*+json
Content-Type: application/json;charset=UTF-8
User-Agent: Java/1.8.0_111
Host: 192.168.1.101
Connection: keep-alive
Content-Length: 550
{
"nodeId":"Hw47CFMBEchVOpBMDr29IxjudnJ1sjOY@192.168.1.101",
"appKey":"defaultApp",
"sessionId":"/192.168.1.102:26518/192.168.1.101:8443",
"useWsTunnel":false,
"useWsTunnelPacketization2":false,
"useBase64BinaryEncoding":false,
"mediaProviders":[
"WebRTC",
"WSPlayer"
],
"clientVersion":"0.5.16",
"clientOSVersion":"5.0 (Windows NT 6.3; Win64; x64)",
"clientBrowserVersion":"Mozilla/5.0 (Windows NT 6.3; Win64; x64)"
} |
| | Code Block |
|---|
| HTTP/1.1 200 OK
Date: Tue, 28 Feb 2017 10:11:03 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: PHP/5.3.3
Content-Length: 833
Connection: close
Content-Type: application/json
{
"nodeId":"Hw47CFMBEchVOpBMDr29IxjudnJ1sjOY@192.168.1.101",
"appKey":"defaultApp",
"sessionId":"\/192.168.1.102:26518\/192.168.1.101:8443",
"useWsTunnel":false,
"useWsTunnelPacketization2":false,
"useBase64BinaryEncoding":false,
"mediaProviders":[
"WebRTC",
"WSPlayer"
],
"clientVersion":"0.5.16",
"clientOSVersion":"5.0 (Windows NT 6.3; Win64; x64)",
"clientBrowserVersion":"Mozilla\/5.0 (Windows NT 6.3; Win64; x64)",
"restClientConfig":{
"publishStream":{
"clientExclude":"",
"restExclude":"recordName",
"restOnError":"FAIL",
"restPolicy":"NOTIFY",
"restOverwrite":""
},
"playStream":{
"clientExclude":"",
"restExclude":"",
"restOnError":"LOG",
"restPolicy":"OVERWRITE",
"restOverwrite":"height,width"
}
}
} |
|