SCSWebServiceClient (java-sdk 1.2.2-SNAPSHOT API)

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

直接已知子类:

SCSClient
```
public abstract class SCSWebServiceClient
extends Object
```
Abstract base class for Amazon Web Service Java clients.
Responsible for basic client capabilities that are the same across all AWS SDK Java clients (ex: setting the client endpoint).

字段概要

字段
限定符和类型	字段和说明
`protected HttpConnect`	`client` Low level client for sending requests to AWS services.
`protected ClientConfiguration`	`clientConfiguration` The client configuration
`protected URI`	`endpoint` The service endpoint to which this client will send requests.
`protected URI`	`endpoint4Upload` CDN上传加速域名
`protected int`	`timeOffset` Optional offset (in seconds) to use when signing requests

构造器概要

构造器
构造器和说明
`SCSWebServiceClient(ClientConfiguration clientConfiguration)` Constructs a new SCSWebServiceClient object using the specified configuration and request metric collector.

方法概要

方法
限定符和类型	方法和说明
`protected <T> HttpRequest`	`convertToHttpRequest(Request<T> request, HttpMethodName methodName)` 已过时。
`protected ExecutionContext`	`createExecutionContext()` This method exists only for backward compatiblity reason, so that clients compiled against the older version of this class won't get `NoSuchMethodError` at runtime.
`protected ExecutionContext`	`createExecutionContext(Request<?> req)`
`int`	`getTimeOffset()` Returns the optional value for time offset for this client.
`void`	`setConfiguration(ClientConfiguration clientConfiguration)`
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client.
`void`	`setEndpoint4Upload(String endpoint)`
`void`	`setTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SCSWebServiceClient`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.

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

- 字段详细资料
  - endpoint
```
protected URI endpoint
```
    The service endpoint to which this client will send requests.
  - endpoint4Upload
```
protected URI endpoint4Upload
```
    CDN上传加速域名
  - clientConfiguration
```
protected ClientConfiguration clientConfiguration
```
    The client configuration
  - client
```
protected HttpConnect client
```
    Low level client for sending requests to AWS services.
  - timeOffset
```
protected int timeOffset
```
    Optional offset (in seconds) to use when signing requests
- 构造器详细资料
  - SCSWebServiceClient
```
public SCSWebServiceClient(ClientConfiguration clientConfiguration)
```
    Constructs a new SCSWebServiceClient object using the specified configuration and request metric collector.
    
    参数:
    clientConfiguration - The client configuration for this client.
    requestMetricCollector - optional request metric collector to be used at the http client level; can be null.
- 方法详细资料
  - setEndpoint
```
public void setEndpoint(String endpoint)
                 throws IllegalArgumentException
```
    Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.
    This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
    Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    
    参数:
    endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
    
    抛出:
    
    IllegalArgumentException - If any problems are detected with the specified endpoint.
  - setEndpoint4Upload
```
public void setEndpoint4Upload(String endpoint)
                        throws IllegalArgumentException
```
    抛出:
    
    IllegalArgumentException
  - setConfiguration
```
public void setConfiguration(ClientConfiguration clientConfiguration)
```
  - shutdown
```
public void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - convertToHttpRequest
```
@Deprecated
protected <T> HttpRequest convertToHttpRequest(Request<T> request,
                                              HttpMethodName methodName)
```
    已过时。
    
    Converts a Request object into an HttpRequest object. Copies all the headers, parameters, etc. from the Request into the new HttpRequest.
    
    参数:
    request - The request to convert.
    methodName - The HTTP method (GET, PUT, DELETE, HEAD) to use in the converted HttpRequest object.
    
    返回:
    A new HttpRequest object created from the details of the specified Request object.
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext(Request<?> req)
```
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext()
```
    This method exists only for backward compatiblity reason, so that clients compiled against the older version of this class won't get NoSuchMethodError at runtime. However, calling this methods would effectively ignore and disable the request metric collector, if any, specified at the request level. Request metric collector specified at the service client or AWS SDK level will still be honored.
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    参数:
    timeOffset - The optional value for time offset (in seconds) for this client.
  - withTimeOffset
```
public SCSWebServiceClient withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    参数:
    timeOffset - The optional value for time offset (in seconds) for this client.
    
    返回:
    the updated web service client
  - getTimeOffset
```
public int getTimeOffset()
```
    Returns the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    返回:
    The optional value for time offset (in seconds) for this client.

类 SCSWebServiceClient

字段概要

构造器概要

方法概要

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

字段详细资料

endpoint

endpoint4Upload

clientConfiguration

client

timeOffset

构造器详细资料

SCSWebServiceClient

方法详细资料

setEndpoint

setEndpoint4Upload

setConfiguration

shutdown

convertToHttpRequest

createExecutionContext

createExecutionContext

setTimeOffset

withTimeOffset

getTimeOffset