org.nutz.web.Webs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nutz-web Show documentation
Nutz, which is a collections of lightweight frameworks, each of them can be used independently
There is a newer version: 1.r.67
package org.nutz.web;

import org.nutz.ioc.impl.PropertiesProxy;
import org.nutz.lang.Strings;

/**
 * 一些常量和帮助函数的集合
 * 
 * @author zozoh([email protected])
 * @author pw
 */
public class Webs {

    private Webs() {}

    /**
     * 在会话中，表示当前用户的键
     */
    public static final String ME = "me";

    /**
     * 用户密码加密方式在 attributes 里的名称，值可能为 "MD5|SHA1" 等
     */
    public static final String PWD_ENCRYPT = "PWD_ENCRYPT";

    /**
     * 默认配置文件路径
     */
    public static final String CONF_PATH = "web.properties";

    /**
     * 默认的 RS 属性名
     */
    public static final String RS = "rs";

    /**
     * 扫描器出来的结果存放的属性名
     */
    public static final String SCAN_LINKS = "links";

    /**
     * 所有配置信息
     */
    private static PropertiesProxy WEB_PROP = null;

    /**
     * 设置当前web应该的配置文件
     * 
     * @param wp
     */
    protected static void setProp(PropertiesProxy wp) {
        WEB_PROP = wp;
    }

    /**
     * Ｗeb服务启动时加载的配置文件(包含了include)
     * 
     * @return 配置文件
     */
    public static PropertiesProxy getProp() {
        return WEB_PROP;
    }

    /**
     * 本函数用来确保入口函数中的各个字符串型参数不为空
     * 
     * @param s
     *            要检查的字符串
     * @param key
     *            如果出错，错误的键
     */
    public static void NoBlank(String s, String key) {
        if (Strings.isBlank(s)) {
            throw Webs.Err.create(key, s);
        }
    }

    /**
     * 本函数用来确保入口函数中的各个字符串型参数不为空
     * 
     * @param s
     *            要检查的字符串
     * @param key
     *            如果出错，错误的键
     * @param reason
     *            出错的原因
     */
    public static void NoBlank(String s, String key, Object reason) {
        if (Strings.isBlank(s)) {
            throw Webs.Err.create(key, reason);
        }
    }

    /**
     * 本函数用来确保入口函数中的参数不为 null
     * 
     * @param obj
     *            要检查的对象
     * @param key
     *            如果出错，错误的键
     */
    public static void NoNull(Object obj, String key) {
        if (null == obj) {
            throw Webs.Err.create(key);
        }
    }

    /**
     * 封装所有错误
     */
    public static abstract class Err {

        public static WebException create(String key) {
            return create(null, key, null);
        }

        public static WebException create(String key, Object reason) {
            return create(null, key, reason);
        }

        public static WebException create(Throwable e, String key, Object reason) {
            return new WebException(e).key(key).reason(reason);
        }

        public static WebException wrap(Throwable e) {
            if (e instanceof WebException)
                return (WebException) e;
            return new WebException(e).key(e.getClass().getName()).reason(e.toString());
        }

        public static WebException create(Throwable e, String key) {
            return new WebException(e).key(key);
        }

    }

}