yunku-sdk-java: A Java repository from duancwd

/* Title:够快云库Java SDK使用说明 Description: Author: Brandon Date: 2014/08/25 Robots: noindex,nofollow */

#够快云库Java SDK使用说明

版本：1.0.25

创建：2014-08-25

引用

将**[yunku-java-sdk].jar文件引用进项目，包括YunkuJavaSDKlibs下的jar文件，或者将YunkuJavaSDK**做为依赖项目。

初始化

要使用云库api，您需要有效的CLIENT_ID和CLIENT_SECRET,和获得云库后台管理账号。

##参数使用以下使用到的方法中，如果是string类型的非必要参数，如果是不传，则传null

企业库管理（EntLibManager.java ）

###构造方法 new EntLibManager（ClientId,ClientSecret,boolean isEnt）

参数

参数	必须	类型	说明
ClientId	是	string	申请应用时分配的AppKey
ClientSecret	是	string	申请应用时分配的AppSecret
isEnt	是	boolean	是否是企业帐号登录

授权

accessToken(Username，Password)

参数

参数	必须	类型	说明
Username	是	string	用户名
Password	是	string	密码

返回结果

{
	access_token:
	expires_in:
	refresh_token:
}

字段	类型	说明
access_token	string	用于调用access_token，接口获取授权后的access token
expires_in	int	access_token的有效期，unix时间戳
refresh_token	string	用于刷新access_token 的 refresh_token，有效期1个月

创建库

create(String orgName, int orgCapacity, 
String storagePointName, String orgDesc)

参数

参数	必须	类型	说明
orgName	是	string	库名称
orgCapacity	否	int	库容量上限, 单位字节, 默认无上限
storagePointName	否	string	库归属存储点名称, 默认使用够快存储
orgDesc	否	string	库描述
orgLogo	否	string	库logo

####数值参考 1T="1099511627776" 1G＝“1073741824”；

返回结果

{
	org_id:    
	mount_id:
}

字段	类型	说明
org_id	int	库ID
mount_id	int	库空间id

获取库列表

getLibList()

参数

参数	必须	类型	说明
memberId	否	int	只返回该成员参与的库，传0则返回所有库

返回结果

{
'list':
    [
    	{
    		org_id : 库ID
    		org_name : 库名称
    		org_logo_url : 库图标url
    		size_org_total : 库空间总大小, 单位字节, -1表示空间不限制
    		size_org_use: 库已使用空间大小, 单位字节
    		mount_id: 库空间id
    	},
    	...
    ]
}

修改库信息

set(int orgId, String orgName, String orgCapacity, String orgDesc, String orgLogo)

参数

名称	必需	类型	说明
orgId	是	int	库id
orgName	否	string	库名称
orgCapacity	否	string	库容量限制，单位B
orgDesc	否	string	库描述
orgLogo	否	string	库logo

返回结果

正常返回 HTTP 200

####数值参考 1T="1099511627776" 1G＝“1073741824”；

获取库信息

getInfo(int orgId)

参数

名称	必需	类型	说明
orgId	是	int	库id

返回结果

{
  info:
  {
    org_id : 库ID
    org_name : 库名称
    org_desc : 库描述
    org_logo_url : 库图标url
    size_org_total : 库空间总大小, 单位字节, -1表示空间不限制
    size_org_use: 库已使用空间大小, 单位字节
    mount_id: 库空间id
  }
}

获取库授权

bind(int orgId, String title, String linkUrl)

参数

参数	必须	类型	说明
orgId	是	int	库ID
title	否	string	标题(预留参数)
linkUrl	否	string	链接(预留参数)

返回结果

{
	org_client_id:
	org_client_secret:
}

字段	类型	说明
org_client_id	string	库授权client_id
org_client_secret	string	库授权client_secret

org_client_secret用于调用库文件相关API签名时的密钥

取消库授权

unBind(String orgClientId)

参数

参数	必须	类型	说明
orgClientId	是	string	库授权client_id

返回结果

正常返回 HTTP 200

获取库成员列表

getMembers(int start, int size, int orgId)

参数

参数	必须	类型	说明
orgId	是	int	库id
start	否	int	分页开始位置，默认0
size	否	int	分页个数，默认20

返回结果

{
	list:
	[
		{
			"member_id": 成员id,
			"out_id": 成员外部id,
			"account": 外部账号,
			"member_name": 成员显示名,
			"member_email": 成员邮箱,
			"state": 成员状态。1：已接受，2：未接受,
		},
		...
	],
	count: 成员总数
}

查询库成员信息

getMember(int memberId)

参数

参数	必须	类型	说明
memberId	否	int	成员id

参数中的member_id,out_id和account必须传其中之一

返回结果

{
  "member_id": 成员id,
  "member_name": 成员显示名,
  "member_email": 成员邮箱,
  "out_id": 外部系统唯一id,
  "account": 外部系统登录帐号,
  "state": 成员状态。1：已接受，2：未接受
}

添加库成员

addMembers(int orgId, int roleId, int[] memberIds)

参数

参数	必须	类型	说明
orgId	是	int	库id
roleId	是	int	角色id
memberIds	是	array	需要添加的成员id数组

返回结果

正常返回 HTTP 200

修改库成员角色

setMemberRole(int orgId, int roleId, int[] memberIds)

参数

参数	必须	类型	说明
orgId	是	int	库id
roleId	是	int	角色id
memberIds	是	array	需要修改的成员id数组

返回结果

正常返回 HTTP 200

删除库成员

delMember(int orgId, int[] memberIds)

参数

参数	必须	类型	说明
orgId	是	int	库id
memberIds	是	array	成员id数组

返回结果

正常返回 HTTP 200

获取库分组列表

getGroups(int orgId)

参数

参数	必须	类型	说明
orgId	是	int	库id

返回结果

{
	{
		"id": 分组id
		"name": 分组名称
		"role_id": 分组角色id, 如果是0 表示分组中的成员使用在该分组上的角色
	},
	...
}

库上添加分组

addGroup(int orgId, int groupId, int roleId)

参数

参数	必须	类型	说明
orgId	是	int	库id
groupId	是	int	分组id
roleId	否	int	角色id, 默认0：分组中的成员使用在该分组上的角色

返回结果

正常返回 HTTP 200

删除库上的分组

delGroup(int orgId, int groupId)

参数

参数	必须	类型	说明
orgId	是	int	库id
groupId	是	int	分组id

返回结果

正常返回 HTTP 200

修改库上分组的角色

setGroupRole(int orgId, int groupId, int roleId)

参数

参数	必须	类型	说明
orgId	是	int	库id
groupId	是	int	分组id
roleId	否	int	角色id, 默认0：分组中的成员使用在该分组上的角色

返回结果

正常返回 HTTP 200

删除库

destroy(String orgClientId)

参数

| 参数 | 必须 | 类型 | 说明 | | orgClientId | 是 | string | 库授权client_id|

返回结果

正常返回 HTTP 200

企业管理（EntManager.java ）

###构造方法 new EntManager（ String ClientId,String ClientSecret,boolean isEnt）

参数

参数	必须	类型	说明
ClientId	是	string	申请应用时分配的AppKey
ClientSecret	是	string	申请应用时分配的AppSecret
isEnt	是	boolean	是否是企业帐号登录

授权

accessToken(String Username，String Password)

参数

参数	必须	类型	说明
Username	是	string	用户名
Password	是	string	密码

返回结果

{
	access_token:
	expires_in:
	refresh_token:
}

字段	类型	说明
access_token	string	用于调用access_token，接口获取授权后的access token
expires_in	int	access_token的有效期，unix时间戳
refresh_token	string	用于刷新access_token 的 refresh_token，有效期1个月

###获取角色 getRoles()

参数

（无）

返回结果

[
	{
		"id": 角色id,
		"name": 角色名称,
		},
	...
]

###获取成员列表 getMembers(int start, int size)

参数

参数	必须	类型	说明
start	否	int	记录开始位置, 默认0
size	否	int	返回条数, 默认20

返回结果

{
	list:
	[
		{
			"member_id": 成员id,
			"out_id": 成员外部id,
			"account": 外部账号,
			"member_name": 成员显示名,
			"member_email": 成员邮箱,
			"state": 成员状态。1：已接受，2：未接受,
		},
		...
	],
	count: 成员总数
}

根据成员Id查询企业成员信息

getMemberById(int memberId)

参数

参数	必须	类型	说明
memberId	是	int	成员id

返回结果

{
  "member_id": 成员id,
  "member_name": 成员显示名,
  "member_email": 成员邮箱,
  "out_id": 外部系统唯一id,
  "account": 外部系统登录帐号,
  "state": 成员状态。1：已接受，2：未接受
}

根据外部系统唯一id查询企业成员信息

getMemberByOutId(String outId)

参数

参数	必须	类型	说明
outId	是	String	外部系统唯一id

返回结果

{
  "member_id": 成员id,
  "member_name": 成员显示名,
  "member_email": 成员邮箱,
  "out_id": 外部系统唯一id,
  "account": 外部系统登录帐号,
  "state": 成员状态。1：已接受，2：未接受
}

根据外部系统登录帐号查询企业成员信息

String getMemberByAccount(String account)

参数

参数	必须	类型	说明
account	是	String	外部系统登录帐号

返回结果

{
  "member_id": 成员id,
  "member_name": 成员显示名,
  "member_email": 成员邮箱,
  "out_id": 外部系统唯一id,
  "account": 外部系统登录帐号,
  "state": 成员状态。1：已接受，2：未接受
}

###获取分组 getGroups()

参数

（无）

返回结果

{
	"list":
	[
		{
			"id": 分组id,
			"name": 分组名称,
			"out_id": 外部唯一id,
			"parent_id": 上级分组id, 0为顶级分组
		}
	]
}

分组成员列表

getGroupMembers(int groupId, int start, int size, boolean showChild)

参数

参数	必须	类型	说明
groupId	是	int	分组id
start	是	int	记录开始位置
size	是	int	返回条数
showChild	是	boolean	[0,1] 是否显示子分组内的成员

返回结果

{
	list:
	[
		{
			"member_id": 成员id,
			"out_id": 成员外部id,
			"account": 外部账号,
			"member_name": 成员显示名,
			"member_email": 成员邮箱,
			"state": 成员状态。1：已接受，2：未接受,
		},
		...
	],
	count: 成员总数
}

###根据成员id获取成员个人库外链 getMemberFileLink(int memberId, boolean fileOnly)

参数

参数	必须	类型	说明
memberId	是	int	成员id
fileOnly	是	boolean	是否只返回文件, 1只返回文件

返回结果

[
	{
	    "filename": 文件名或文件夹名,
	    "filesize": 文件大小,
		"link": 链接地址,
		"deadline": 到期时间戳 -1表示永久有效,
		"password": 是否加密, 1加密, 0无
	},
	...
]

添加或修改同步成员

addSyncMember(String oudId,String memberName,String account,String memberEmail,String memberPhone,String password)

参数

参数	必须	类型	说明
oudId	是	string	成员在外部系统的唯一id
memberName	是	string	显示名称
account	是	string	成员在外部系统的登录帐号
memberEmail	否	string	邮箱
memberPhone	否	string	联系电话
password	否	string	如果需要由够快验证帐号密码,密码为必须参数

返回结果

HTTP 200

删除同步成员

delSyncMember(String[] members)

参数

参数	必须	类型	说明
members	是	array	成员在外部系统的唯一id数组

返回结果

HTTP 200

添加或修改同步分组

addSyncGroup(String outId,String name,String parentOutId)

参数

参数	必须	类型	说明
outId	是	string	分组在外部系统的唯一id
name	是	string	显示名称
parentOutId	否	string	如果分组在另一个分组的下级, 需要指定上级分组唯一id, 不传表示在顶层, 修改分组时该字段无效

返回结果

HTTP 200

删除同步分组

delSyncGroup(String[]groups)

参数

参数	必须	类型	说明
groups	是	string	分组在外部系统的唯一id数组

返回结果

HTTP 200

添加同步分组的成员

addSyncGroupMember(String groupOutId,String[] members)

参数

参数	必须	类型	说明
groupOutId	否	string	外部分组的唯一id, 不传表示顶层
members	是	array	成员在外部系统的唯一id数组

返回结果

HTTP 200

删除同步分组的成员

delSyncGroupMember(String groupOutId, String[] members)

参数

参数	必须	类型	说明
groupOutId	否	string	外部分组的唯一id, 不传表示顶层
members	是	string	成员在外部系统的唯一id数组

返回结果

HTTP 200

企业文件管理（EntFileManager.java ）

orgClientId和orgClientSecret需要通过 EntLibManager bind方法获取

###构造方法 new EntFileManager(String orgClientId,String orgClientSecret);

参数

参数	必须	类型	说明
orgClientId	是	string	库授权client_id
orgClientSecret	是	string	库授权client_secret

###获取文件列表 getFileList( int start, String fullPath)

参数

名称	必需	类型	说明
start	是	int	开始位置(每次返回100条数据)
fullPath	是	string	文件的路径

返回结果

{
	count:
	list:
	[
		{
			hash:
			dir:
			fullpath:
			filename:
			filehash:
			filesize:
			create_member_name:
			create_dateline:
			last_member_name:
			last_dateline:
		},
		...
	]
}

字段	类型	说明
count	int	文件总数
list	Array	格式见下
字段	类型	说明
---	---	---
hash	string	文件唯一标识
dir	int	是否文件夹, 1是, 0否
fullpath	string	文件路径
filename	string	文件名称
filehash	string	文件内容hash, 如果是文件夹, 则为空
filesize	long	文件大小, 如果是文件夹, 则为0
create_member_name	string	文件创建人名称
create_dateline	int	文件创建时间戳
last_member_name	string	文件最后修改人名称
last_dateline	int	文件最后修改时间戳

###获取更新列表 getUpdateList( boolean isCompare, long fetchDateline)

参数

名称	必需	类型	说明
mode	否	string	更新模式, 可不传, 当需要返回已删除的文件时使用compare
fetchDateline	是	int	13位时间戳, 获取该时间后的数据, 第一次获取用0

返回结果

字段	类型	说明
fetch_dateline	int	当前返回数据的最大时间戳（13位精确到毫秒）
list	Array	格式见下

字段	类型	说明
cmd	int	当mode=compare 时才会返回cmd字段, 0表示删除, 1表示未删除
hash	string	文件唯一标识
dir	int	是否文件夹, 1是, 0否
fullpath	string	文件路径
filename	string	文件名称
filehash	string	文件内容hash, 如果是文件夹, 则为空
filesize	long	文件大小, 如果是文件夹, 则为0
create_member_name	string	文件创建人名称
create_dateline	int	文件创建时间戳
last_member_name	string	文件最后修改人名称
last_dateline	int	文件最后修改时间戳

###文件更新数量 getUpdateCounts( long beginDateline, long endDateline, boolean showDelete)

参数

名称	必需	类型	说明
beginDateline	是	long	13位时间戳, 开始时间
endDateline	是	long	13位时间戳, 结束时间
showDelete	是	boolean	是否返回删除文件

返回结果

{
	count: 更新数量
}

###获取文件信息 getFileInfo( String fullPath,NetType net)

参数

名称	必需	类型	说明

返回结果

{
	hash:
	dir:
	fullpath:
	filename:
	filesize:
	create_member_name:
	create_dateline:
	last_member_name:
	last_dateline:
	uri:
	preview:
	thumbnail:
}

字段	类型	说明
hash	string	文件唯一标识
dir	int	是否文件夹
fullpath	string	文件路径
filename	string	文件名称
filehash	string	文件内容hash
filesize	long	文件大小
create_member_name	string	文件创建人
create_dateline	int	文件创建时间戳(10位精确到秒)
last_member_name	string	文件最后修改人
last_dateline	int	文件最后修改时间戳(10位精确到秒)
uri	string	文件下载地址
preview	string	文件预览地址
thumbnail	string	文件缩略图地址

###创建文件夹 createFolder( String fullPath, String opName)

参数

参数	必须	类型	说明
fullPath	是	string	文件夹路径
opName	否	string	操作人名称

返回结果

字段	类型	说明
hash	string	文件唯一标识
fullpath	string	文件夹的路径

###通过文件流上传（50M以内文件） createFile( String fullPath, String opName, FileInputStream stream)

参数

参数	必须	类型	说明
fullPath	是	string	文件路径
opName	否	string	操作人名称
stream	是	stream	文件流

返回结果

字段	类型	说明
hash	string	文件唯一标识
fullpath	string	文件路径
filehash	string	文件内容hash
filesize	long	文件大小

###通过本地路径上传（50M以内文件） createFile( String fullPath, String opName, String localPath)

参数

参数	必须	类型	说明
fullPath	是	string	文件路径
opName	否	string	操作人名称
localPath	是	string	本地文件路径
fileName	是	string	文件名

返回结果

字段	类型	说明
hash	string	文件唯一标识
fullpath	string	文件路径
filehash	string	文件内容hash
filesize	long	文件大小

###文件分块上传 uploadByBlock( String fullPath, String opName, int opId, String localFilePath,boolean overWrite, UploadCallBack callBack)

参数

参数	必须	类型	说明
fullpath	是	string	文件路径
opName	否	string	创建人名称, 如果指定了opId, 就不需要opName，
opId	否	int	创建人id, 个人库默认是库拥有人id, 如果创建人不是云库用户, 可以用op_name代替,
localFilePath	是	string	文件本地路径
overWrite	是	boolean	是否覆盖同名文件，true为覆盖
callBack	否	UploadCallBack	文件上传回调

###删除文件 del( String fullPaths, String opName)

参数

参数	必需	类型	说明
fullPaths	是	string	文件路径，如果是多个文件用“｜”符号隔开
opName	否	string	操作人名称

返回结果

正常返回 HTTP 200

###移动文件 move( String fullPath, String destFullPath, String opName)

参数

参数	必需	类型	说明
fullPath	是	string	要移动文件的路径
destFullPath	是	string	移动后的路径
opName	否	string	操作人名称

返回结果

正常返回 HTTP 200

###获取文件链接 link( String fullPath, int deadline, AuthType authType, String password)

参数

参数	必需	类型	说明
fullPath	是	string	文件路径
deadline	否	int	10位链接失效的时间戳，永久传－1
authtype	是	enum	文件访问权限DEFAULT默认为预览，PREVIEW：预览，DOWNLOAD：下载、预览，UPLOAD：上传、下载、预览｜
password	否	string	密码，不过不设置密码，传null

返回结果

###发送消息 sendmsg( String title, String text, String image, String linkUrl, String opName)

参数

名称	必需	类型	说明
title	是	string	消息标题
text	是	string	消息正文
image	否	string	图片url
linkUrl	否	string	链接
opName	否	string	操作人名称

返回结果

正常返回 HTTP 200

###获取当前库所有外链 links( boolean fileOnly)

参数

名称	必需	类型	说明
fileOnly	是	boolean	是否只返回文件, 1只返回文件

返回结果

[
	{
	    "filename": 文件名或文件夹名,
	    "filesize": 文件大小,
		"link": 文件外链地址,
		"deadline": 到期时间戳 -1表示永久有效,
		"password": 是否加密, 1加密, 0无
	},
	...
]

###通过链接上传文件

createFileByUrl(String fullpath,int opId,String opName,boolean overwrite,String url)

参数

名称	必需	类型	说明
fullpath	是	string	文件路径
opId	否	int	创建人id, 个人库默认是库拥有人id, 如果创建人不是云库用户, 可以用op_name代替
opName	否	string	创建人名称, 如果指定了opId, 就不需要opName
overwrite	是	boolean	是否覆盖同名文件, true覆盖(默认) false不覆盖,文件名后增加数字标识
url	是	string	需要服务端获取的文件url

返回结果

正常返回 HTTP 200

###WEB直接上传文件 getUploadServers()

参数

(无)

返回结果

{
   "upload":
   [
      上传服务器地址 如:http://upload.domain.com,
     ...
   ]
}

duancwd/yunku-sdk-java

引用

初始化

企业库管理（EntLibManager.java ）

参数

授权

参数

返回结果

创建库

参数

返回结果

获取库列表

参数

返回结果

修改库信息

参数

返回结果

获取库信息

参数

返回结果

获取库授权

参数

返回结果

取消库授权

参数

返回结果

获取库成员列表

参数

返回结果

查询库成员信息

参数

返回结果

添加库成员

参数

返回结果

修改库成员角色

参数

返回结果

删除库成员

参数

返回结果

获取库分组列表

参数

返回结果

库上添加分组

参数

返回结果

删除库上的分组

参数

返回结果

修改库上分组的角色

参数

返回结果

删除库

参数

返回结果

企业管理（EntManager.java ）

参数

授权

参数

返回结果

参数

返回结果

参数

返回结果

根据成员Id查询企业成员信息

参数

返回结果

根据外部系统唯一id查询企业成员信息

参数

返回结果

根据外部系统登录帐号查询企业成员信息

参数

返回结果

参数

返回结果

分组成员列表

参数

返回结果

参数