com.alogic.blob.BlobManager Maven / Gradle / Ivy

Go to download
package com.alogic.blob;

import java.util.List;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Element;

import com.anysoft.util.BaseException;
import com.anysoft.util.Configurable;
import com.anysoft.util.JsonTools;
import com.anysoft.util.Properties;
import com.anysoft.util.PropertiesConstants;
import com.anysoft.util.Reportable;
import com.anysoft.util.Settings;
import com.anysoft.util.XMLConfigurable;
import com.anysoft.util.XmlElementProperties;
import com.anysoft.util.XmlTools;
import com.anysoft.webloader.ShareTool;

/**
 * Blob管理器
 * @author yyduan
 * 
 * @version 1.6.4.37 [duanyy 20151218] 

 * - 为指定的文件生成共享路径 

 * 
 * @version 1.6.11.53 [20180817 duanyy] 

 * - 共享路径可以定制filename和contentType 

 *
 * @version 1.6.13.3 [20200422 duanyy] 

 * - blob增加protected属性,如果为true,那么blob将不再通过share机制分享;
 *
 * @version 1.6.13.18 [20200927 duanyy] 

 * - 增加getFile接口，可以传入更多参数 

 */
public interface BlobManager extends XMLConfigurable,Configurable,Reportable{
	
	/**
	 * 获取id
	 * @return id
	 */
	public String getId();
	
	/**
	 * 新建Blob文件
	 * 
	 * @param id 文件ID
	 * @return BlobWriter实例
	 * 
	 */
	public BlobWriter newFile(String id);

	/**
	 * 新建Blob文件
	 * @param id 文件id
	 * @param ctx 上下文
	 * @return BlobWriter实例
	 */
	public BlobWriter newFile(String id,Properties ctx);
	
	/**
	 * 查找已存在的Blob文件
	 * 
	 * @param id 文件ID
	 * @return BlobReader实例
	 */
	public BlobReader getFile(String id);
	
	/**
	 * Blob文件是否存在
	 * @param id 文件ID
	 * @return true|false
	 */
	public boolean existFile(String id);
	
	/**
	 * 删除文件
	 * @param id 文件id
	 */
	public boolean deleteFile(String id);
	
	/**
	 * 为指定的文件生成分享的URL
	 * @param id 文件id
	 * @return 分享的url
	 */
	public String getSharePath(String id,String filename,String contentType);
	
	/**
	 * 扫描文件注册表（可能有的实现不支持）
	 * 
	 * @param ids 用来存储文件id的容器
	 * @param cookies 扫描上下文
	 * @param limit 限制记录数
	 * @return cookies 扫描上下文
	 */
	public String list(List ids,String cookies,int limit);	
	
	/**
	 * 虚基类
	 * @author yyduan
	 *
	 */
	public abstract static class Abstract implements BlobManager{
		/**
		 * a logger of log4j
		 */
		protected static final Logger LOG = LoggerFactory.getLogger(BlobManager.class);
		
		/**
		 * id
		 */
		protected String id;
		
		protected ShareTool tool = null;

		protected boolean isProtected = false;
		
		@Override
		public void configure(Element e, Properties p) {
			Properties props = new XmlElementProperties(e,p);
			configure(props);
		}
		
		@Override
		public void configure(Properties p){
			id = PropertiesConstants.getString(p,"id","",true);
			tool = Settings.getToolkit(ShareTool.class);
			isProtected = PropertiesConstants.getBoolean(p,"protected",false,true);
		}
		
		@Override
		public void report(Element xml) {
			if (xml != null){
				XmlTools.setString(xml, "module", getClass().getName());
				XmlTools.setString(xml,"id",getId());
			}
		}

		@Override
		public BlobWriter newFile(String id,Properties ctx){
			return newFile(id);
		}

		@Override
		public void report(Map json) {
			if (json != null){
				JsonTools.setString(json,"module",getClass().getName());
				JsonTools.setString(json, "id", getId());
			}
		}

		@Override
		public String getId() {
			return id;
		}

		@Override
		public String list(List ids, String cookies, int limit) {
			throw new BaseException("core.e1000","This function is not suppurted yet.");	
		}
		
		@Override
		public String getSharePath(String fileId,String filename,String contentType){
			if (isProtected){
				throw new BaseException("core.e1010",String.format("Blob %s is protected.",this.getId()));
			}
			return tool.encodePath("share.blob",getId(),fileId,filename,contentType);
		}
	}
}