com.obs.services.model

Class GenericRequest

java.lang.Object

com.obs.services.model.GenericRequest

Direct Known Subclasses:

AbstractBulkRequest, BaseBucketRequest, BaseObjectRequest, CreateBucketRequest, DeleteObjectsRequest, ListContentSummaryRequest, ListMultipartUploadsRequest, ListObjectsRequest, ListVersionsRequest, OptionsInfoRequest, ReadAheadRequest

public class GenericRequest
extends Object

Basic class of all requests, which encapsulates common parameters used by all requests.

Since:

3.20.3

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bucketName
protected HttpMethodEnum	httpMethod
protected HashMap<String,String>	userHeaders

Constructor Summary

Constructors

Constructor and Description
GenericRequest()
GenericRequest(String bucketName)

Method Summary

Modifier and Type	Method and Description
void	addUserHeaders(String key, String value)
String	getBucketName() Obtain the bucket name.
HttpMethodEnum	getHttpMethod()
HashMap<String,String>	getUserHeaders()
boolean	isRequesterPays() If the requester is allowed to pay, true is returned.
void	setBucketName(String bucketName) Set the bucket name.
void	setRequesterPays(boolean isRequesterPays) Used to configure whether to enable the requester-pays function.
void	setUserHeaders(HashMap<String,String> userHeaders)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

bucketName

protected String bucketName

userHeaders

protected HashMap<String,String> userHeaders

httpMethod

protected HttpMethodEnum httpMethod

Constructor Detail

GenericRequest

public GenericRequest()

GenericRequest

public GenericRequest(String bucketName)

Method Detail

getHttpMethod

public HttpMethodEnum getHttpMethod()

setBucketName

public void setBucketName(String bucketName)

Set the bucket name.

Parameters:

bucketName - Bucket name

getBucketName

public String getBucketName()

Obtain the bucket name.

Returns:

Bucket name

addUserHeaders

public void addUserHeaders(String key,
                           String value)

setUserHeaders

public void setUserHeaders(HashMap<String,String> userHeaders)

getUserHeaders

public HashMap<String,String> getUserHeaders()

isRequesterPays

public boolean isRequesterPays()

If the requester is allowed to pay, true is returned. Otherwise, false is returned.

If the requester-pays function is enabled for a bucket, this attribute must be set to true when the bucket is requested by a requester other than the bucket owner. Otherwise, status code 403 is returned.

After the requester-pays function is enabled, anonymous access to the bucket is not allowed.

Returns:

If the requester is allowed to pay, true is returned. Otherwise, false is returned.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used to configure whether to enable the requester-pays function.

If the requester-pays function is enabled for a bucket, this attribute must be set to true when the bucket is requested by a requester other than the bucket owner. Otherwise, status code 403 is returned.

After the requester-pays function is enabled, anonymous access to the bucket is not allowed.

Parameters:

isRequesterPays - True indicates to enable the requester-pays function. False indicates to disable the requester-pays function.

toString

public String toString()

Overrides:

toString in class Object