SCSClient (java-sdk 1.2.2-SNAPSHOT API)

java.lang.Object
- com.sinacloud.scs.SCSWebServiceClient
- - com.sinacloud.scs.services.scs.SCSClient

所有已实现的接口:: SCS

public class SCSClient
extends SCSWebServiceClient
implements SCS

字段概要
- 从类继承的字段 com.sinacloud.scs.SCSWebServiceClient
  client, clientConfiguration, endpoint, endpoint4Upload, timeOffset

构造器概要

构造器
构造器和说明
`SCSClient()` Constructs a new client to invoke service methods on Amazon S3.
`SCSClient(AWSCredentials awsCredentials)` Constructs a new Amazon S3 client using the specified AWS credentials to access Amazon S3.
`SCSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new Amazon S3 client using the specified AWS credentials and client configuration to access Amazon S3.
`SCSClient(AWSCredentialsProvider credentialsProvider)` Constructs a new Amazon S3 client using the specified AWS credentials provider to access Amazon S3.
`SCSClient(AWSCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new Amazon S3 client using the specified AWS credentials and client configuration to access Amazon S3.
`SCSClient(ClientConfiguration clientConfiguration)` Constructs a new client using the specified client configuration to access Amazon S3.

方法概要

方法
限定符和类型	方法和说明
`ObjectMetadata`	`completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)` Completes a multipart upload by assembling previously uploaded parts.
`void`	`copyObject(CopyObjectRequest copyObjectRequest)` Copies a source object to a new destination in SCS.
`void`	`copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)` Copies a source object to a new destination in SCS.
`Bucket`	`createBucket(CreateBucketRequest createBucketRequest)` Creates a new SCS bucket in the default Every object stored in SCS is contained within a bucket.
`Bucket`	`createBucket(String bucketName)` Creates a new SCS bucket with the specified name in the default Every object stored in SCS is contained within a bucket.
`protected ExecutionContext`	`createExecutionContext(SCSWebServiceRequest req)`
`protected <X extends SCSWebServiceRequest> Request<X>`	`createRequest(String bucketName, String key, X originalRequest, HttpMethodName httpMethod)` Creates and initializes a new request object for the specified S3 resource.
`protected Signer`	`createSigner(Request<?> request, String bucketName, String key)`
`void`	`deleteBucket(DeleteBucketRequest deleteBucketRequest)` Deletes the specified bucket.
`void`	`deleteBucket(String bucketName)` Deletes the specified bucket.
`void`	`deleteObject(DeleteObjectRequest deleteObjectRequest)` Deletes the specified object in the specified bucket.
`void`	`deleteObject(String bucketName, String key)` Deletes the specified object in the specified bucket.
`boolean`	`doesBucketExist(String bucketName)` Checks if the specified bucket exists.
`URL`	`generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)` Returns a pre-signed URL for accessing an SCS resource.
`URL`	`generatePresignedUrl(String bucketName, String key, Date expiration, boolean bucketNameAsDomain)` Returns a pre-signed URL for accessing an SCS resource.
`URL`	`generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method, boolean bucketNameAsDomain)` Returns a pre-signed URL for accessing an SCS resource.
`AccessControlList`	`getBucketAcl(GetBucketAclRequest getBucketAclRequest)` Gets the `AccessControlList` (ACL) for the specified SCS bucket.
`AccessControlList`	`getBucketAcl(String bucketName)` Gets the `AccessControlList` (ACL) for the specified SCS bucket.
`BucketInfo`	`getBucketInfo(String bucketName)` http://open.sinastorage.cn/?
`S3Object`	`getObject(GetObjectRequest getObjectRequest)` Gets the object stored in SCS under the specified bucket and key.
`ObjectMetadata`	`getObject(GetObjectRequest getObjectRequest, File destinationFile)` Gets the object metadata for the object stored in SCS under the specified bucket and key, and saves the object contents to the specified file.
`S3Object`	`getObject(String bucketName, String key)` Gets the object stored in SCS under the specified bucket and key.
`AccessControlList`	`getObjectAcl(String bucketName, String key)` Gets the `AccessControlList` (ACL) for the specified object in SCS.
`ObjectInfo`	`getObjectInfo(String bucketName, String key)` http://open.sinastorage.cn/?
`ObjectMetadata`	`getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)` Gets the metadata for the specified SCS object without actually fetching the object itself.
`ObjectMetadata`	`getObjectMetadata(String bucketName, String key)` Gets the metadata for the specified SCS object without actually fetching the object itself.
`String`	`getResourceUrl(String bucketName, String key)` Returns the URL to the key in the bucket given, using the client's scheme and endpoint.
`URL`	`getUrl(String bucketName, String key)` Returns an URL for the object stored in the specified bucket and key.
`InitiateMultipartUploadResult`	`initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest)` Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID.
`InitiateMultipartUploadResult`	`initiateMultipartUpload(String bucketName, String key)` Initiates a multipart upload and returns an InitiateMultipartUploadResult
`List<Bucket>`	`listBuckets()` Returns a list of all SCS buckets that the authenticated sender of the request owns.
`List<Bucket>`	`listBuckets(ListBucketsRequest listBucketsRequest)` Returns a list of all SCS buckets that the authenticated sender of the request owns.
`ObjectListing`	`listNextBatchOfObjects(ObjectListing previousObjectListing)` Provides an easy way to continue a truncated object listing and retrieve the next page of results.
`ObjectListing`	`listObjects(ListObjectsRequest listObjectsRequest)` Returns a list of summary information about the objects in the specified bucket.
`ObjectListing`	`listObjects(String bucketName)` Returns a list of summary information about the objects in the specified buckets.
`ObjectListing`	`listObjects(String bucketName, String prefix)` Returns a list of summary information about the objects in the specified bucket.
`PartListing`	`listParts(ListPartsRequest listPartsRequest)` Lists the parts that have been uploaded for a specific multipart upload.
`protected static void`	`populateRequestMetadata(Request<?> request, ObjectMetadata metadata)` Populates the specified request object with the appropriate headers from the `ObjectMetadata` object.
`protected <T> void`	`presignRequest(Request<T> request, HttpMethod methodName, String bucketName, String key, Date expiration, String subResource)` Pre-signs the specified request, using a signature query-string parameter.
`PutObjectResult`	`putObject(PutObjectRequest putObjectRequest)` Uploads a new object to the specified SCS bucket.
`PutObjectResult`	`putObject(String bucketName, String key, File file)` Uploads the specified file to SCS under the specified bucket and key name.
`PutObjectResult`	`putObject(String bucketName, String key, File file, Map<String,String> requestHeader)` Uploads the specified file to SCS under the specified bucket and key name.
`PutObjectResult`	`putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)` Uploads the specified input stream and object metadata to SCS under the specified bucket and key name.
`PutObjectResult`	`putObjectRelax(String bucketName, String key, String fileSha1, long fileLength)` 秒传接口
`void`	`setBucketAcl(SetBucketAclRequest setBucketAclRequest)` Sets the `AccessControlList` for the specified SCS bucket.
`void`	`setBucketAcl(String bucketName, AccessControlList acl)` Sets the `AccessControlList` for the specified SCS bucket.
`void`	`setObjectAcl(String bucketName, String key, AccessControlList acl)` Sets the `AccessControlList` for the specified object in SCS.
`void`	`setObjectMetadata(String bucketName, String key, ObjectMetadata objectMetadata)` 设置object metadata
`void`	`setS3ClientOptions(S3ClientOptions clientOptions)` Override the default S3 client options for this client.
`UploadPartResult`	`uploadPart(UploadPartRequest uploadPartRequest)` Uploads a part in a multipart upload.

从类继承的方法 com.sinacloud.scs.SCSWebServiceClient
convertToHttpRequest, createExecutionContext, createExecutionContext, getTimeOffset, setConfiguration, setEndpoint, setEndpoint4Upload, setTimeOffset, shutdown, withTimeOffset

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SCSClient
```
public SCSClient()
```
    Constructs a new client to invoke service methods on Amazon S3. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance Profile Credentials - delivered through the Amazon EC2 metadata service
    If no credentials are found in the chain, this client will attempt to work in an anonymous mode where requests aren't signed. Only a subset of the Amazon S3 API will work with anonymous (i.e. unsigned) requests, but this can prove useful in some situations. For example:
    - If an Amazon S3 bucket has Permission.Read permission for the GroupGrantee#AllUsers group, anonymous clients can call listObjects(String) to see what objects are stored in a bucket.
    - If an object has Permission.Read permission for the GroupGrantee#AllUsers group, anonymous clients can call getObject(String, String) and getObjectMetadata(String, String) to pull object content and metadata.
    - If a bucket has Permission.Write permission for the GroupGrantee#AllUsers group, anonymous clients can upload objects to the bucket.
    You can force the client to operate in an anonymous mode, and skip the credentials provider chain, by passing in null for the credentials.
    另请参阅:
    SCSClient(AWSCredentials), SCSClient(AWSCredentials, ClientConfiguration)
  - SCSClient
```
public SCSClient(AWSCredentials awsCredentials)
```
    Constructs a new Amazon S3 client using the specified AWS credentials to access Amazon S3.
    
    参数:
    awsCredentials - The AWS credentials to use when making requests to Amazon S3 with this client.
    另请参阅:
    SCSClient(), SCSClient(AWSCredentials, ClientConfiguration)
  - SCSClient
```
public SCSClient(AWSCredentials awsCredentials,
         ClientConfiguration clientConfiguration)
```
    Constructs a new Amazon S3 client using the specified AWS credentials and client configuration to access Amazon S3.
    
    参数:
    awsCredentials - The AWS credentials to use when making requests to Amazon S3 with this client.
    clientConfiguration - The client configuration options controlling how this client connects to Amazon S3 (e.g. proxy settings, retry counts, etc).
    另请参阅:
    SCSClient(), SCSClient(AWSCredentials)
  - SCSClient
```
public SCSClient(AWSCredentialsProvider credentialsProvider)
```
    Constructs a new Amazon S3 client using the specified AWS credentials provider to access Amazon S3.
    
    参数:
    credentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - SCSClient
```
public SCSClient(AWSCredentialsProvider credentialsProvider,
         ClientConfiguration clientConfiguration)
```
    Constructs a new Amazon S3 client using the specified AWS credentials and client configuration to access Amazon S3.
    
    参数:
    credentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to Amazon S3 (e.g. proxy settings, retry counts, etc).
  - SCSClient
```
public SCSClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client using the specified client configuration to access Amazon S3. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance Profile Credentials - delivered through the Amazon EC2 metadata service
    If no credentials are found in the chain, this client will attempt to work in an anonymous mode where requests aren't signed. Only a subset of the Amazon S3 API will work with anonymous (i.e. unsigned) requests, but this can prove useful in some situations. For example:
    - If an Amazon S3 bucket has Permission.Read permission for the GroupGrantee#AllUsers group, anonymous clients can call listObjects(String) to see what objects are stored in a bucket.
    - If an object has Permission.Read permission for the GroupGrantee#AllUsers group, anonymous clients can call getObject(String, String) and getObjectMetadata(String, String) to pull object content and metadata.
    - If a bucket has Permission.Write permission for the GroupGrantee#AllUsers group, anonymous clients can upload objects to the bucket.
    You can force the client to operate in an anonymous mode, and skip the credentials provider chain, by passing in null for the credentials.
    参数:
    clientConfiguration - The client configuration options controlling how this client connects to Amazon S3 (e.g. proxy settings, retry counts, etc).
    另请参阅:
    SCSClient(AWSCredentials), SCSClient(AWSCredentials, ClientConfiguration)
- 方法详细资料
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext(SCSWebServiceRequest req)
```
  - setS3ClientOptions
```
public void setS3ClientOptions(S3ClientOptions clientOptions)
```
    Override the default S3 client options for this client.
    
    指定者:
    
    setS3ClientOptions 在接口中 SCS
    
    参数:
    clientOptions - The S3 client options to use.
  - listObjects
```
public ObjectListing listObjects(String bucketName)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    
    Returns a list of summary information about the objects in the specified buckets. List results are always returned in lexicographic (alphabetical) order.
    
    Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, SCS uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.
    
    The total number of keys in a bucket doesn't substantially affect list performance.
    
    指定者:
    
    listObjects 在接口中 SCS
    
    参数:
    bucketName - The name of the SCS bucket to list.
    
    返回:
    A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    listObjects(String, String), listObjects(ListObjectsRequest)
  - listObjects
```
public ObjectListing listObjects(String bucketName,
                        String prefix)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    Returns a list of summary information about the objects in the specified bucket. Depending on request parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.
    
    Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, SCS uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.
    
    For example, consider a bucket that contains the following keys:
    - "foo/bar/baz"
    - "foo/bar/bash"
    - "foo/bar/bang"
    - "foo/boo"
    If calling listObjects with a prefix value of "foo/" and a delimiter value of "/" on this bucket, an ObjectListing is returned that contains one key ("foo/boo") and one entry in the common prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make another call to listObjects setting the prefix parameter to any interesting common prefix to list the individual keys under that prefix.
    
    The total number of keys in a bucket doesn't substantially affect list performance.
    指定者:
    
    listObjects 在接口中 SCS
    
    参数:
    bucketName - The name of the SCS bucket to list.
    prefix - An optional parameter restricting the response to keys beginning with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.
    
    返回:
    A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    listObjects(String), listObjects(ListObjectsRequest)
  - listObjects
```
public ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    Returns a list of summary information about the objects in the specified bucket. Depending on the request parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.
    
    Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, SCS uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.
    
    Calling ListObjectsRequest.setDelimiter(String) sets the delimiter, allowing groups of keys that share the delimiter-terminated prefix to be included in the returned listing. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories. These common prefixes can be retrieved through the ObjectListing.getCommonPrefixes() method.
    
    For example, consider a bucket that contains the following keys:
    - "foo/bar/baz"
    - "foo/bar/bash"
    - "foo/bar/bang"
    - "foo/boo"
    If calling listObjects with a prefix value of "foo/" and a delimiter value of "/" on this bucket, an ObjectListing is returned that contains one key ("foo/boo") and one entry in the common prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make another call to listObjects setting the prefix parameter to any interesting common prefix to list the individual keys under that prefix.
    
    The total number of keys in a bucket doesn't substantially affect list performance.
    指定者:
    
    listObjects 在接口中 SCS
    
    参数:
    listObjectsRequest - The request object containing all options for listing the objects in a specified bucket.
    
    返回:
    A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    listObjects(String), listObjects(String, String)
  - listNextBatchOfObjects
```
public ObjectListing listNextBatchOfObjects(ObjectListing previousObjectListing)
                                     throws SCSClientException,
                                            SCSServiceException
```
    从接口复制的说明: SCS
    
    Provides an easy way to continue a truncated object listing and retrieve the next page of results.
    
    To continue the object listing and retrieve the next page of results, call the initial ObjectListing from one of the listObjects methods. If truncated (indicated when ObjectListing.isTruncated() returns true), pass the ObjectListing back into this method in order to retrieve the next page of results. Continue using this method to retrieve more results until the returned ObjectListing indicates that it is not truncated.
    
    指定者:
    
    listNextBatchOfObjects 在接口中 SCS
    
    参数:
    previousObjectListing - The previous truncated ObjectListing. If a non-truncated ObjectListing is passed in, an empty ObjectListing is returned without ever contacting SCS.
    
    返回:
    The next set of ObjectListing results, beginning immediately after the last result in the specified previous ObjectListing.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    listObjects(String), listObjects(String, String), listObjects(ListObjectsRequest)
  - listBuckets
```
public List<Bucket> listBuckets(ListBucketsRequest listBucketsRequest)
                         throws SCSClientException,
                                SCSServiceException
```
    从接口复制的说明: SCS
    
    Returns a list of all SCS buckets that the authenticated sender of the request owns.
    
    Users must authenticate with a valid AWS Access Key ID that is registered with SCS. Anonymous requests cannot list buckets, and users cannot list buckets that they did not create.
    
    指定者:
    
    listBuckets 在接口中 SCS
    
    返回:
    A list of all of the SCS buckets owned by the authenticated sender of the request.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.listBuckets()
  - listBuckets
```
public List<Bucket> listBuckets()
                         throws SCSClientException,
                                SCSServiceException
```
    从接口复制的说明: SCS
    
    Returns a list of all SCS buckets that the authenticated sender of the request owns.
    
    Users must authenticate with a valid AWS Access Key ID that is registered with SCS. Anonymous requests cannot list buckets, and users cannot list buckets that they did not create.
    
    指定者:
    
    listBuckets 在接口中 SCS
    
    返回:
    A list of all of the SCS buckets owned by the authenticated sender of the request.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.listBuckets(ListBucketsRequest)
  - createBucket
```
public Bucket createBucket(String bucketName)
                    throws SCSClientException,
                           SCSServiceException
```
    从接口复制的说明: SCS
    Creates a new SCS bucket with the specified name in the default
    
    Every object stored in SCS is contained within a bucket. Buckets partition the namespace of objects stored in SCS at the top level. Within a bucket, any name can be used for objects. However, bucket names must be unique across all of SCS.
    
    Bucket ownership is similar to the ownership of Internet domain names. Within SCS, only a single user owns each bucket. Once a uniquely named bucket is created in SCS, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an SCS account.
    
    To conform with DNS requirements, the following constraints apply:
    - Bucket names should not contain underscores
    - Bucket names should be between 3 and 63 characters long
    - Bucket names should not end with a dash
    - Bucket names cannot contain adjacent periods
    - Bucket names cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)
    - Bucket names cannot contain uppercase characters
    There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.
    
    Buckets cannot be nested; buckets cannot be created within other buckets.
    
    Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup routine that runs less often.
    
    To create a bucket, authenticate with an account that has a valid AWS Access Key ID and is registered with SCS. Anonymous requests are never allowed to create buckets.
    指定者:
    
    createBucket 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket to create. All buckets in SCS share a single namespace; ensure the bucket is given a unique name.
    
    返回:
    The newly created bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - createBucket
```
public Bucket createBucket(CreateBucketRequest createBucketRequest)
                    throws SCSClientException,
                           SCSServiceException
```
    从接口复制的说明: SCS
    Creates a new SCS bucket in the default
    
    Every object stored in SCS is contained within a bucket. Buckets partition the namespace of objects stored in SCS at the top level. Within a bucket, any name can be used for objects. However, bucket names must be unique across all of SCS.
    
    Bucket ownership is similar to the ownership of Internet domain names. Within SCS, only a single user owns each bucket. Once a uniquely named bucket is created in SCS, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an SCS account.
    
    To conform with DNS requirements, the following constraints apply:
    - Bucket names should not contain underscores
    - Bucket names should be between 3 and 63 characters long
    - Bucket names should not end with a dash
    - Bucket names cannot contain adjacent periods
    - Bucket names cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)
    - Bucket names cannot contain uppercase characters
    There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.
    
    Buckets cannot be nested; buckets cannot be created within other buckets.
    
    Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup routine that runs less often.
    
    To create a bucket, authenticate with an account that has a valid AWS Access Key ID and is registered with SCS. Anonymous requests are never allowed to create buckets.
    指定者:
    
    createBucket 在接口中 SCS
    
    参数:
    createBucketRequest - The request object containing all options for creating an SCS bucket.
    
    返回:
    The newly created bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - getObjectAcl
```
public AccessControlList getObjectAcl(String bucketName,
                             String key)
                               throws SCSClientException,
                                      SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the AccessControlList (ACL) for the specified object in SCS.
    
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    
    指定者:
    
    getObjectAcl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the object whose ACL is being retrieved.
    key - The key of the object within the specified bucket whose ACL is being retrieved.
    
    返回:
    The AccessControlList for the specified SCS object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS#getObjectAcl(String, String, String)
  - setObjectAcl
```
public void setObjectAcl(String bucketName,
                String key,
                AccessControlList acl)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Sets the AccessControlList for the specified object in SCS.
    
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    
    When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for an object ( getObjectAcl(String, String)), modify it as necessary, and then use this method to upload the new ACL.
    
    指定者:
    
    setObjectAcl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the object whose ACL is being set.
    key - The key of the object within the specified bucket whose ACL is being set.
    acl - The new AccessControlList for the specified object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS#setObjectAcl(String, String, CannedAccessControlList), SCS#setObjectAcl(String, String, String, AccessControlList), SCS#setObjectAcl(String, String, String, CannedAccessControlList)
  - getBucketInfo
```
public BucketInfo getBucketInfo(String bucketName)
                         throws SCSClientException,
                                SCSServiceException
```
    从接口复制的说明: SCS
    
    http://open.sinastorage.cn/?c=doc&a=api#get_bucket_meta Bucket Meta Object
    
    指定者:
    
    getBucketInfo 在接口中 SCS
    
    返回:
    
    抛出:
    
    SCSClientException
    
    SCSServiceException
  - getObjectInfo
```
public ObjectInfo getObjectInfo(String bucketName,
                       String key)
                         throws SCSClientException,
                                SCSServiceException
```
    从接口复制的说明: SCS
    
    http://open.sinastorage.cn/?c=doc&a=api#get_object_meta ObjectInfo Object
    
    指定者:
    
    getObjectInfo 在接口中 SCS
    
    返回:
    
    抛出:
    
    SCSClientException
    
    SCSServiceException
  - getBucketAcl
```
public AccessControlList getBucketAcl(String bucketName)
                               throws SCSClientException,
                                      SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the AccessControlList (ACL) for the specified SCS bucket.
    
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    
    指定者:
    
    getBucketAcl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket whose ACL is being retrieved.
    
    返回:
    The AccessControlList for the specified S3 bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - getBucketAcl
```
public AccessControlList getBucketAcl(GetBucketAclRequest getBucketAclRequest)
                               throws SCSClientException,
                                      SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the AccessControlList (ACL) for the specified SCS bucket.
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    
    指定者:
    
    getBucketAcl 在接口中 SCS
    
    参数:
    getBucketAclRequest - The request containing the name of the bucket whose ACL is being retrieved.
    
    返回:
    The AccessControlList for the specified S3 bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - setBucketAcl
```
public void setBucketAcl(String bucketName,
                AccessControlList acl)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Sets the AccessControlList for the specified SCS bucket.
    
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    
    When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for a bucket ( getBucketAcl(String)), modify it as necessary, and then use this method to upload the new ACL.
    
    指定者:
    
    setBucketAcl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket whose ACL is being set.
    acl - The new AccessControlList for the specified bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS#setBucketAcl(String, CannedAccessControlList)
  - setBucketAcl
```
public void setBucketAcl(SetBucketAclRequest setBucketAclRequest)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Sets the AccessControlList for the specified SCS bucket.
    Each bucket and object in SCS has an ACL that defines its access control policy. When a request is made, SCS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, SCS returns an error.
    When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for a bucket ( getBucketAcl(String)), modify it as necessary, and then use this method to upload the new ACL.
    
    指定者:
    
    setBucketAcl 在接口中 SCS
    
    参数:
    setBucketAclRequest - The request object containing the bucket to modify and the ACL to set.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(String bucketName,
                               String key)
                                 throws SCSClientException,
                                        SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the metadata for the specified SCS object without actually fetching the object itself. This is useful in obtaining only the object metadata, and avoids wasting bandwidth on fetching the object data.
    
    The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in SCS.
    
    指定者:
    
    getObjectMetadata 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the object's whose metadata is being retrieved.
    key - The key of the object whose metadata is being retrieved.
    
    返回:
    All SCS object metadata for the specified object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.getObjectMetadata(GetObjectMetadataRequest)
  - setObjectMetadata
```
public void setObjectMetadata(String bucketName,
                     String key,
                     ObjectMetadata objectMetadata)
                       throws SCSClientException,
                              SCSServiceException
```
    从接口复制的说明: SCS
    
    设置object metadata
    
    指定者:
    
    setObjectMetadata 在接口中 SCS
    
    抛出:
    
    SCSClientException
    
    SCSServiceException
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
                                 throws SCSClientException,
                                        SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the metadata for the specified SCS object without actually fetching the object itself. This is useful in obtaining only the object metadata, and avoids wasting bandwidth on fetching the object data.
    
    The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in SCS.
    
    For more information about enabling versioning for a bucket, see #setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).
    
    指定者:
    
    getObjectMetadata 在接口中 SCS
    
    参数:
    getObjectMetadataRequest - The request object specifying the bucket, key and optional version ID of the object whose metadata is being retrieved.
    
    返回:
    All S3 object metadata for the specified object.
    
    抛出:
    
    SCSClientException - If any errors are encountered on the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.getObjectMetadata(String, String)
  - getObject
```
public S3Object getObject(String bucketName,
                 String key)
                   throws SCSClientException,
                          SCSServiceException
```
    从接口复制的说明: SCS
    Gets the object stored in SCS under the specified bucket and key.
    
    Be extremely careful when using this method; the returned SCS object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream. Therefore:
    - Use the data from the input stream in SCS object as soon as possible
    - Close the input stream in SCS object as soon as possible
    If these rules are not followed, the client can run out of resources by allocating too many open, but unused, HTTP connections.
    
    To get an object from SCS, the caller must have Permission.Read access to the object.
    
    If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.
    
    For more advanced options (such as downloading only a range of an object's content, or placing constraints on when the object should be downloaded) callers can use SCS.getObject(GetObjectRequest).
    指定者:
    
    getObject 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the desired object.
    key - The key under which the desired object is stored.
    
    返回:
    The object stored in SCS in the specified bucket and key.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.getObject(GetObjectRequest), SCS.getObject(GetObjectRequest, File)
  - doesBucketExist
```
public boolean doesBucketExist(String bucketName)
                        throws SCSClientException,
                               SCSServiceException
```
    从接口复制的说明: SCS
    
    Checks if the specified bucket exists. SCS buckets are named in a global namespace; use this method to determine if a specified bucket name already exists, and therefore can't be used to create a new bucket.
    
    指定者:
    
    doesBucketExist 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket to check.
    
    返回:
    The value true if the specified bucket exists in SCS; the value false if there is no bucket in SCS with that name.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.createBucket(CreateBucketRequest)
  - getObject
```
public S3Object getObject(GetObjectRequest getObjectRequest)
                   throws SCSClientException,
                          SCSServiceException
```
    从接口复制的说明: SCS
    Gets the object stored in SCS under the specified bucket and key. Returns null if the specified constraints weren't met.
    
    Callers should be very careful when using this method; the returned SCS object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream. Callers should therefore:
    - Use the data from the input stream in SCS object as soon as possible,
    - Close the input stream in SCS object as soon as possible.
    If callers do not follow those rules, then the client can run out of resources if allocating too many open, but unused, HTTP connections.
    
    To get an object from SCS, the caller must have Permission.Read access to the object.
    
    If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.
    
    When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when SCS receives the request.
    
    If the advanced options provided in GetObjectRequest aren't needed, use the simpler SCS.getObject(String bucketName, String key) method.
    指定者:
    
    getObject 在接口中 SCS
    
    参数:
    getObjectRequest - The request object containing all the options on how to download the object.
    
    返回:
    The object stored in SCS in the specified bucket and key. Returns null if constraints were specified but not met.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.getObject(String, String), SCS.getObject(GetObjectRequest, File)
  - getObject
```
public ObjectMetadata getObject(GetObjectRequest getObjectRequest,
                       File destinationFile)
                         throws SCSClientException,
                                SCSServiceException
```
    从接口复制的说明: SCS
    
    Gets the object metadata for the object stored in SCS under the specified bucket and key, and saves the object contents to the specified file. Returns null if the specified constraints weren't met.
    
    Instead of using SCS.getObject(GetObjectRequest), use this method to ensure that the underlying HTTP stream resources are automatically closed as soon as possible. The SCS clients handles immediate storage of the object contents to the specified file.
    
    To get an object from SCS, the caller must have Permission.Read access to the object.
    
    If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.
    
    When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when SCS receives the request.
    
    指定者:
    
    getObject 在接口中 SCS
    
    参数:
    getObjectRequest - The request object containing all the options on how to download the SCS object content.
    destinationFile - Indicates the file (which might already exist) where to save the object content being downloading from SCS.
    
    返回:
    All S3 object metadata for the specified object. Returns null if constraints were specified but not met.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request, handling the response, or writing the incoming data from S3 to the specified destination file.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.getObject(String, String), SCS.getObject(GetObjectRequest)
  - deleteBucket
```
public void deleteBucket(String bucketName)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted.
    
    Only the owner of a bucket can delete it, regardless of the bucket's access control policy.
    
    指定者:
    
    deleteBucket 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket to delete.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.deleteBucket(String)
  - deleteBucket
```
public void deleteBucket(DeleteBucketRequest deleteBucketRequest)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted.
    
    Only the owner of a bucket can delete it, regardless of the bucket's access control policy (ACL).
    
    指定者:
    
    deleteBucket 在接口中 SCS
    
    参数:
    deleteBucketRequest - The request object containing all options for deleting an SCS bucket.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.deleteBucket(String)
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String key,
                        File file)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    
    Uploads the specified file to SCS under the specified bucket and key name.
    
    SCS never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.
    
    The client automatically computes a checksum of the file. SCS uses checksums to validate the data in each file.
    
    Using the file extension, SCS attempts to determine the correct content type and content disposition to use for the object.
    
    If versioning is enabled for the specified bucket, this operation will this operation will never overwrite an existing object with the same key, but will keep the existing object as an older version until that version is explicitly deleted (see SCS#deleteVersion(String, String, String).
    
    If versioning is not enabled, this operation will overwrite an existing object with the same key; SCS will store the last write request. SCS does not provide object locking. If SCS receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, a single object will be stored with the final write request.
    
    When specifying a location constraint when creating a bucket, all objects added to the bucket are stored in the bucket's region. For example, if specifying a Europe (EU) region constraint for a bucket, all of that bucket's objects are stored in EU region.
    
    The specified bucket must already exist and the caller must have Permission.Write permission to the bucket to upload an object.
    
    指定者:
    
    putObject 在接口中 SCS
    
    参数:
    bucketName - The name of an existing bucket, to which you have Permission.Write permission.
    key - The key under which to store the specified file.
    file - The file containing the data to be uploaded to SCS.
    
    返回:
    A PutObjectResult object containing the information returned by SCS for the newly created object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.putObject(PutObjectRequest), SCS.putObject(String, String, InputStream, ObjectMetadata)
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String key,
                        File file,
                        Map<String,String> requestHeader)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    
    Uploads the specified file to SCS under the specified bucket and key name.
    
    指定者:
    
    putObject 在接口中 SCS
    
    requestHeader - custom request header
    
    返回:
    
    抛出:
    
    SCSClientException
    
    SCSServiceException
  - putObjectRelax
```
public PutObjectResult putObjectRelax(String bucketName,
                             String key,
                             String fileSha1,
                             long fileLength)
```
    从接口复制的说明: SCS
    
    秒传接口
    
    指定者:
    
    putObjectRelax 在接口中 SCS
    
    fileSha1 - 文件sha1值
    fileLength - 文件大小
    
    返回:
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String key,
                        InputStream input,
                        ObjectMetadata metadata)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    
    Uploads the specified input stream and object metadata to SCS under the specified bucket and key name.
    
    SCS never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.
    
    The client automatically computes a checksum of the file. This checksum is verified against another checksum that is calculated once the data reaches SCS, ensuring the data has not corrupted in transit over the network.
    
    Using the file extension, SCS attempts to determine the correct content type and content disposition to use for the object.
    
    Content length must be specified before data can be uploaded to SCS. If the caller doesn't provide it, the library will have to buffer the contents of the input stream in order to calculate it because SCS explicitly requires that the content length be sent in the request headers before any of the data is sent.
    
    If versioning is enabled for the specified bucket, this operation will never overwrite an existing object at the same key, but instead will keep the existing object around as an older version until that version is explicitly deleted (see SCS#deleteVersion(String, String, String).
    
    If versioning is not enabled, this operation will overwrite an existing object with the same key; SCS will store the last write request. SCS does not provide object locking. If SCS receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, a single object will be stored with the final write request.
    
    When specifying a location constraint when creating a bucket, all objects added to the bucket are stored in the bucket's region. For example, if specifying a Europe (EU) region constraint for a bucket, all of that bucket's objects are stored in EU region.
    
    The specified bucket must already exist and the caller must have Permission.Write permission to the bucket to upload an object.
    
    指定者:
    
    putObject 在接口中 SCS
    
    参数:
    bucketName - The name of an existing bucket, to which you have Permission.Write permission.
    key - The key under which to store the specified file.
    input - The input stream containing the data to be uploaded to Amazon S3.
    metadata - Additional metadata instructing SCS how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).
    
    返回:
    A PutObjectResult object containing the information returned by SCS for the newly created object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.putObject(String, String, File), SCS.putObject(PutObjectRequest)
  - putObject
```
public PutObjectResult putObject(PutObjectRequest putObjectRequest)
                          throws SCSClientException,
                                 SCSServiceException
```
    从接口复制的说明: SCS
    Uploads a new object to the specified SCS bucket. The PutObjectRequest contains all the details of the request, including the bucket to upload to, the key the object will be uploaded under, and the file or input stream containing the data to upload.
    
    SCS never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.
    
    Depending on whether a file or input stream is being uploaded, this method has slightly different behavior.
    
    When uploading a file:
    - The client automatically computes a checksum of the file. SCS uses checksums to validate the data in each file.
    - Using the file extension, SCS attempts to determine the correct content type and content disposition to use for the object.
    When uploading directly from an input stream:
    - Be careful to set the correct content type in the metadata object before directly sending a stream. Unlike file uploads, content types from input streams cannot be automatically determined. If the caller doesn't explicitly set the content type, it will not be set in SCS.
    - Content length must be specified before data can be uploaded to SCS. SCS explicitly requires that the content length be sent in the request headers before it will accept any of the data. If the caller doesn't provide the length, the library must buffer the contents of the input stream in order to calculate it.
    If versioning is enabled for the specified bucket, this operation will never overwrite an existing object with the same key, but will keep the existing object as an older version until that version is explicitly deleted (see SCS#deleteVersion(String, String, String).
    
    If versioning is not enabled, this operation will overwrite an existing object with the same key; SCS will store the last write request. SCS does not provide object locking. If SCS receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, a single object will be stored with the final write request.
    
    When specifying a location constraint when creating a bucket, all objects added to the bucket are stored in the bucket's region. For example, if specifying a Europe (EU) region constraint for a bucket, all of that bucket's objects are stored in the EU region.
    
    The specified bucket must already exist and the caller must have Permission.Write permission to the bucket to upload an object.
    指定者:
    
    putObject 在接口中 SCS
    
    参数:
    putObjectRequest - The request object containing all the parameters to upload a new object to SCS.
    
    返回:
    A PutObjectResult object containing the information returned by SCS for the newly created object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    SCS.putObject(String, String, File), SCS.putObject(String, String, InputStream, ObjectMetadata)
  - copyObject
```
public void copyObject(String sourceBucketName,
              String sourceKey,
              String destinationBucketName,
              String destinationKey)
                throws SCSClientException,
                       SCSServiceException
```
    从接口复制的说明: SCS
    
    Copies a source object to a new destination in SCS.
    
    By default, all object metadata for the source object are copied to the new destination object. The SCS AcccessControlList (ACL) is not copied to the new object; the new object will have the default SCS ACL, CannedAccessControlList.Private.
    
    To copy an object, the caller's account must have read access to the source object and write access to the destination bucket
    
    This method only exposes the basic options for copying an SCS object. Additional options are available by calling the copyObject(CopyObjectRequest) method, including conditional constraints for copying objects, setting ACLs, overwriting object metadata, etc.
    
    指定者:
    
    copyObject 在接口中 SCS
    
    参数:
    sourceBucketName - The name of the bucket containing the source object to copy.
    sourceKey - The key in the source bucket under which the source object is stored.
    destinationBucketName - The name of the bucket in which the new object will be created. This can be the same name as the source bucket's.
    destinationKey - The key in the destination bucket under which the new object will be created.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    copyObject(CopyObjectRequest)
  - copyObject
```
public void copyObject(CopyObjectRequest copyObjectRequest)
                throws SCSClientException,
                       SCSServiceException
```
    从接口复制的说明: SCS
    
    Copies a source object to a new destination in SCS.
    
    By default, all object metadata for the source object are copied to the new destination object, unless new object metadata in the specified CopyObjectRequest is provided.
    
    The SCS Acccess Control List (ACL) is not copied to the new object. The new object will have the default SCS ACL, CannedAccessControlList.Private, unless one is explicitly provided in the specified CopyObjectRequest.
    
    To copy an object, the caller's account must have read access to the source object and write access to the destination bucket.
    
    If constraints are specified in the CopyObjectRequest (e.g. CopyObjectRequest.setMatchingETagConstraints(List)) and are not satisfied when SCS receives the request, this method returns null. This method returns a non-null result under all other circumstances.
    
    This method exposes all the advanced options for copying an SCS object. For simple needs, use the copyObject(String, String, String, String) method.
    
    指定者:
    
    copyObject 在接口中 SCS
    
    参数:
    copyObjectRequest - The request object containing all the options for copying an SCS object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    copyObject(String, String, String, String)
  - deleteObject
```
public void deleteObject(String bucketName,
                String key)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Deletes the specified object in the specified bucket. Once deleted, the object can only be restored if versioning was enabled when the object was deleted.
    
    If attempting to delete an object that does not exist, SCS returns a success message instead of an error message.
    
    指定者:
    
    deleteObject 在接口中 SCS
    
    参数:
    bucketName - The name of the SCS bucket containing the object to delete.
    key - The key of the object to delete.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    deleteObject(DeleteObjectRequest)
  - deleteObject
```
public void deleteObject(DeleteObjectRequest deleteObjectRequest)
                  throws SCSClientException,
                         SCSServiceException
```
    从接口复制的说明: SCS
    
    Deletes the specified object in the specified bucket. Once deleted, the object can only be restored if versioning was enabled when the object was deleted.
    
    If attempting to delete an object that does not exist, SCS will return a success message instead of an error message.
    
    指定者:
    
    deleteObject 在接口中 SCS
    
    参数:
    deleteObjectRequest - The request object containing all options for deleting an SCS object.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
    另请参阅:
    deleteObject(String, String)
  - generatePresignedUrl
```
public URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration,
                       boolean bucketNameAsDomain)
                         throws SCSClientException
```
    从接口复制的说明: SCS
    
    Returns a pre-signed URL for accessing an SCS resource.
    
    Pre-signed URLs allow clients to form a URL for an SCS resource, and then sign it with the current AWS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's AWS security credentials.
    
    Pre-signed URLs are useful in many situations where AWS security credentials aren't available from the client that needs to make the actual request to SCS.
    
    For example, an application may need remote users to upload files to the application owner's SCS bucket, but doesn't need to ship the AWS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's AWS security credentials, then the pre-signed URL can be passed to the end user's application to use.
    
    指定者:
    
    generatePresignedUrl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the desired object.
    key - The key in the specified bucket under which the desired object is stored.
    expiration - The time at which the returned pre-signed URL will expire.
    
    返回:
    A pre-signed URL which expires at the specified time, and can be used to allow anyone to download the specified object from S3, without exposing the owner's AWS secret access key.
    
    抛出:
    
    SCSClientException - If there were any problems pre-signing the request for the specified S3 object.
    另请参阅:
    SCS#generatePresignedUrl(String, String, Date, HttpMethod), SCS.generatePresignedUrl(GeneratePresignedUrlRequest)
  - generatePresignedUrl
```
public URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration,
                       HttpMethod method,
                       boolean bucketNameAsDomain)
                         throws SCSClientException
```
    从接口复制的说明: SCS
    
    Returns a pre-signed URL for accessing an SCS resource.
    
    Pre-signed URLs allow clients to form a URL for an SCS resource, and then sign it with the current AWS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's AWS security credentials.
    
    Pre-signed URLs are useful in many situations where AWS security credentials aren't available from the client that needs to make the actual request to SCS.
    
    For example, an application may need remote users to upload files to the application owner's SCS bucket, but doesn't need to ship the AWS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's AWS security credentials, then the pre-signed URL can be passed to the end user's application to use.
    
    指定者:
    
    generatePresignedUrl 在接口中 SCS
    
    参数:
    bucketName - The name of the bucket containing the desired object.
    key - The key in the specified bucket under which the desired object is stored.
    expiration - The time at which the returned pre-signed URL will expire.
    method - The HTTP method verb to use for this URL
    
    返回:
    A pre-signed URL which expires at the specified time, and can be used to allow anyone to download the specified object from S3, without exposing the owner's AWS secret access key.
    
    抛出:
    
    SCSClientException - If there were any problems pre-signing the request for the specified S3 object.
    另请参阅:
    SCS#generatePresignedUrl(String, String, Date), SCS.generatePresignedUrl(GeneratePresignedUrlRequest)
  - generatePresignedUrl
```
public URL generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)
                         throws SCSClientException
```
    从接口复制的说明: SCS
    
    Returns a pre-signed URL for accessing an SCS resource.
    
    Pre-signed URLs allow clients to form a URL for an SCS resource, and then sign it with the current AWS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's AWS security credentials.
    
    Pre-signed URLs are useful in many situations where AWS security credentials aren't available from the client that needs to make the actual request to SCS.
    
    For example, an application may need remote users to upload files to the application owner's SCS bucket, but doesn't need to ship the AWS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's AWS security credentials, then the pre-signed URL can be passed to the end user's application to use.
    
    Note that presigned URLs cannot be used to upload an object with an attached policy, as described in this blog post. That method is only suitable for POSTs from HTML forms by browsers.
    
    指定者:
    
    generatePresignedUrl 在接口中 SCS
    
    参数:
    generatePresignedUrlRequest - The request object containing all the options for generating a pre-signed URL (bucket name, key, expiration date, etc).
    
    返回:
    A pre-signed URL that can be used to access an SCS resource without requiring the user of the URL to know the account's AWS security credentials.
    
    抛出:
    
    SCSClientException - If there were any problems pre-signing the request for the SCS resource.
    另请参阅:
    SCS#generatePresignedUrl(String, String, Date), SCS#generatePresignedUrl(String, String, Date, HttpMethod)
  - completeMultipartUpload
```
public ObjectMetadata completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
                                       throws SCSClientException,
                                              SCSServiceException
```
    从接口复制的说明: SCS
    
    Completes a multipart upload by assembling previously uploaded parts.
    You first upload all parts using the SCS.uploadPart(UploadPartRequest) method. After successfully uploading all individual parts of an upload, you call this operation to complete the upload. Upon receiving this request, SCS concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list. For each part in the list, you provide the part number and the ETag header value, returned after that part was uploaded.
    Processing of a CompleteMultipartUpload request may take several minutes to complete.
    
    指定者:
    
    completeMultipartUpload 在接口中 SCS
    
    参数:
    completeMultipartUploadRequest - The CompleteMultipartUploadRequest object that specifies all the parameters of this operation.
    
    返回:
    A CompleteMultipartUploadResult from S3 containing the ETag for the new object composed of the individual parts.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - initiateMultipartUpload
```
public InitiateMultipartUploadResult initiateMultipartUpload(String bucketName,
                                                    String key)
                                                      throws SCSClientException,
                                                             SCSServiceException
```
    从接口复制的说明: SCS
    
    Initiates a multipart upload and returns an InitiateMultipartUploadResult
    
    指定者:
    
    initiateMultipartUpload 在接口中 SCS
    
    返回:
    
    抛出:
    
    SCSClientException
    
    SCSServiceException
    另请参阅:
    SCS.initiateMultipartUpload(InitiateMultipartUploadRequest)
  - initiateMultipartUpload
```
public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest)
                                                      throws SCSClientException,
                                                             SCSServiceException
```
    从接口复制的说明: SCS
    
    Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID. This upload ID associates all the parts in the specific upload and is used in each of your subsequent SCS.uploadPart(UploadPartRequest) requests. You also include this upload ID in the final request to either complete, or abort the multipart upload request.
    
    指定者:
    
    initiateMultipartUpload 在接口中 SCS
    
    参数:
    initiateMultipartUploadRequest - The InitiateMultipartUploadRequest object that specifies all the parameters of this operation.
    
    返回:
    An InitiateMultipartUploadResult from SCS.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - listParts
```
public PartListing listParts(ListPartsRequest listPartsRequest)
                      throws SCSClientException,
                             SCSServiceException
```
    从接口复制的说明: SCS
    
    Lists the parts that have been uploaded for a specific multipart upload.
    This method must include the upload ID, returned by the SCS.initiateMultipartUpload(InitiateMultipartUploadRequest) operation. This request returns a maximum of 1000 uploaded parts by default. You can restrict the number of parts returned by specifying the MaxParts property on the ListPartsRequest. If your multipart upload consists of more parts than allowed in the ListParts response, the response returns a IsTruncated field with value true, and a NextPartNumberMarker property. In subsequent ListParts request you can include the PartNumberMarker property and set its value to the NextPartNumberMarker property value from the previous response.
    
    指定者:
    
    listParts 在接口中 SCS
    
    参数:
    listPartsRequest - The ListPartsRequest object that specifies all the parameters of this operation.
    
    返回:
    Returns a PartListing from SCS.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - uploadPart
```
public UploadPartResult uploadPart(UploadPartRequest uploadPartRequest)
                            throws SCSClientException,
                                   SCSServiceException
```
    从接口复制的说明: SCS
    
    Uploads a part in a multipart upload. You must initiate a multipart upload before you can upload any part.
    Your UploadPart request must include an upload ID and a part number. The upload ID is the ID returned by SCS in response to your Initiate Multipart Upload request. Part number can be any number between 1 and 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being uploaded. If you upload a new part using the same part number that was specified in uploading a previous part, the previously uploaded part is overwritten.
    To ensure data is not corrupted traversing the network, specify the Content-MD5 header in the Upload Part request. SCS checks the part data against the provided MD5 value. If they do not match, SCS returns an error.
    When you upload a part, the returned UploadPartResult contains an ETag property. You should record this ETag property value and the part number. After uploading all parts, you must send a CompleteMultipartUpload request. At that time SCS constructs a complete object by concatenating all the parts you uploaded, in ascending order based on the part numbers. The CompleteMultipartUpload request requires you to send all the part numbers and the corresponding ETag values.
    
    指定者:
    
    uploadPart 在接口中 SCS
    
    参数:
    uploadPartRequest - The UploadPartRequest object that specifies all the parameters of this operation.
    
    返回:
    An UploadPartResult from SCS containing the part number and ETag of the new part.
    
    抛出:
    
    SCSClientException - If any errors are encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in SCS while processing the request.
  - createSigner
```
protected Signer createSigner(Request<?> request,
                  String bucketName,
                  String key)
```
  - presignRequest
```
protected <T> void presignRequest(Request<T> request,
                      HttpMethod methodName,
                      String bucketName,
                      String key,
                      Date expiration,
                      String subResource)
```
    Pre-signs the specified request, using a signature query-string parameter.
    
    参数:
    request - The request to sign.
    methodName - The HTTP method (GET, PUT, DELETE, HEAD) for the specified request.
    bucketName - The name of the bucket involved in the request. If the request is not an operation on a bucket this parameter should be null.
    key - The object key involved in the request. If the request is not an operation on an object, this parameter should be null.
    expiration - The time at which the signed request is no longer valid, and will stop working.
    subResource - The optional sub-resource being requested as part of the request (e.g. "location", "acl", "logging", or "torrent").
  - populateRequestMetadata
```
protected static void populateRequestMetadata(Request<?> request,
                           ObjectMetadata metadata)
```
    Populates the specified request object with the appropriate headers from the ObjectMetadata object.
    
    参数:
    request - The request to populate with headers.
    metadata - The metadata containing the header information to include in the request.
  - getResourceUrl
```
public String getResourceUrl(String bucketName,
                    String key)
```
    Returns the URL to the key in the bucket given, using the client's scheme and endpoint. Returns null if the given bucket and key cannot be converted to a URL.
  - getUrl
```
public URL getUrl(String bucketName,
         String key)
```
    Returns an URL for the object stored in the specified bucket and key.
    If the object identified by the given bucket and key has public read permissions (ex: CannedAccessControlList.PublicRead), then this URL can be directly accessed to retrieve the object's data.
    
    参数:
    bucketName - The name of the bucket containing the object whose URL is being requested.
    key - The key under which the object whose URL is being requested is stored.
    
    返回:
    A unique URL for the object stored in the specified bucket and key.
  - createRequest
```
protected <X extends SCSWebServiceRequest> Request<X> createRequest(String bucketName,
                                                        String key,
                                                        X originalRequest,
                                                        HttpMethodName httpMethod)
```
    Creates and initializes a new request object for the specified S3 resource. This method is responsible for determining the right way to address resources. For example, bucket names that are not DNS addressable cannot be addressed in V2, virtual host, style, and instead must use V1, path style. The returned request object has the service name, endpoint and resource path correctly populated. Callers can take the request, add any additional headers or parameters, then sign and execute the request.
    
    参数:
    bucketName - An optional parameter indicating the name of the bucket containing the resource involved in the request.
    key - An optional parameter indicating the key under which the desired resource is stored in the specified bucket.
    originalRequest - The original request, as created by the user.
    httpMethod - The HTTP method to use when sending the request.
    
    返回:
    A new request object, populated with endpoint, resource path, and service name, ready for callers to populate any additional headers or parameters, and execute.

类 SCSClient

字段概要

从类继承的字段 com.sinacloud.scs.SCSWebServiceClient

构造器概要

方法概要

从类继承的方法 com.sinacloud.scs.SCSWebServiceClient

从类继承的方法 java.lang.Object

构造器详细资料

SCSClient

SCSClient

SCSClient

SCSClient

SCSClient

SCSClient

方法详细资料

createExecutionContext

setS3ClientOptions

listObjects

listObjects

listObjects

listNextBatchOfObjects

listBuckets

listBuckets

createBucket

createBucket

getObjectAcl

setObjectAcl

getBucketInfo

getObjectInfo

getBucketAcl

getBucketAcl

setBucketAcl

setBucketAcl

getObjectMetadata

setObjectMetadata

getObjectMetadata

getObject

doesBucketExist

getObject

getObject

deleteBucket

deleteBucket

putObject

putObject

putObjectRelax

putObject

putObject

copyObject

copyObject

deleteObject

deleteObject

generatePresignedUrl

generatePresignedUrl

generatePresignedUrl

completeMultipartUpload

initiateMultipartUpload

initiateMultipartUpload

listParts

uploadPart

createSigner

presignRequest

populateRequestMetadata

getResourceUrl

getUrl

createRequest