forked from OpenVidu/openvidu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial logic in openvidu-java-client to add to the ConnectionPropert…
…ies class a new 'customIceServers' parameter
- Loading branch information
Showing
3 changed files
with
226 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
openvidu-java-client/src/main/java/io/openvidu/java/client/IceServerProperties.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| package io.openvidu.java.client; | ||
|
|
||
| import com.google.gson.JsonObject; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| public class IceServerProperties { | ||
|
|
||
| private String url; | ||
| private String username; | ||
| private String credential; | ||
|
|
||
| public String getUrl() { | ||
| return url; | ||
| } | ||
|
|
||
| public String getUsername() { | ||
| return username; | ||
| } | ||
|
|
||
| public String getCredential() { | ||
| return credential; | ||
| } | ||
|
|
||
| private IceServerProperties(String url, String username, String credential) { | ||
| this.url = url; | ||
| this.username = username; | ||
| this.credential = credential; | ||
| } | ||
|
|
||
| /** | ||
| * Ice server properties following RTCIceServers format: | ||
| * https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer/urls | ||
| * @return | ||
| */ | ||
| public JsonObject toJson() { | ||
| JsonObject json = new JsonObject(); | ||
| json.addProperty("urls", getUrl()); | ||
| if (getUsername() != null && !getUsername().isEmpty()) { | ||
| json.addProperty("username", getUsername()); | ||
| } | ||
| if (getCredential() != null && !getCredential().isEmpty()) { | ||
| json.addProperty("credential", getCredential()); | ||
| } | ||
| return json; | ||
| } | ||
|
|
||
| public static class Builder { | ||
|
|
||
| private String url; | ||
| private String username; | ||
| private String credential; | ||
|
|
||
| public IceServerProperties.Builder url(String url) { | ||
| this.url = url; | ||
| return this; | ||
| } | ||
|
|
||
| public IceServerProperties.Builder username(String userName) { | ||
| this.username = userName; | ||
| return this; | ||
| } | ||
|
|
||
| public IceServerProperties.Builder credential(String credential) { | ||
| this.credential = credential; | ||
| return this; | ||
| } | ||
|
|
||
|
|
||
| public IceServerProperties build() throws IllegalArgumentException { | ||
| if (this.url == null) { | ||
| throw new IllegalArgumentException("External turn url cannot be null"); | ||
| } | ||
| this.checkValidStunTurn(this.url); | ||
| if (this.username == null ^ this.credential == null) { | ||
| // If one is null when the other is defined, fail... | ||
| throw new IllegalArgumentException("You need to define username and credentials if you define one of them"); | ||
| } | ||
| if (this.username != null && this.credential != null && this.url.startsWith("stun")) { | ||
| // Credentials can not be defined using stun | ||
| throw new IllegalArgumentException("Credentials can not be defined while using stun."); | ||
| } | ||
| return new IceServerProperties(this.url, this.username, this.credential); | ||
| } | ||
|
|
||
| /** Parsing Turn Stun Uri based on: | ||
| * - https://datatracker.ietf.org/doc/html/rfc7065#section-3.1 | ||
| * - https://datatracker.ietf.org/doc/html/rfc7064#section-3.1 | ||
| */ | ||
| private void checkValidStunTurn(String uri) throws IllegalArgumentException { | ||
| final String TCP_TRANSPORT_SUFFIX = "?transport=tcp"; | ||
| final String UDP_TRANSPORT_SUFFIX = "?transport=udp"; | ||
|
|
||
| // Protocols which accepts transport=tcp and transport=udp | ||
| final Set<String> TURN_PROTOCOLS = new HashSet<>(Arrays.asList( | ||
| "turn", | ||
| "turns" | ||
| )); | ||
| final Set<String> STUN_PROTOCOLS = new HashSet<>(Arrays.asList( | ||
| "stun", | ||
| "stuns" | ||
| )); | ||
|
|
||
| // Fails if no colons | ||
| int firstColonPos = uri.indexOf(':'); | ||
| if (firstColonPos == -1) { | ||
| throw new IllegalArgumentException("Not a valid TURN/STUN uri provided. " + | ||
| "No colons found in: '" + uri + "'"); | ||
| } | ||
|
|
||
| // Get protocol and check | ||
| String protocol = uri.substring(0, firstColonPos); | ||
| if (!TURN_PROTOCOLS.contains(protocol) && !STUN_PROTOCOLS.contains(protocol)) { | ||
| throw new IllegalArgumentException("The protocol '" + protocol + "' is invalid. Only valid values are: " | ||
| + TURN_PROTOCOLS + " " + STUN_PROTOCOLS); | ||
| } | ||
|
|
||
| // Check if query param with transport exist | ||
| int qmarkPos = uri.indexOf('?'); | ||
| String hostAndPort = uri.substring(firstColonPos + 1); | ||
| if (qmarkPos != -1) { | ||
| if (TURN_PROTOCOLS.contains(protocol)) { | ||
| // Only Turn uses transport arg | ||
| String rawTransportType = uri.substring(qmarkPos); | ||
| hostAndPort = uri.substring(firstColonPos + 1, qmarkPos); | ||
| if (!TCP_TRANSPORT_SUFFIX.equals(rawTransportType) && !UDP_TRANSPORT_SUFFIX.equals(rawTransportType)) { | ||
| // If other argument rather than transport is specified, it is a wrong query for a STUN/TURN uri | ||
| throw new IllegalArgumentException("Wrong value specified in STUN/TURN uri: '" | ||
| + uri + "'. " + "Unique valid arguments after '?' are '" | ||
| + TCP_TRANSPORT_SUFFIX + "' or '" + UDP_TRANSPORT_SUFFIX); | ||
| } | ||
| } else { | ||
| throw new IllegalArgumentException("STUN uri can't have any '?' query param"); | ||
| } | ||
| } | ||
|
|
||
| // Check if port is defined | ||
| int portColon = hostAndPort.indexOf(':'); | ||
| if (portColon != -1) { | ||
| String[] splittedHostAndPort = hostAndPort.split(":"); | ||
| if (splittedHostAndPort.length != 2) { | ||
| throw new IllegalArgumentException("Host or port are not correctly " + | ||
| "defined in STUN/TURN uri: '" + uri + "'"); | ||
| } | ||
| String host = splittedHostAndPort[0]; | ||
| String port = splittedHostAndPort[1]; | ||
|
|
||
| // Check if host is defined. Valid Host (Domain or IP) will be done at server side | ||
| if (host == null || host.isEmpty()) { | ||
| throw new IllegalArgumentException("Host defined in '" + uri + "' is empty or null"); | ||
| } | ||
|
|
||
| if (port == null || port.isEmpty()) { | ||
| throw new IllegalArgumentException("Port defined in '" + uri + "' is empty or null"); | ||
| } | ||
| try { | ||
| int parsedPort = Integer.parseInt(port); | ||
| if (parsedPort <= 0 || parsedPort > 65535) { | ||
| throw new IllegalArgumentException("The port defined in '" + uri + "' is not a valid port number"); | ||
| } | ||
| } catch (NumberFormatException e) { | ||
| throw new IllegalArgumentException("The port defined in '" + uri + "' is not a number"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |