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

Parameters in an object upload request

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) Constructor
PutObjectRequest(String bucketName, String objectKey, File file) Constructor
PutObjectRequest(String bucketName, String objectKey, InputStream input) Constructor

Method Summary

Modifier and Type	Method and Description
int	getExpires() Obtain the expiration time of the object.
File	getFile() Obtain the file to be uploaded, which cannot be used with the data stream.
InputStream	getInput() Obtain the data stream to be uploaded, which cannot be used with the file to be uploaded.
ObjectMetadata	getMetadata() Obtain object properties, including "content-type", "content-length", "content-md5", and customized metadata.
long	getOffset() Obtain the start position of the to-be-uploaded content in the file.
long	getProgressInterval() Obtain the callback threshold of the data transfer listener.
ProgressListener	getProgressListener() Obtain the data transfer listener.
boolean	isAutoClose() Check whether the input stream will be automatically closed.
void	setAutoClose(boolean autoClose) Specify whether to automatically close the input stream.
void	setExpires(int expires) Set the expiration time of the object.
void	setFile(File file) Set the file to be uploaded, which cannot be used with the data stream.
void	setInput(InputStream input) Set the data stream to be uploaded, which cannot be used with the file to be uploaded.
void	setMetadata(ObjectMetadata metadata) Set the object properties, including "content-type", "content-length", and customized metadata.
void	setOffset(long offset) Set the start position of the to-be-uploaded content in the file.
void	setProgressInterval(long progressInterval) Set the callback threshold of the data transfer listener.
void	setProgressListener(ProgressListener progressListener) Set the data transfer listener.
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)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

PutObjectRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

file - File to be uploaded

PutObjectRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

input - Data stream to be uploaded

Method Detail

getOffset

public long getOffset()

Obtain the start position of the to-be-uploaded content in the file. This parameter is effective only when the path where the file is to be uploaded is configured.

Returns:

Start position of the content to be uploaded in the local file

setOffset

public void setOffset(long offset)

Set the start position of the to-be-uploaded content in the file. This parameter is effective only when the path where the file is to be uploaded is configured. The unit is byte and the default value is 0.

Parameters:

offset - Start position of the content to be uploaded in the local file

getInput

public InputStream getInput()

Obtain the data stream to be uploaded, which cannot be used with the file to be uploaded.

Returns:

Data stream to be uploaded

setInput

public void setInput(InputStream input)

Set the data stream to be uploaded, which cannot be used with the file to be uploaded.

Parameters:

input - Data stream to be uploaded

getMetadata

public ObjectMetadata getMetadata()

Obtain object properties, including "content-type", "content-length", "content-md5", and customized metadata.

Returns:

Object properties

setMetadata

public void setMetadata(ObjectMetadata metadata)

Set the object properties, including "content-type", "content-length", and customized metadata.

Parameters:

metadata - Object properties

getFile

public File getFile()

Obtain the file to be uploaded, which cannot be used with the data stream.

Returns:

File to be uploaded

setFile

public void setFile(File file)

Set the file to be uploaded, which cannot be used with the data stream.

Parameters:

file - File to be uploaded

getExpires

public int getExpires()

Obtain the expiration time of the object.

Returns:

Expiration time of the object

setExpires

public void setExpires(int expires)

Set the expiration time of the object. The value must be a positive integer.

Parameters:

expires - Expiration time of the object

isAutoClose

public boolean isAutoClose()

Check whether the input stream will be automatically closed. The default value is "true".

Returns:

Identifier specifying whether the input stream will be automatically closed

setAutoClose

public void setAutoClose(boolean autoClose)

Specify whether to automatically close the input stream. The default value is "true".

Parameters:

autoClose - Identifier specifying whether the input stream will be automatically closed

getProgressListener

public ProgressListener getProgressListener()

Obtain the data transfer listener.

Returns:

Data transfer listener

setProgressListener

public void setProgressListener(ProgressListener progressListener)

Set the data transfer listener.

Parameters:

progressListener - Data transfer listener

getProgressInterval

public long getProgressInterval()

Obtain the callback threshold of the data transfer listener. The default value is 100 KB.

Returns:

Callback threshold of the data transfer listener

setProgressInterval

public void setProgressInterval(long progressInterval)

Set the callback threshold of the data transfer listener. The default value is 100 KB.

Parameters:

progressInterval - Callback threshold of the data transfer listener

toString

public String toString()

Overrides:

toString in class BaseObjectRequest