com.obs.services.model

Class UploadPartRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.AbstractMultipartRequest

com.obs.services.model.UploadPartRequest

public class UploadPartRequest
extends AbstractMultipartRequest

Parameters in a part upload request

Field Summary

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

uploadId

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
UploadPartRequest()
UploadPartRequest(String bucketName, String objectKey) Constructor
UploadPartRequest(String bucketName, String objectKey, File file) Constructor
UploadPartRequest(String bucketName, String objectKey, Long partSize, InputStream input) Constructor
UploadPartRequest(String bucketName, String objectKey, Long partSize, long offset, File file) Constructor
UploadPartRequest(String bucketName, String objectKey, String fileName) Constructor

Method Summary

Modifier and Type	Method and Description
String	getContentMd5() Set the MD5 value of the data to be uploaded.
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.
long	getOffset() Obtain the offset of the part in the file.
int	getPartNumber() Obtain the part number.
Long	getPartSize() Obtain the part size, in bytes.
long	getProgressInterval() Obtain the callback threshold of the data transfer listener.
ProgressListener	getProgressListener() Obtain the data transfer listener.
SseCHeader	getSseCHeader() Obtain SSE-C encryption headers.
boolean	isAttachMd5() Check whether the MD5 value of the data to be uploaded will be automatically calculated.
boolean	isAutoClose() Check whether the input stream will be automatically closed.
void	setAttachMd5(boolean attachMd5) Specify whether to automatically calculate the MD5 value of the data to be uploaded.
void	setAutoClose(boolean autoClose) Specify whether to automatically close the input stream.
void	setContentMd5(String contentMd5) Obtain the MD5 value of the data to be uploaded.
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	setOffset(long offset) Set the start position of the to-be-uploaded content in the file.
void	setPartNumber(int partNumber) Set the part number.
void	setPartSize(Long partSize) Set the part size (in bytes).
void	setProgressInterval(long progressInterval) Set the callback threshold of the data transfer listener.
void	setProgressListener(ProgressListener progressListener) Set the data transfer listener.
void	setSseCHeader(SseCHeader sseCHeader) Set SSE-C encryption headers.
String	toString()

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

getUploadId, setUploadId

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

Constructor Detail

UploadPartRequest

public UploadPartRequest()

UploadPartRequest

public UploadPartRequest(String bucketName,
                         String objectKey)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

UploadPartRequest

public UploadPartRequest(String bucketName,
                         String objectKey,
                         String fileName)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

fileName - File name to be uploaded

UploadPartRequest

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

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

file - File to be uploaded

UploadPartRequest

public UploadPartRequest(String bucketName,
                         String objectKey,
                         Long partSize,
                         InputStream input)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

partSize - Part size (in bytes)

input - Data stream to be uploaded

UploadPartRequest

public UploadPartRequest(String bucketName,
                         String objectKey,
                         Long partSize,
                         long offset,
                         File file)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

partSize - Part size (in bytes)

offset - Offset of the part in the file. The default value is 0 (in bytes).

file - File to be uploaded

Method Detail

getSseCHeader

public SseCHeader getSseCHeader()

Obtain SSE-C encryption headers.

Returns:

SSE-C encryption headers

setSseCHeader

public void setSseCHeader(SseCHeader sseCHeader)

Set SSE-C encryption headers.

Parameters:

sseCHeader - SSE-C encryption headers

getOffset

public long getOffset()

Obtain the offset of the part in the file. The default value is 0 (in bytes).

Returns:

Offset of the part in the 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 - Offset of the part in the file

getPartNumber

public int getPartNumber()

Obtain the part number.

Returns:

Part number

setPartNumber

public void setPartNumber(int partNumber)

Set the part number.

Parameters:

partNumber - Part number

setPartSize

public void setPartSize(Long partSize)

Set the part size (in bytes).

Parameters:

partSize - Part size

getPartSize

public Long getPartSize()

Obtain the part size, in bytes.

Returns:

Part size

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

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

isAttachMd5

public boolean isAttachMd5()

Check whether the MD5 value of the data to be uploaded will be automatically calculated. If the MD5 value is set, this parameter can be ignored.

Returns:

Identifier specifying whether to automatically calculate the MD5 value of the data to be uploaded

setAttachMd5

public void setAttachMd5(boolean attachMd5)

Specify whether to automatically calculate the MD5 value of the data to be uploaded. If the MD5 value is set, this parameter can be ignored.

Parameters:

attachMd5 - Identifier specifying whether to automatically calculate the MD5 value of the data to be uploaded

getContentMd5

public String getContentMd5()

Set the MD5 value of the data to be uploaded.

Returns:

MD5 value of the data to be uploaded

setContentMd5

public void setContentMd5(String contentMd5)

Obtain the MD5 value of the data to be uploaded.

Parameters:

contentMd5 - MD5 value of the data to be uploaded

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