ServerAddresses.java

浏览该文件的文档.

package com.netease.nimlib.sdk;

import android.util.Pair;
import androidx.annotation.Nullable;
import com.netease.nimlib.push.net.lbs.IPVersion;
import com.netease.nimlib.push.packet.asymmetric.AsymmetricType;
import com.netease.nimlib.push.packet.symmetry.SymmetryType;
import com.netease.nimlib.util.CollectionUtil;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.json.JSONException;
import org.json.JSONObject;

/**
 * 云信私有化服务器配置项
 */
@SuppressWarnings("java:S1104")
public class ServerAddresses implements Serializable {
    public static final String KEY_MODULE = "KEY_MODULE";
    public static final String KEY_PUBLIC_KEY_VERSION = "KEY_PUBLIC_KEY_VERSION";
    public static final String KEY_LBS = "KEY_LBS";
    public static final String KEY_LBS_BACKUP = "KEY_LBS_BACKUP";
    public static final String KEY_DEFAULT_LINK = "KEY_DEFAULT_LINK";
    public static final String KEY_DEFAULT_LINK_BACKUP = "KEY_DEFAULT_LINK_BACKUP";
    public static final String KEY_NOS_UPLOAD_LBS = "KEY_NOS_UPLOAD_LBS";
    public static final String KEY_NOS_UPLOAD_DEFAULT_LINK = "KEY_NOS_UPLOAD_DEFAULT_LINK";
    public static final String KEY_NOS_UPLOAD = "KEY_NOS_UPLOAD";
    public static final String KEY_NOS_SUPPORT_HTTPS = "KEY_NOS_SUPPORT_HTTPS";
    public static final String KEY_NOS_DOWNLOAD_URL_FORMAT = "KEY_NOS_DOWNLOAD_URL_FORMAT";
    public static final String KEY_NOS_DOWNLOAD = "KEY_NOS_DOWNLOAD";
    public static final String KEY_NOS_ACCESS = "KEY_NOS_ACCESS";
    public static final String KEY_NT_SERVER_ADDRESS = "KEY_NT_SERVER_ADDRESS";
    public static final String KEY_BD_SERVER_ADDRESS = "KEY_BD_SERVER_ADDRESS";
    public static final String KEY_TEST = "KEY_TEST";
    public static final String KEY_DEDICATED_CLUSTE_FLAG = "KEY_DEDICATED_CLUSTE_FLAG";
    public static final String KEY_NEGO_KEY_NECA = "KEY_NEGO_KEY_NECA";
    public static final String KEY_NEGO_KEY_ENCA_KEY_VERSION = "KEY_NEGO_KEY_ENCA_KEY_VERSION";
    public static final String KEY_NEGO_KEY_ENCA_KEY_PARTA = "KEY_NEGO_KEY_ENCA_KEY_PARTA";
    public static final String KEY_NEGO_KEY_ENCA_KEY_PARTB = "KEY_NEGO_KEY_ENCA_KEY_PARTB";
    public static final String KEY_COMM_ENCA = "KEY_COMM_ENCA";
    public static final String KEY_LINK_IPV6 = "KEY_LINK_IPV6";
    public static final String KEY_IP_PROTOCOL_VERSION = "KEY_IP_PROTOCOL_VERSION";
    public static final String KEY_PROBE_IPV4_URL = "KEY_PROBE_IPV4_URL";
    public static final String KEY_PROBE_IPV6_URL = "KEY_PROBE_IPV6_URL";
    public static final String KEY_HANDSHAKE_TYPE = "KEY_HANDSHAKE_TYPE";
    public static final String KEY_NOS_CDN_ENABLE = "KEY_NOS_CDN_ENABLE";
    public static final String KEY_NOS_DOWNLOAD_SET = "KEY_NOS_DOWNLOAD_SET";
    public static final String KEY_COMPASS_DATA_ENDPOINT = "KEY_COMPASS_DATA_ENDPOINT";

    /**
     * 连接云信服务器加密数据通道的公钥参数1 rsaModulus
     */
    public String module;

    /**
     * 连接云信服务器加密数据通道的公钥的版本号（默认0）
     */
    public int publicKeyVersion = 0;

    /**
     * IM LBS服务器地址，通过它获取IM link 地址信息
     * 填http/https地址
     *
     * @see ServerAddresses#lbsBackup
     */
    public String lbs;

    /**
     * 备用IM LBS服务器地址，通过它获取IM link 地址信息
     * 填http/https地址
     *
     * @see ServerAddresses#lbs
     */
    public List<String> lbsBackup;

    /**
     * IM 默认的link服务器地址，当IM LBS不可用时先连接该地址
     * 填"IP/Host:PORT"
     */
    public String defaultLink;

    /**
     * IM 默认的link服务器地址不可用时，连接这些地址
     * 填"IP/Host:PORT"
     */
    public List<String> defaultLinkBackup;

    /**
     * NOS上传LBS服务器地址
     * 填http/https地址
     */
    public String nosUploadLbs;

    /**
     * NOS上传默认的link服务器地址，当NOS LBS不可用时先连接该地址
     * 填http/https地址
     */
    public String nosUploadDefaultLink;

    /**
     * NOS上传服务器主机地址（仅nosSupportHttps=true时有效，用作https上传时的域名校验及http header host字段填充）
     * 填host地址
     */
    public String nosUpload;

    /**
     * NOS上传是否需要支持https。SDK 3.2版本后默认支持https，同时需要配置 nosUpload!
     */
    public boolean nosSupportHttps = true;

    /**
     * [4.6.0版本新增] NOS下载地址拼接模板，用于拼接最终得到的下载地址。
     * 默认是 {bucket}.nosdn.127.net/{object}，SDK 上传资源后生成的下载地址为 https://bucket.nosdn.127.net/object
     */
    public String nosDownloadUrlFormat;

    /**
     * NOS下载地址的host，用于拼接最终获得的文件URL地址，也支持该host替换成下载加速域名/地址 nosAccess.
     * 填host地址, 默认是 nos.netease.com
     */
    public String nosDownload;

    /**
     * NOS下载加速域名/地址，用于替换NOS下载url中的 nosDownload。
     * 提供两种方式：
     * 1) [4.4.0+开始支持]模板方式：填写云信规定的两种模板：{bucket}.nosdn.127.net/{object} 或者 nosdn.127.net/{bucket}/{object}，其中 {bucket} 和 {object} 作为标识符，必须填写。域名部分可以替换为您申请的加速域名。
     * 2) [所有版本支持]非模板方式：填写用于加速的 http/https地址，例如：http://111.222.111.22:9090
     */
    public String nosAccess;

    /**
     * 云信运行时异常统计服务器地址
     */
    public String ntServerAddress;

    /**
     * 云信数据统计服务器地址
     */
    public String bdServerAddress;

    /**
     * 是否是测试服
     */
    public boolean test = false;

    /**
     * 是否为专属集群{1(是), 0(否)}
     */
    public int dedicatedClusteFlag;

    /**
     * "交换密钥"协议加密算法 {1(RSA),2(SM2)}, def:1(RSA) 非对称加密
     */
    public AsymmetricType negoKeyNeca = AsymmetricType.RSA;

    /**
     * "交换密钥"协议加密算法密钥版本 version 自定义时则必填
     */
    public int negoKeyEncaKeyVersion;

    /**
     * "交换密钥"协议加密算法密钥 part A 自定义时则必填 BigNumHex string 不含0x RSA: module, SM2: X
     */
    public String negoKeyEncaKeyParta;

    /**
     * "交换密钥"协议加密算法密钥 part B 自定义时则必填 BigNumHex string 不含0x RSA: EXP, SM2: Y
     */
    public String negoKeyEncaKeyPartb;

    /**
     * 通信加密算法 {1(RC4), 2(AES128), 4(SM4)}
     * 默认: 1(RC4) 对称加密
     */
    public SymmetryType commEnca = SymmetryType.RC4;

    /**
     * ipv6的缺省连接地址
     */
    public String linkIpv6;

    /**
     * IP协议版本{0(IPV4), 1(IPV6), 2(Auto, SDK测试后自行选择, 存在性能损耗)}。
     * 默认: 0(IPV4) 非对称加密
     */
    public IPVersion ipProtocolVersion = IPVersion.IPV4;

    /**
     * 探测ipv4地址类型使用的url, IPProtVersion == 2或3 时生效
     */
    public String probeIpv4Url;

    /**
     * 探测ipv6地址类型使用的url, IPProtVersion == 2或3 时生效
     */
    public String probeIpv6Url;

    /**
     * 握手协议选择字段
     */
    public NimHandshakeType handshakeType = NimHandshakeType.V1;

    /**
     * 是否优先使用Cdn域名进行NOS下载
     */
    public boolean nosCdnEnable = true;

    /**
     * 每个元素为使用过的NOS下载地址的特征以及桶名是否在host中组成的{@link Pair}对象
     * 如new Pair("nim.nos.netease.com", true), new Pair("nos.netease.com/nim", false)等
     */
    public Set<String> nosDownloadSet;

    /**
     * 数据上报端点
     */
    public String compassDataEndpoint;


    public JSONObject toJson() {
        JSONObject object = new JSONObject();
        try {
            object.putOpt(KEY_MODULE, module);
            object.putOpt(KEY_PUBLIC_KEY_VERSION, publicKeyVersion);
            object.putOpt(KEY_LBS, lbs);
            object.putOpt(KEY_LBS_BACKUP, CollectionUtil.toString(lbsBackup, ";"));
            object.putOpt(KEY_DEFAULT_LINK, defaultLink);
            object.putOpt(KEY_DEFAULT_LINK_BACKUP, CollectionUtil.toString(defaultLinkBackup, ";"));
            object.putOpt(KEY_NOS_UPLOAD_LBS, nosUploadLbs);
            object.putOpt(KEY_NOS_UPLOAD_DEFAULT_LINK, nosUploadDefaultLink);
            object.putOpt(KEY_NOS_UPLOAD, nosUpload);
            object.putOpt(KEY_NOS_SUPPORT_HTTPS, nosSupportHttps);
            object.putOpt(KEY_NOS_DOWNLOAD_URL_FORMAT, nosDownloadUrlFormat);
            object.putOpt(KEY_NOS_DOWNLOAD, nosDownload);
            object.putOpt(KEY_NOS_ACCESS, nosAccess);
            object.putOpt(KEY_NT_SERVER_ADDRESS, ntServerAddress);
            object.putOpt(KEY_BD_SERVER_ADDRESS, bdServerAddress);
            object.putOpt(KEY_TEST, test);
            object.putOpt(KEY_DEDICATED_CLUSTE_FLAG, dedicatedClusteFlag);
            object.putOpt(KEY_NEGO_KEY_NECA, negoKeyNeca == null ? AsymmetricType.RSA.getValue(): negoKeyNeca.getValue());
            object.putOpt(KEY_NEGO_KEY_ENCA_KEY_VERSION, negoKeyEncaKeyVersion);
            object.putOpt(KEY_NEGO_KEY_ENCA_KEY_PARTA, negoKeyEncaKeyParta);
            object.putOpt(KEY_NEGO_KEY_ENCA_KEY_PARTB, negoKeyEncaKeyPartb);
            object.putOpt(KEY_COMM_ENCA, commEnca == null ? SymmetryType.RC4.getValue() : commEnca.getValue());
            object.putOpt(KEY_LINK_IPV6, linkIpv6);
            object.putOpt(KEY_IP_PROTOCOL_VERSION, ipProtocolVersion == null ? IPVersion.IPV4.getValue() :ipProtocolVersion.getValue());
            object.putOpt(KEY_PROBE_IPV4_URL, probeIpv4Url);
            object.putOpt(KEY_PROBE_IPV6_URL, probeIpv6Url);
            object.putOpt(KEY_HANDSHAKE_TYPE, handshakeType == null ? NimHandshakeType.V1.getValue() : handshakeType.getValue());
            object.putOpt(KEY_NOS_CDN_ENABLE, nosCdnEnable);
            object.putOpt(KEY_NOS_DOWNLOAD_SET, CollectionUtil.toString(nosDownloadSet, ";"));
            object.putOpt(KEY_COMPASS_DATA_ENDPOINT, compassDataEndpoint);
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return object;
    }

    public static ServerAddresses fromJson(@Nullable JSONObject object) {
        if (object == null) {
            return null;
        }
        ServerAddresses serverAddresses = new ServerAddresses();

        serverAddresses.module = object.optString(KEY_MODULE);
        serverAddresses.publicKeyVersion = object.optInt(KEY_PUBLIC_KEY_VERSION);
        serverAddresses.lbs = object.optString(KEY_LBS);
        serverAddresses.lbsBackup = new ArrayList<>(Arrays.asList(object.optString(KEY_LBS_BACKUP).split(";")));
        serverAddresses.defaultLink = object.optString(KEY_DEFAULT_LINK);
        serverAddresses.defaultLinkBackup = new ArrayList<>(Arrays.asList(object.optString(KEY_DEFAULT_LINK_BACKUP).split(";")));
        serverAddresses.nosUploadLbs = object.optString(KEY_NOS_UPLOAD_LBS);
        serverAddresses.nosUploadDefaultLink = object.optString(KEY_NOS_UPLOAD_DEFAULT_LINK);
        serverAddresses.nosUpload = object.optString(KEY_NOS_UPLOAD);
        serverAddresses.nosSupportHttps = object.optBoolean(KEY_NOS_SUPPORT_HTTPS);
        serverAddresses.nosDownloadUrlFormat = object.optString(KEY_NOS_DOWNLOAD_URL_FORMAT);
        serverAddresses.nosDownload = object.optString(KEY_NOS_DOWNLOAD);
        serverAddresses.nosAccess = object.optString(KEY_NOS_ACCESS);
        serverAddresses.ntServerAddress = object.optString(KEY_NT_SERVER_ADDRESS);
        serverAddresses.bdServerAddress = object.optString(KEY_BD_SERVER_ADDRESS);
        serverAddresses.test = object.optBoolean(KEY_TEST);
        serverAddresses.dedicatedClusteFlag = object.optInt(KEY_DEDICATED_CLUSTE_FLAG);
        serverAddresses.negoKeyNeca = AsymmetricType.value(object.optInt(KEY_NEGO_KEY_NECA));
        serverAddresses.negoKeyEncaKeyVersion = object.optInt(KEY_NEGO_KEY_ENCA_KEY_VERSION);
        serverAddresses.negoKeyEncaKeyParta = object.optString(KEY_NEGO_KEY_ENCA_KEY_PARTA);
        serverAddresses.negoKeyEncaKeyPartb = object.optString(KEY_NEGO_KEY_ENCA_KEY_PARTB);
        serverAddresses.commEnca = SymmetryType.value(object.optInt(KEY_COMM_ENCA));
        serverAddresses.linkIpv6 = object.optString(KEY_LINK_IPV6);
        serverAddresses.ipProtocolVersion = IPVersion.value(object.optInt(KEY_IP_PROTOCOL_VERSION));
        serverAddresses.probeIpv4Url = object.optString(KEY_PROBE_IPV4_URL);
        serverAddresses.probeIpv6Url = object.optString(KEY_PROBE_IPV6_URL);
        serverAddresses.handshakeType = NimHandshakeType.value(object.optInt(KEY_HANDSHAKE_TYPE));
        serverAddresses.nosCdnEnable = object.optBoolean(KEY_NOS_CDN_ENABLE);
        serverAddresses.nosDownloadSet = new HashSet<>(Arrays.asList(object.optString(KEY_NOS_DOWNLOAD_SET).split(";")));
        serverAddresses.compassDataEndpoint = object.optString(KEY_COMPASS_DATA_ENDPOINT);
        return serverAddresses;
    }

}