V2NIMProxyRequest.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.passthrough.model;

import android.text.TextUtils;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.v2.passthrough.enums.V2NIMProxyRequestMethod;
import com.netease.nimlib.util.StringUtil;
import java.io.Serializable;

/**
 * 代理的http请求参数
 */
public class V2NIMProxyRequest implements Serializable {

    private static final String TAG = "V2NIMProxyRequest";


    /**
     * 映射一个upstream host，不传用默认配置
     */
    private String zone;

    /**
     * url中除了host的path path不能为空， 为空返回参数错误
     */
    private final String path;

    /**
     * 请求方式 GET请求， 如果body非空， 则返回参数错误 POST/PUT, 如果body为空，范围参数错误
     */
    private V2NIMProxyRequestMethod method = V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_POST;

    /**
     * 请求头，必须要求json格式 非json格式返回参数错误
     */
    private String header;

    /**
     * 请求体
     */
    private String body;


    /**
     * 构造函数
     *
     * @param zone   映射一个upstream host， 不传使用默认配置
     * @param path   url中除了host的path
     * @param method 请求方式
     * @param header 请求头
     * @param body   请求体
     */
    public V2NIMProxyRequest(String zone, String path, V2NIMProxyRequestMethod method, String header, String body) {
        this.zone = zone;
        this.path = path;
        this.method = method;
        this.header = header;
        this.body = body;
    }

    /**
     * 构造函数
     *
     * @param path   url中除了host的path
     * @param method 请求方式
     * @param header 请求头
     * @param body   请求体
     */
    public V2NIMProxyRequest(String path, V2NIMProxyRequestMethod method, String header, String body) {
        this(null, path, method, header, body);
    }

    /**
     * 构造函数
     *
     * @param path   url中除了host的path
     * @param header 请求头
     * @param body   请求体
     */
    public V2NIMProxyRequest(String path, String header, String body) {
        this(path, V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_POST, header, body);
    }

    /**
     * 构造函数
     *
     * @param path url中除了host的path
     */
    public V2NIMProxyRequest(String path) {
        this(path, null, null);
    }

    private V2NIMProxyRequest() {
        this.path = null;
        this.method = V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_POST;
    }

    /**
     * 获取zone
     *
     * @return zone 映射一个upstream host
     */
    public String getZone() {
        return zone;
    }

    /**
     * 设置zone
     *
     * @param zone 映射一个upstream host
     */
    public void setZone(String zone) {
        this.zone = zone;
    }

    /**
     * 获取path
     *
     * @return path url中除了host的path
     */
    public String getPath() {
        return path;
    }

    /**
     * 获取method
     *
     * @return method 请求方式
     */
    public V2NIMProxyRequestMethod getMethod() {
        if (method == null) {
            return V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_POST;
        }
        return method;
    }

    /**
     * 设置method
     *
     * @param method 请求方式
     */
    public void setMethod(V2NIMProxyRequestMethod method) {
        this.method = method;
    }

    /**
     * 获取header
     *
     * @return header 请求头
     */
    public String getHeader() {
        return header;
    }

    /**
     * 设置header
     *
     * @param header 请求头
     */
    public void setHeader(String header) {
        this.header = header;
    }

    /**
     * 获取body
     *
     * @return body 请求体
     */
    public String getBody() {
        return body;
    }

    /**
     * 设置body
     *
     * @param body 请求体
     */
    public void setBody(String body) {
        this.body = body;
    }

    /**
     * 判断是否有效
     *
     * @return
     */
    public boolean isValid() {
        if (TextUtils.isEmpty(path)) {
            NimLog.e(TAG, "path is empty");
            return false;
        }
        if (getMethod() == V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_GET && !TextUtils.isEmpty(body)) {
            NimLog.e(TAG, "body is not empty when method is GET");
            return false;
        }
        if (getMethod() == V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_POST && TextUtils.isEmpty(body)) {
            NimLog.e(TAG, "body is empty when method is POST");
            return false;
        }
        if (getMethod() == V2NIMProxyRequestMethod.V2NIM_PROXY_REQUEST_METHOD_PUT && TextUtils.isEmpty(body)) {
            NimLog.e(TAG, "body is empty when method is PUT");
            return false;
        }
        if (!TextUtils.isEmpty(header) && !StringUtil.isJson(header)) {
            NimLog.e(TAG, "header is not json");
            return false;
        }
        return true;
    }

    /**
     * 构建请求参数Builder
     */
    public static class Builder {

        private final V2NIMProxyRequest params;

        /**
         * 构造函数
         *
         * @param path url中除了host的path
         */
        public Builder(String path) {
            params = new V2NIMProxyRequest(path);
        }

        /**
         * 设置zone
         *
         * @param zone 映射一个upstream host
         */
        public Builder withZone(String zone) {
            params.setZone(zone);
            return this;
        }

        /**
         * 设置method
         *
         * @param method 请求方式
         */
        public Builder withMethod(V2NIMProxyRequestMethod method) {
            params.setMethod(method);
            return this;
        }

        /**
         * 设置header
         *
         * @param header 请求头
         */
        public Builder withHeader(String header) {
            params.setHeader(header);
            return this;
        }

        /**
         * 设置body
         *
         * @param body 请求体
         */
        public Builder withBody(String body) {
            params.setBody(body);
            return this;
        }

        /**
         * 构建请求参数
         *
         * @return 请求参数
         */
        public V2NIMProxyRequest build() {
            return params;
        }
    }

}