com.obs.services.model

Class PutObjectsRequest

java.lang.Object

com.obs.services.model.AbstractBulkRequest

com.obs.services.model.PutObjectsRequest

public class PutObjectsRequest
extends AbstractBulkRequest

Request parameters for uploading objects in a batch.

Field Summary

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

bucketName, taskQueueNum, taskThreadNum

Constructor Summary

Constructors

Constructor and Description
PutObjectsRequest(String bucketName, List<String> filePaths) Constructor
PutObjectsRequest(String bucketName, String folderPath) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
AccessControlList	getAcl() Obtain the ACL of the object.
Set<ExtensionObjectPermissionEnum>	getAllGrantPermissions() Obtain all OBS extended permissions.
long	getBigfileThreshold() Obtain the threshold size of a file for starting multipart upload.
TaskCallback<PutObjectResult,PutObjectBasicRequest>	getCallback() Obtain the callback object of an upload task.
long	getDetailProgressInterval() Obtain the callback threshold of the data transfer listener.
Set<String>	getDomainIdsByGrantPermission(ExtensionObjectPermissionEnum extensionPermissionEnum) Obtain the list of user IDs with the specified OBS extension permissions.
Map<ExtensionObjectPermissionEnum,Set<String>>	getExtensionPermissionMap() Obtain the set of relationships between users and OBS extension permissions.
List<String>	getFilePaths() Obtain the list of local paths of the batch uploaded files.
String	getFolderPath() Obtain the local path of the uploaded folder.
Set<ExtensionObjectPermissionEnum>	getGrantPermissionsByDomainId(String domainId) Obtain the OBS extension permissions of a specified user.
long	getPartSize() Obtain the part size set for uploading an object.
String	getPrefix() Obtain the specific folder to which the file is uploaded.
SseCHeader	getSseCHeader() Obtain SSE-C encryption headers of the object.
SseKmsHeader	getSseKmsHeader() Obtain SSE-KMS encryption headers of the object.
String	getSuccessRedirectLocation() Obtain the redirection address after a successfully responded request.
int	getTaskNum() Obtain the maximum number of threads used for processing upload tasks concurrently.
long	getTaskProgressInterval() Obtain the interval for updating the task progress information.
UploadObjectsProgressListener	getUploadObjectsProgressListener() Obtain the progress listener of the bulk task.
void	grantExtensionPermission(String domainId, ExtensionObjectPermissionEnum extensionPermissionEnum) Grant the OBS extension permissions to a user.
void	setAcl(AccessControlList acl) Set the object ACL.
void	setBigfileThreshold(long bigfileThreshold) Set the threshold size of a file for starting multipart upload.
void	setCallback(TaskCallback<PutObjectResult,PutObjectBasicRequest> callback) Set the callback object of an upload task.
void	setDetailProgressInterval(long detailProgressInterval) Set the callback threshold of the data transfer listener.
void	setExtensionPermissionMap(Map<ExtensionObjectPermissionEnum,Set<String>> extensionPermissionMap) Set the set of relationships between users and OBS extension permissions.
void	setPartSize(long partSize) Set the part size for uploading the object.
void	setPrefix(String prefix) Set the specific folder to which the file is uploaded.
void	setSseCHeader(SseCHeader sseCHeader) Set SSE-C encryption headers of the object.
void	setSseKmsHeader(SseKmsHeader sseKmsHeader) Set SSE-KMS encryption headers of the object.
void	setSuccessRedirectLocation(String successRedirectLocation) Set the redirection address after a successfully responded request.
void	setTaskNum(int taskNum) Set the maximum number of threads used for processing upload tasks concurrently.
void	setTaskProgressInterval(long taskProgressInterval) Set the interval for updating the task progress information.
void	setUploadObjectsProgressListener(UploadObjectsProgressListener listener) Set the progress listener of the bulk task.
String	toString()
void	withdrawExtensionPermission(String domainId, ExtensionObjectPermissionEnum extensionPermissionEnum) Withdraw the OBS extension permissions from a user.
void	withdrawExtensionPermissions(String domainId) Withdraw all OBS extension permissions from a user.

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

getBucketName, getProgressInterval, getProgressListener, getTaskQueueNum, getTaskThreadNum, setBucketName, setProgressInterval, setProgressListener, setTaskQueueNum, setTaskThreadNum

Methods inherited from class java.lang.Object

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

Constructor Detail

PutObjectsRequest

public PutObjectsRequest(String bucketName,
                 String folderPath)

Constructor

Parameters:

bucketName - Bucket name

folderPath - Local path from which the folder is uploaded

PutObjectsRequest

public PutObjectsRequest(String bucketName,
                 List<String> filePaths)

Constructor

Parameters:

bucketName - Bucket name

filePaths - List of local paths from which a batch of files are uploaded

Method Detail

getFolderPath

public String getFolderPath()

Obtain the local path of the uploaded folder.

Returns:

folderPath Local path from which the folder is uploaded

getFilePaths

public List<String> getFilePaths()

Obtain the list of local paths of the batch uploaded files.

Returns:

filePaths List of local paths from which a batch of files are uploaded

getCallback

public TaskCallback<PutObjectResult,PutObjectBasicRequest> getCallback()

Obtain the callback object of an upload task.

Returns:

callback Callback object

setCallback

public void setCallback(TaskCallback<PutObjectResult,PutObjectBasicRequest> callback)

Set the callback object of an upload task.

Parameters:

callback - Callback object

getPartSize

public long getPartSize()

Obtain the part size set for uploading an object.

Returns:

partSize Part size

setPartSize

public void setPartSize(long partSize)

Set the part size for uploading the object.

Parameters:

partSize - Part size

getBigfileThreshold

public long getBigfileThreshold()

Obtain the threshold size of a file for starting multipart upload.

Returns:

bigfileThreshold Threshold size of a file for multipart upload

setBigfileThreshold

public void setBigfileThreshold(long bigfileThreshold)

Set the threshold size of a file for starting multipart upload.

Parameters:

bigfileThreshold - Threshold size of a file for multipart upload

getTaskNum

public int getTaskNum()

Obtain the maximum number of threads used for processing upload tasks concurrently.

Returns:

Maximum number of threads used for processing upload tasks concurrently

setTaskNum

public void setTaskNum(int taskNum)

Set the maximum number of threads used for processing upload tasks concurrently.

Parameters:

taskNum - Maximum number of threads used for processing upload tasks concurrently

getPrefix

public String getPrefix()

Obtain the specific folder to which the file is uploaded.

Returns:

prefix Folder

setPrefix

public void setPrefix(String prefix)

Set the specific folder to which the file is uploaded.

Parameters:

prefix - Folder

getUploadObjectsProgressListener

public UploadObjectsProgressListener getUploadObjectsProgressListener()

Obtain the progress listener of the bulk task.

Returns:

Progress listener

setUploadObjectsProgressListener

public void setUploadObjectsProgressListener(UploadObjectsProgressListener listener)

Set the progress listener of the bulk task.

Parameters:

listener - Progress listener

getTaskProgressInterval

public long getTaskProgressInterval()

Obtain the interval for updating the task progress information.

Returns:

taskProgressInterval Interval for updating the task progress

setTaskProgressInterval

public void setTaskProgressInterval(long taskProgressInterval)

Set the interval for updating the task progress information.

Parameters:

taskProgressInterval - Interval for updating the task progress

getDetailProgressInterval

public long getDetailProgressInterval()

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

Returns:

Callback threshold of the data transfer listener

setDetailProgressInterval

public void setDetailProgressInterval(long detailProgressInterval)

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

Parameters:

detailProgressInterval - Callback threshold of the data transfer listener

getSseKmsHeader

public SseKmsHeader getSseKmsHeader()

Obtain SSE-KMS encryption headers of the object.

Returns:

SSE-KMS encryption headers

setSseKmsHeader

public void setSseKmsHeader(SseKmsHeader sseKmsHeader)

Set SSE-KMS encryption headers of the object.

Parameters:

sseKmsHeader - SSE-KMS encryption headers

getSseCHeader

public SseCHeader getSseCHeader()

Obtain SSE-C encryption headers of the object.

Returns:

SSE-C encryption headers

setSseCHeader

public void setSseCHeader(SseCHeader sseCHeader)

Set SSE-C encryption headers of the object.

Parameters:

sseCHeader - SSE-C encryption headers

getAcl

public AccessControlList getAcl()

Obtain the ACL of the object.

Returns:

Object ACL

setAcl

public void setAcl(AccessControlList acl)

Set the object ACL.

Parameters:

acl - Object ACL

getSuccessRedirectLocation

public String getSuccessRedirectLocation()

Obtain the redirection address after a successfully responded request.

Returns:

Redirection address

setSuccessRedirectLocation

public void setSuccessRedirectLocation(String successRedirectLocation)

Set the redirection address after a successfully responded request.

Parameters:

successRedirectLocation - Redirection address

grantExtensionPermission

public void grantExtensionPermission(String domainId,
                            ExtensionObjectPermissionEnum extensionPermissionEnum)

Grant the OBS extension permissions to a user.

Parameters:

domainId - User's domain ID

extensionPermissionEnum - OBS extension permissions

withdrawExtensionPermission

public void withdrawExtensionPermission(String domainId,
                               ExtensionObjectPermissionEnum extensionPermissionEnum)

Withdraw the OBS extension permissions from a user.

Parameters:

domainId - User's domain ID

extensionPermissionEnum - OBS extension permissions

withdrawExtensionPermissions

public void withdrawExtensionPermissions(String domainId)

Withdraw all OBS extension permissions from a user.

Parameters:

domainId - User's domain ID

getAllGrantPermissions

public Set<ExtensionObjectPermissionEnum> getAllGrantPermissions()

Obtain all OBS extended permissions.

Returns:

OBS List of extension permissions

getDomainIdsByGrantPermission

public Set<String> getDomainIdsByGrantPermission(ExtensionObjectPermissionEnum extensionPermissionEnum)

Obtain the list of user IDs with the specified OBS extension permissions.

Parameters:

extensionPermissionEnum - OBS extension permissions

Returns:

List of user IDs

getGrantPermissionsByDomainId

public Set<ExtensionObjectPermissionEnum> getGrantPermissionsByDomainId(String domainId)

Obtain the OBS extension permissions of a specified user.

Parameters:

domainId - User ID

Returns:

OBS Extension permission set

getExtensionPermissionMap

public Map<ExtensionObjectPermissionEnum,Set<String>> getExtensionPermissionMap()

Obtain the set of relationships between users and OBS extension permissions.

Returns:

Set of relationships between users and OBS extended permissions

setExtensionPermissionMap

public void setExtensionPermissionMap(Map<ExtensionObjectPermissionEnum,Set<String>> extensionPermissionMap)

Set the set of relationships between users and OBS extension permissions.

Parameters:

extensionPermissionMap - Set of relationships between users and OBS extended permissions

toString

public String toString()

Overrides:

toString in class Object