Source/BladeX-Tool/blade-starter-oss/src/main/java/org/springblade/core/oss/OssTemplate.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,203 @@
/*
 *      Copyright (c) 2018-2028, Chill Zhuang All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the dreamlu.net developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: Chill åº„骞 (smallchill@163.com)
 */
package org.springblade.core.oss;


import org.springblade.core.oss.model.BladeFile;
import org.springblade.core.oss.model.OssFile;
import org.springframework.web.multipart.MultipartFile;

import java.io.InputStream;
import java.util.List;

/**
 * OssTemplate抽象API
 *
 * @author Chill
 */
public interface OssTemplate {

   /**
    * åˆ›å»º å­˜å‚¨æ¡¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    */
   void makeBucket(String bucketName);

   /**
    * åˆ é™¤ å­˜å‚¨æ¡¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    */
   void removeBucket(String bucketName);

   /**
    * å­˜å‚¨æ¡¶æ˜¯å¦å­˜åœ¨
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @return boolean
    */
   boolean bucketExists(String bucketName);

   /**
    * æ‹·è´æ–‡ä»¶
    *
    * @param bucketName     å­˜å‚¨æ¡¶åç§°
    * @param fileName       å­˜å‚¨æ¡¶æ–‡ä»¶åç§°
    * @param destBucketName ç›®æ ‡å­˜å‚¨æ¡¶åç§°
    */
   void copyFile(String bucketName, String fileName, String destBucketName);

   /**
    * æ‹·è´æ–‡ä»¶
    *
    * @param bucketName     å­˜å‚¨æ¡¶åç§°
    * @param fileName       å­˜å‚¨æ¡¶æ–‡ä»¶åç§°
    * @param destBucketName ç›®æ ‡å­˜å‚¨æ¡¶åç§°
    * @param destFileName   ç›®æ ‡å­˜å‚¨æ¡¶æ–‡ä»¶åç§°
    */
   void copyFile(String bucketName, String fileName, String destBucketName, String destFileName);

   /**
    * èŽ·å–文件信息
    *
    * @param fileName å­˜å‚¨æ¡¶æ–‡ä»¶åç§°
    * @return InputStream
    */
   OssFile statFile(String fileName);

   /**
    * èŽ·å–文件信息
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   å­˜å‚¨æ¡¶æ–‡ä»¶åç§°
    * @return InputStream
    */
   OssFile statFile(String bucketName, String fileName);

   /**
    * èŽ·å–文件相对路径
    *
    * @param fileName å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @return String
    */
   String filePath(String fileName);

   /**
    * èŽ·å–文件相对路径
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @return String
    */
   String filePath(String bucketName, String fileName);

   /**
    * èŽ·å–文件地址
    *
    * @param fileName å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @return String
    */
   String fileLink(String fileName);

   /**
    * èŽ·å–文件地址
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @return String
    */
   String fileLink(String bucketName, String fileName);

   /**
    * ä¸Šä¼ æ–‡ä»¶
    *
    * @param file ä¸Šä¼ æ–‡ä»¶ç±»
    * @return BladeFile
    */
   BladeFile putFile(MultipartFile file);

   /**
    * ä¸Šä¼ æ–‡ä»¶
    *
    * @param file     ä¸Šä¼ æ–‡ä»¶ç±»
    * @param fileName ä¸Šä¼ æ–‡ä»¶å
    * @return BladeFile
    */
   BladeFile putFile(String fileName, MultipartFile file);

   /**
    * ä¸Šä¼ æ–‡ä»¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   ä¸Šä¼ æ–‡ä»¶å
    * @param file       ä¸Šä¼ æ–‡ä»¶ç±»
    * @return BladeFile
    */
   BladeFile putFile(String bucketName, String fileName, MultipartFile file);

   /**
    * ä¸Šä¼ æ–‡ä»¶
    *
    * @param fileName å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @param stream   æ–‡ä»¶æµ
    * @return BladeFile
    */
   BladeFile putFile(String fileName, InputStream stream);

   /**
    * ä¸Šä¼ æ–‡ä»¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    * @param stream     æ–‡ä»¶æµ
    * @return BladeFile
    */
   BladeFile putFile(String bucketName, String fileName, InputStream stream);

   /**
    * åˆ é™¤æ–‡ä»¶
    *
    * @param fileName å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    */
   void removeFile(String fileName);

   /**
    * åˆ é™¤æ–‡ä»¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileName   å­˜å‚¨æ¡¶å¯¹è±¡åç§°
    */
   void removeFile(String bucketName, String fileName);

   /**
    * æ‰¹é‡åˆ é™¤æ–‡ä»¶
    *
    * @param fileNames å­˜å‚¨æ¡¶å¯¹è±¡åç§°é›†åˆ
    */
   void removeFiles(List<String> fileNames);

   /**
    * æ‰¹é‡åˆ é™¤æ–‡ä»¶
    *
    * @param bucketName å­˜å‚¨æ¡¶åç§°
    * @param fileNames  å­˜å‚¨æ¡¶å¯¹è±¡åç§°é›†åˆ
    */
   void removeFiles(String bucketName, List<String> fileNames);


}