top.coos.extra.servlet.multipart.UploadSetting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coos.component Show documentation
COOS Component Library
There is a newer version: 2.2.7.1
package top.coos.extra.servlet.multipart;

import java.net.URL;

import org.slf4j.Logger;

import top.coos.factory.LogFactory;
import top.coos.setting.Setting;
import top.coos.util.URLUtil;

/**
 * 上传文件设定文件
 * 

 *
 */
public class UploadSetting {

	private static final Logger log = LogFactory.get();

	/** 默认的配置文件路径（相对ClassPath） */
	public final static String DEFAULT_SETTING_PATH = "config/upload.setting";

	/** 最大文件大小，默认无限制 */
	protected int maxFileSize = -1;
	/** 文件保存到内存的边界 */
	protected int memoryThreshold = 8192;
	/** 临时文件目录 */
	protected String tmpUploadPath;
	/** 文件扩展名限定 */
	protected String[] fileExts;
	/** 扩展名是允许列表还是禁止列表 */
	protected boolean isAllowFileExts = true;

	public UploadSetting() {

	}

	// ----------------------------------------------------------------------
	// Setters and Getters start
	/**
	 * @return 获得最大文件大小，-1表示无限制
	 */
	public int getMaxFileSize() {

		return maxFileSize;
	}

	/**
	 * 设定最大文件大小，-1表示无限制
	 * 
	 * @param maxFileSize
	 *            最大文件大小
	 */
	public void setMaxFileSize(int maxFileSize) {

		this.maxFileSize = maxFileSize;
	}

	/**
	 * @return 文件保存到内存的边界
	 */
	public int getMemoryThreshold() {

		return memoryThreshold;
	}

	/**
	 * 设定文件保存到内存的边界

	 * 如果文件大小小于这个边界，将保存于内存中，否则保存至临时目录中
	 * 
	 * @param memoryThreshold
	 *            文件保存到内存的边界
	 */
	public void setMemoryThreshold(int memoryThreshold) {

		this.memoryThreshold = memoryThreshold;
	}

	/**
	 * @return 上传文件的临时目录，若为空，使用系统目录
	 */
	public String getTmpUploadPath() {

		return tmpUploadPath;
	}

	/**
	 * 设定上传文件的临时目录，null表示使用系统临时目录
	 * 
	 * @param tmpUploadPath
	 *            临时目录，绝对路径
	 */
	public void setTmpUploadPath(String tmpUploadPath) {

		this.tmpUploadPath = tmpUploadPath;
	}

	/**
	 * @return 文件扩展名限定列表
	 */
	public String[] getFileExts() {

		return fileExts;
	}

	/**
	 * 设定文件扩展名限定里列表

	 * 禁止列表还是允许列表取决于isAllowFileExts
	 * 
	 * @param fileExts
	 *            文件扩展名列表
	 */
	public void setFileExts(String[] fileExts) {

		this.fileExts = fileExts;
	}

	/**
	 * 是否允许文件扩展名

	 * 
	 * @return 若true表示只允许列表里的扩展名，否则是禁止列表里的扩展名
	 */
	public boolean isAllowFileExts() {

		return isAllowFileExts;
	}

	/**
	 * 设定是否允许扩展名
	 * 
	 * @param isAllowFileExts
	 *            若true表示只允许列表里的扩展名，否则是禁止列表里的扩展名
	 */
	public void setAllowFileExts(boolean isAllowFileExts) {

		this.isAllowFileExts = isAllowFileExts;
	}

	// ----------------------------------------------------------------------
	// Setters and Getters end

	/**
	 * 加载全局设定

	 * 使用默认的配置文件classpath/config/upload.setting
	 */
	public void load() {

		load(DEFAULT_SETTING_PATH);
	}

	/**
	 * 加载全局设定
	 * 
	 * @param settingPath
	 *            设定文件路径，相对Classpath
	 */
	synchronized public void load(String settingPath) {

		URL url = URLUtil.getURL(settingPath);
		if (url == null) {
			log.info("Can not find Upload setting file [{}], use default setting.", settingPath);
			return;
		}
		Setting setting = new Setting(url, Setting.DEFAULT_CHARSET, true);

		maxFileSize = setting.getInt("file.size.max");
		memoryThreshold = setting.getInt("memory.threshold");
		tmpUploadPath = setting.getStr("tmp.upload.path");
		fileExts = setting.getStrings("file.exts");
		isAllowFileExts = setting.getBool("file.exts.allow");
	}
}