com.obs.services.model

Class PutObjectRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.PutObjectBasicRequest

com.obs.services.model.PutObjectRequest

Direct Known Subclasses:

AppendObjectRequest, NewFileRequest

public class PutObjectRequest
extends PutObjectBasicRequest

上传对象的请求参数

Field Summary

Fields

Modifier and Type	Field and Description
protected int	expires
protected File	file
protected InputStream	input
protected ObjectMetadata	metadata
protected long	offset

Fields inherited from class com.obs.services.model.PutObjectBasicRequest

acl, extensionPermissionMap, sseCHeader, sseKmsHeader, successRedirectLocation

Fields inherited from class com.obs.services.model.BaseObjectRequest

encodeHeaders, objectKey

Fields inherited from class com.obs.services.model.GenericRequest

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
PutObjectRequest()
PutObjectRequest(PutObjectBasicRequest request)
PutObjectRequest(String bucketName)
PutObjectRequest(String bucketName, String objectKey) 构造函数
PutObjectRequest(String bucketName, String objectKey, File file) 构造函数
PutObjectRequest(String bucketName, String objectKey, InputStream input) 构造函数

Method Summary

Modifier and Type	Method and Description
int	getExpires() 获取对象的过期时间
File	getFile() 获取待上传的文件，不可与待上传的数据流一起使用
InputStream	getInput() 获取待上传的数据流，不可与待上传的文件一起使用
ObjectMetadata	getMetadata() 获取对象属性，支持content-type，content-length，content-md5，自定义元数据
long	getOffset() 获取待上传内容在本地文件中的起始位置，仅在设置了本地上传文件路径时有效
long	getProgressInterval() 获取数据传输监听器回调的阈值，默认为100KB
ProgressListener	getProgressListener() 获取数据传输监听器
boolean	isAutoClose() 获取是否自动关闭输入流标识，默认为true
void	setAutoClose(boolean autoClose) 设置是否自动关闭输入流标识，默认为true
void	setExpires(int expires) 设置对象的过期时间，正整数
void	setFile(File file) 设置待上传的文件，不可与待上传的数据流一起使用
void	setInput(InputStream input) 设置待上传的数据流，不可与待上传的文件一起使用
void	setMetadata(ObjectMetadata metadata) 设置对象属性，支持content-type，content-length，自定义元数据
void	setOffset(long offset) 设置待上传内容在本地文件中的起始位置，仅在设置了本地上传文件路径时有效，单位：字节，默认为0
void	setProgressInterval(long progressInterval) 设置数据传输监听器回调的阈值，默认为100KB
void	setProgressListener(ProgressListener progressListener) 设置数据传输监听器
String	toString()

Methods inherited from class com.obs.services.model.PutObjectBasicRequest

getAcl, getAllGrantPermissions, getDomainIdsByGrantPermission, getExtensionPermissionMap, getGrantPermissionsByDomainId, getSseCHeader, getSseKmsHeader, getSuccessRedirectLocation, grantExtensionPermission, setAcl, setExtensionPermissionMap, setSseCHeader, setSseKmsHeader, setSuccessRedirectLocation, withdrawExtensionPermission, withdrawExtensionPermissions

Methods inherited from class com.obs.services.model.BaseObjectRequest

getObjectKey, isEncodeHeaders, setIsEncodeHeaders, setObjectKey

Methods inherited from class com.obs.services.model.GenericRequest

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

file

protected File file

input

protected InputStream input

metadata

protected ObjectMetadata metadata

expires

protected int expires

offset

protected long offset

Constructor Detail

PutObjectRequest

public PutObjectRequest()

PutObjectRequest

public PutObjectRequest(String bucketName)

PutObjectRequest

public PutObjectRequest(PutObjectBasicRequest request)

PutObjectRequest

public PutObjectRequest(String bucketName,
                        String objectKey)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

PutObjectRequest

public PutObjectRequest(String bucketName,
                        String objectKey,
                        File file)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

file - 待上传文件

PutObjectRequest

public PutObjectRequest(String bucketName,
                        String objectKey,
                        InputStream input)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

input - 待上传的数据流

Method Detail

getOffset

public long getOffset()

获取待上传内容在本地文件中的起始位置，仅在设置了本地上传文件路径时有效

Returns:

待上传内容在本地文件中的起始位置

setOffset

public void setOffset(long offset)

设置待上传内容在本地文件中的起始位置，仅在设置了本地上传文件路径时有效，单位：字节，默认为0

Parameters:

offset - 待上传内容在本地文件中的起始位置

getInput

public InputStream getInput()

获取待上传的数据流，不可与待上传的文件一起使用

Returns:

待上传的数据流

setInput

public void setInput(InputStream input)

设置待上传的数据流，不可与待上传的文件一起使用

Parameters:

input - 待上传的数据流

getMetadata

public ObjectMetadata getMetadata()

获取对象属性，支持content-type，content-length，content-md5，自定义元数据

Returns:

对象属性

setMetadata

public void setMetadata(ObjectMetadata metadata)

设置对象属性，支持content-type，content-length，自定义元数据

Parameters:

metadata - 对象属性

getFile

public File getFile()

获取待上传的文件，不可与待上传的数据流一起使用

Returns:

待上传的文件

setFile

public void setFile(File file)

设置待上传的文件，不可与待上传的数据流一起使用

Parameters:

file - 待上传的文件

getExpires

public int getExpires()

获取对象的过期时间

Returns:

对象的过期时间

setExpires

public void setExpires(int expires)

设置对象的过期时间，正整数

Parameters:

expires - 对象的过期时间

isAutoClose

public boolean isAutoClose()

获取是否自动关闭输入流标识，默认为true

Returns:

是否自动关闭输入流标识

setAutoClose

public void setAutoClose(boolean autoClose)

设置是否自动关闭输入流标识，默认为true

Parameters:

autoClose - 是否自动关闭输入流标识

getProgressListener

public ProgressListener getProgressListener()

获取数据传输监听器

Returns:

数据传输监听器

setProgressListener

public void setProgressListener(ProgressListener progressListener)

设置数据传输监听器

Parameters:

progressListener - 数据传输监听器

getProgressInterval

public long getProgressInterval()

获取数据传输监听器回调的阈值，默认为100KB

Returns:

数据传输监听器回调的阈值

setProgressInterval

public void setProgressInterval(long progressInterval)

设置数据传输监听器回调的阈值，默认为100KB

Parameters:

progressInterval - 数据传输监听器回调的阈值

toString

public String toString()

Overrides:

toString in class BaseObjectRequest