UpYun (common-storage-util 0.0.25 API)

java.lang.Object
- com.ptteng.common.storage.util.UpYun

```
public class UpYun
extends Object
```

嵌套类概要

嵌套类
限定符和类型类和说明

class UpYun.FolderItem

static class UpYun.PARAMS
其他额外参数的键值和参数值

嵌套类
限定符和类型	类和说明
`class`	`UpYun.FolderItem`
`static class`	`UpYun.PARAMS` 其他额外参数的键值和参数值

字段概要

字段
限定符和类型	字段和说明
`protected String`	`bucketName`
`boolean`	`debug`
`static String`	`ED_AUTO` 根据网络条件自动选择接入点:v0.api.upyun.com
`static String`	`ED_CNC` 联通网通接入点:v2.api.upyun.com
`static String`	`ED_CTT` 移动铁通接入点:v3.api.upyun.com
`static String`	`ED_TELECOM` 电信接入点:v1.api.upyun.com
`protected String`	`fileDate`
`protected String`	`fileSize`
`protected String`	`fileType`
`protected String`	`password`
`protected String`	`picFrames`
`protected String`	`picHeight`
`protected String`	`picType`
`protected String`	`picWidth`
`protected String`	`userName`

构造器概要

构造器
构造器和说明

UpYun(String bucketName, String userName, String password)
初始化 UpYun 存储接口

构造器
构造器和说明
`UpYun(String bucketName, String userName, String password)` 初始化 UpYun 存储接口

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`deleteFile(String filePath)` 删除文件
`String`	`getApiDomain()` 查看当前的域名接入点
`long`	`getBucketUsage()` 获取总体空间的占用量
`Map<String,String>`	`getFileInfo(String filePath)` 获取文件信息
`long`	`getFolderUsage(String path)` 已过时。
`String`	`getPicFrames()`
`String`	`getPicHeight()`
`String`	`getPicType()`
`String`	`getPicWidth()`
`int`	`getTimeout()` 查看当前的超时时间
`String`	`getWritedFileInfo(String key)` 已过时。
`boolean`	`isDebug()` 查看当前是否是debug模式
`static String`	`md5(File file)` 对文件进行 MD5 加密
`static String`	`md5(String str)` 对字符串进行 MD5 加密
`boolean`	`mkDir(String path)` 创建目录
`boolean`	`mkDir(String path, boolean auto)` 创建目录
`List<UpYun.FolderItem>`	`readDir(String path)` 读取目录列表
`String`	`readFile(String filePath)` 读取文件
`boolean`	`readFile(String filePath, File file)` 读取文件
`boolean`	`rmDir(String path)` 删除目录
`void`	`setApiDomain(String domain)` 切换 API 接口的域名接入点可选参数： 1) UpYun.ED_AUTO(v0.api.upyun.com)：默认，根据网络条件自动选择接入点 2) UpYun.ED_TELECOM(v1.api.upyun.com)：电信接入点 3) UpYun.ED_CNC(v2.api.upyun.com)：联通网通接入点 4) UpYun.ED_CTT(v3.api.upyun.com)：移动铁通接入点
`void`	`setContentMD5(String md5Value)` 设置待上传文件的 Content-MD5 值如果又拍云服务端收到的文件MD5值与用户设置的不一致，将回报 406 Not Acceptable 错误
`void`	`setDebug(boolean debug)` 设置是否开启debug模式
`void`	`setFileSecret(String secret)` 设置待上传文件的"访问密钥" 注意：仅支持图片空！
`void`	`setTimeout(int second)` 设置连接超时时间，默认为30秒
`String`	`version()` 获取当前SDK的版本号
`boolean`	`writeFile(String filePath, byte[] datas)` 上传文件
`boolean`	`writeFile(String filePath, byte[] datas, boolean auto)` 上传文件
`boolean`	`writeFile(String filePath, byte[] datas, boolean auto, Map<String,String> params)` 上传文件
`boolean`	`writeFile(String filePath, File file)` 上传文件
`boolean`	`writeFile(String filePath, File file, boolean auto)` 上传文件
`boolean`	`writeFile(String filePath, File file, boolean auto, Map<String,String> params)` 上传文件
`boolean`	`writeFile(String filePath, String datas)` 上传文件
`boolean`	`writeFile(String filePath, String datas, boolean auto)` 上传文件
`boolean`	`writeFile(String filePath, String datas, boolean auto, Map<String,String> params)` 上传文件

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ED_AUTO
```
public static final String ED_AUTO
```
    根据网络条件自动选择接入点:v0.api.upyun.com
    
    另请参阅:
    
    常量字段值
  - ED_TELECOM
```
public static final String ED_TELECOM
```
    电信接入点:v1.api.upyun.com
    
    另请参阅:
    
    常量字段值
  - ED_CNC
```
public static final String ED_CNC
```
    联通网通接入点:v2.api.upyun.com
    
    另请参阅:
    
    常量字段值
  - ED_CTT
```
public static final String ED_CTT
```
    移动铁通接入点:v3.api.upyun.com
    
    另请参阅:
    
    常量字段值
  - debug
```
public boolean debug
```
  - bucketName
```
protected String bucketName
```
  - userName
```
protected String userName
```
  - password
```
protected String password
```
  - picWidth
```
protected String picWidth
```
  - picHeight
```
protected String picHeight
```
  - picFrames
```
protected String picFrames
```
  - picType
```
protected String picType
```
  - fileType
```
protected String fileType
```
  - fileSize
```
protected String fileSize
```
  - fileDate
```
protected String fileDate
```
- 构造器详细资料
  - UpYun
```
public UpYun(String bucketName,
             String userName,
             String password)
```
    初始化 UpYun 存储接口
    
    参数:
    
    bucketName - 空间名称
    
    userName - 操作员名称
    
    password - 密码，不需要MD5加密
- 方法详细资料
  - setApiDomain
```
public void setApiDomain(String domain)
```
    切换 API 接口的域名接入点
    可选参数：
    1) UpYun.ED_AUTO(v0.api.upyun.com)：默认，根据网络条件自动选择接入点
    2) UpYun.ED_TELECOM(v1.api.upyun.com)：电信接入点
    3) UpYun.ED_CNC(v2.api.upyun.com)：联通网通接入点
    4) UpYun.ED_CTT(v3.api.upyun.com)：移动铁通接入点
    
    参数:
    
    domain - 域名接入点
  - getApiDomain
```
public String getApiDomain()
```
    查看当前的域名接入点
    
    返回:
  - setTimeout
```
public void setTimeout(int second)
```
    设置连接超时时间，默认为30秒
    
    参数:
    
    second - 秒数，60即为一分钟超时
  - getTimeout
```
public int getTimeout()
```
    查看当前的超时时间
    
    返回:
  - isDebug
```
public boolean isDebug()
```
    查看当前是否是debug模式
    
    返回:
  - setDebug
```
public void setDebug(boolean debug)
```
    设置是否开启debug模式
    
    参数:
    
    debug -
  - setContentMD5
```
public void setContentMD5(String md5Value)
```
    设置待上传文件的 Content-MD5 值
    如果又拍云服务端收到的文件MD5值与用户设置的不一致，将回报 406 Not Acceptable 错误
    
    参数:
    
    md5Value - 文件 MD5 校验后的内容
  - setFileSecret
```
public void setFileSecret(String secret)
```
    设置待上传文件的"访问密钥"
    注意：
    仅支持图片空！设置密钥后，无法根据原文件URL直接访问，需带 URL 后面加上（缩略图间隔标志符+密钥）进行访问
    举例:
    如果缩略图间隔标志符为"!"，密钥为"bac"，上传文件路径为"/folder/test.jpg"，
    那么该图片的对外访问地址为：http://空间域名 /folder/test.jpg!bac
    
    参数:
    
    secret - 密钥字符串
  - getPicWidth
```
public String getPicWidth()
```
  - getPicHeight
```
public String getPicHeight()
```
  - getPicFrames
```
public String getPicFrames()
```
  - getPicType
```
public String getPicType()
```
  - version
```
public String version()
```
    获取当前SDK的版本号
    
    返回:
    
    SDK版本号
  - getBucketUsage
```
public long getBucketUsage()
```
    获取总体空间的占用量
    
    参数:
    
    path - 目标路径
    
    返回:
    
    空间占用量，失败时返回 -1
  - getFolderUsage
```
@Deprecated
public long getFolderUsage(String path)
```
    已过时。
    
    获取某个子目录的占用量
    
    参数:
    
    path - 目标路径
    
    返回:
    
    空间占用量，失败时返回 -1
  - writeFile
```
public boolean writeFile(String filePath,
                         byte[] datas)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    datas - 文件内容
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         byte[] datas,
                         boolean auto)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    datas - 文件内容
    
    auto - 是否自动创建父级目录(最多10级)
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         byte[] datas,
                         boolean auto,
                         Map<String,String> params)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    datas - 文件内容
    
    auto - 是否自动创建父级目录(最多10级)
    
    params - 额外参数
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         String datas)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    String - datas 文件内容
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         String datas,
                         boolean auto)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    String - datas 文件内容
    
    auto - 是否自动创建父级目录(最多10级)
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         String datas,
                         boolean auto,
                         Map<String,String> params)
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    String - datas 文件内容
    
    auto - 是否自动创建父级目录(最多10级)
    
    params - 额外参数
    
    返回:
    
    true or false
  - writeFile
```
public boolean writeFile(String filePath,
                         File file)
                  throws IOException
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    file - 待上传的文件
    
    返回:
    
    true or false
    
    抛出:
    
    IOException
  - writeFile
```
public boolean writeFile(String filePath,
                         File file,
                         boolean auto)
                  throws IOException
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    file - 待上传的文件
    
    auto - 是否自动创建父级目录(最多10级)
    
    返回:
    
    true or false
    
    抛出:
    
    IOException
  - writeFile
```
public boolean writeFile(String filePath,
                         File file,
                         boolean auto,
                         Map<String,String> params)
                  throws IOException
```
    上传文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    file - 待上传的文件
    
    auto - 是否自动创建父级目录(最多10级)
    
    params - 额外参数
    
    返回:
    
    true or false
    
    抛出:
    
    IOException
  - readFile
```
public String readFile(String filePath)
```
    读取文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    返回:
    
    文件内容或 null
  - readFile
```
public boolean readFile(String filePath,
                        File file)
```
    读取文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    file - 临时文件
    
    返回:
    
    true or false
  - getFileInfo
```
public Map<String,String> getFileInfo(String filePath)
```
    获取文件信息
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    返回:
    
    文件信息或 null
  - deleteFile
```
public boolean deleteFile(String filePath)
```
    删除文件
    
    参数:
    
    filePath - 文件路径（包含文件名）
    
    返回:
    
    true or false
  - mkDir
```
public boolean mkDir(String path)
```
    创建目录
    
    参数:
    
    path - 目录路径
    
    返回:
    
    true or false
  - mkDir
```
public boolean mkDir(String path,
                     boolean auto)
```
    创建目录
    
    参数:
    
    path - 目录路径
    
    auto - 是否自动创建父级目录(最多10级)
    
    返回:
    
    true or false
  - readDir
```
public List<UpYun.FolderItem> readDir(String path)
```
    读取目录列表
    
    参数:
    
    path - 目录路径
    
    返回:
    
    List 或 null
  - rmDir
```
public boolean rmDir(String path)
```
    删除目录
    
    参数:
    
    path - 目录路径
    
    返回:
    
    true or false
  - getWritedFileInfo
```
public String getWritedFileInfo(String key)
```
    已过时。
    
    获取上传文件后的信息（仅图片空间有返回数据）
    
    参数:
    
    key - 信息字段名（x-upyun-width、x-upyun-height、x-upyun-frames、x-upyun-file -type）
    
    返回:
    
    value or NULL
  - md5
```
public static String md5(String str)
```
    对字符串进行 MD5 加密
    
    参数:
    
    str - 待加密字符串
    
    返回:
    
    加密后字符串
  - md5
```
public static String md5(File file)
                  throws IOException
```
    对文件进行 MD5 加密
    
    参数:
    
    file - 待加密的文件
    
    返回:
    
    文件加密后的 MD5 值
    
    抛出:
    
    IOException

类 UpYun

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ED_AUTO

ED_TELECOM

ED_CNC

ED_CTT

debug

bucketName

userName

password

picWidth

picHeight

picFrames

picType

fileType

fileSize

fileDate

构造器详细资料

UpYun

方法详细资料

setApiDomain

getApiDomain

setTimeout

getTimeout

isDebug

setDebug

setContentMD5

setFileSecret

getPicWidth

getPicHeight

getPicFrames

getPicType

version

getBucketUsage

getFolderUsage

writeFile

writeFile

writeFile

writeFile

writeFile

writeFile

writeFile

writeFile

writeFile

readFile

readFile

getFileInfo

deleteFile

mkDir

mkDir

readDir

rmDir

getWritedFileInfo

md5

md5