NosTokenSceneConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk;

import android.text.TextUtils;
import com.netease.nimlib.NimNosSceneKeyConstant;
import java.util.HashMap;

/**
 * SDK nos token场景配置，不配置的话，走默认值,默认值只有以下3种场景:
 *
 * @see NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE
 * @see NimNosSceneKeyConstant#NIM_DEFAULT_IM
 * @see NimNosSceneKeyConstant#NIM_SYSTEM_NOS_SCENE
 * <p>
 * <p>
 * 默认场景对应的默认过期时间为{@link #NEVER_EXPIRE}，用户可以修改默认场景的过期时间。
 * 同时用户可以新增自己的场景并指定对应的过期时间（sceneKey-> expireTimeByDay），目前最多10个.
 * <p>
 * 用户发送消息或直接上传文件等情况下都可以任意指定相应的场景 ，不指定走默认的。
 * 如果要指定相应的场景，只需要指定相应的sceneKey 即可
 * <p>
 * 强烈建议在配置时，将相应的sceneKey常量化，以方便使用，参考{@link NimNosSceneKeyConstant}
 */
public class NosTokenSceneConfig {

    /**
     * 永不过期,资源一直在于服务器
     */
    public static final long NEVER_EXPIRE = 0L;

    private static final long DAY_SECOND = 60 * 60 * 24L;
    private static final int MIN_CUSTOM_SCENE_COUNT = 10;
    private static final int DEFAULT_CUSTOM_SCENE_COUNT = MIN_CUSTOM_SCENE_COUNT;
    private final static HashMap<String, Long> DEFAULT_SCENE = new HashMap<>();

    private static int sDefaultSceneCount;
    private static NosTokenSceneConfig sDefault = new NosTokenSceneConfig();

    private HashMap<String, Long> mNosTokenScene;

    private  int     maxCustomNosSceneCount  = DEFAULT_CUSTOM_SCENE_COUNT;

    static {
        DEFAULT_SCENE.put(NimNosSceneKeyConstant.NIM_DEFAULT_PROFILE, NEVER_EXPIRE);
        DEFAULT_SCENE.put(NimNosSceneKeyConstant.NIM_DEFAULT_IM, NEVER_EXPIRE);
        DEFAULT_SCENE.put(NimNosSceneKeyConstant.NIM_SYSTEM_NOS_SCENE, NEVER_EXPIRE);
        DEFAULT_SCENE.put(NimNosSceneKeyConstant.NIM_SECURITY_PREFIX, NEVER_EXPIRE);
        sDefaultSceneCount = DEFAULT_SCENE.size();
    }


    public NosTokenSceneConfig() {
        mNosTokenScene = new HashMap<>();
        mNosTokenScene.putAll(DEFAULT_SCENE);
    }

    /**
     * 获取自定义NOS场景最大数量
     * @return
     */
    public int getMaxCustomNosSceneCount() {
        return maxCustomNosSceneCount;
    }

    /**
     * 更新默认场景 {@link NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE}对应的过期时间
     *
     * @param expireTime 过期时间，0表示永不过期，单位： 天
     * @return NosTokenSceneConfig
     */
    public void updateDefaultProfileSceneExpireTime(int expireTime) {
        if (expireTime < 0) {
            throw new IllegalArgumentException("expireTimeByDay must >= 0");
        }
        mNosTokenScene.put(NimNosSceneKeyConstant.NIM_DEFAULT_PROFILE, expireTime * DAY_SECOND);
    }

    /**
     * 更新默认场景 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM }对应的过期时间
     *
     * @param expireTime 过期时间，0表示永不过期，单位： 天
     * @return NosTokenSceneConfig
     */
    public void updateDefaultIMSceneExpireTime(int expireTime) {
        if (expireTime < 0) {
            throw new IllegalArgumentException("expireTimeByDay must >= 0");
        }
        mNosTokenScene.put(NimNosSceneKeyConstant.NIM_DEFAULT_IM, expireTime * DAY_SECOND);
    }


    /**
     * 增加自定义场景
     *
     * @param sceneKey   自定义场景key，使用时需要带上相应的sceneKey
     * @param expireTime 过期时间，0表示永不过期，单位： 天
     * @return NosTokenSceneConfig
     */
    public NosTokenSceneConfig appendCustomScene(String sceneKey, int expireTime) {
        if (expireTime < 0 || TextUtils.isEmpty(sceneKey)) {
            throw new IllegalArgumentException("sceneKey must not empty and expireTimeByDay must >= 0");
        }
        if (mNosTokenScene.size() - sDefaultSceneCount >= maxCustomNosSceneCount) {
            throw new IllegalStateException("the custom scene count must <= " + maxCustomNosSceneCount);
        }
        if (NimNosSceneKeyConstant.NIM_SYSTEM_NOS_SCENE.equals(sceneKey)) {
            throw new IllegalArgumentException("the \"nim_system_nos_scene\" scene cannot be modified");
        }
        mNosTokenScene.put(sceneKey, expireTime * DAY_SECOND);
        return this;
    }

    /**
     * 获取所有场景副本
     *
     * @return 包含所有场景的HashMap
     */
    public HashMap<String, Long> getNosTokenScene() {
        HashMap<String, Long> copy = new HashMap<>(mNosTokenScene.size());
        copy.putAll(mNosTokenScene);
        return copy;
    }

    public static NosTokenSceneConfig defaultConfig() {
        sDefault.mNosTokenScene = DEFAULT_SCENE;
        return sDefault;
    }
}