AbstractBceClient (baiducloud-java-sdk-core 0.0.2 API)

java.lang.Object
- com.baidubce.AbstractBceClient

```
@ThreadSafe
public abstract class AbstractBceClient
extends Object
```
Abstract base class for BCE service clients.
Responsible for basic client capabilities that are the same across all BCE SDK Java clients (ex: setting the client endpoint).
Subclass names should be in the form of "com.baidubce.services.xxx.XxxClient", while "xxx" is the service ID and "Xxx" is the capitalized service ID.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BceClientConfiguration`	`config` The client configuration for this client.
`static String`	`DEFAULT_CONTENT_TYPE` The default http request content type for all BCE service APIs.
`static String`	`DEFAULT_ENCODING` The default string encoding for all BCE service APIs.
`static String`	`DEFAULT_SERVICE_DOMAIN` The default service domain for BCE.
`static String`	`URL_PREFIX` The common URL prefix for all BCE service APIs.

Constructor Summary

Constructors
Constructor and Description
`AbstractBceClient(BceClientConfiguration config, HttpResponseHandler[] responseHandlers)` Equivalent to AbstractBceClient(config, responseHandlers, false)
`AbstractBceClient(BceClientConfiguration config, HttpResponseHandler[] responseHandlers, boolean isHttpAsyncPutEnabled)` Constructs a new AbstractBceClient with the specified client configuration and handlers.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected URI`	`buildHostEndpoint(URI originalEndpoint, String hostPrefix)` 根据 hostPrefix 构建新的 endpoint
`void`	`computeBktVirEndpoint(String bucketName)` BOS
`String`	`computeServiceId()` Returns the service ID based on the actual class name.
`protected InternalRequest`	`createRequest(AbstractBceRequest bceRequest, HttpMethodName httpMethod, SignOptions signOptions, String... pathVariables)` 创建内部请求对象，自动处理 @Host 注解，并支持自定义签名选项
`protected InternalRequest`	`createRequest(AbstractBceRequest bceRequest, HttpMethodName httpMethod, String... pathVariables)` 创建内部请求对象，自动处理 @Host 注解
`protected String`	`extractHostAnnotationValue(AbstractBceRequest bceRequest)` 从请求对象中提取 @Host 注解字段的值
`URI`	`getBktVirEndpoint(String bucketName)` Returns the service endpoint(bucket virtual hosting) to which this client will send requests.
`BceHttpClient`	`getClient()`
`URI`	`getEndpoint()` Returns the service endpoint to which this client will send requests.
`String`	`getServiceId()` Returns the target service ID.
`protected <T extends AbstractBceResponse> T`	`invokeHttpClient(InternalRequest request, Class<T> responseClass)` Subclasses should invoke this method for sending request to the target service.
`protected <T extends AbstractBceResponse> T`	`invokeHttpClient(InternalRequest request, Class<T> responseClass, HttpResponseHandler[] customHandlers)` Subclasses should invoke this method for sending request to the target service with custom handlers.
`boolean`	`isRegionSupported()` Returns true if the target service supports regions.
`void`	`setClient(BceHttpClient client)`
`void`	`shutdown()` Shuts down the client and releases all underlying resources.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SERVICE_DOMAIN
```
public static final String DEFAULT_SERVICE_DOMAIN
```
    The default service domain for BCE.
    
    See Also:
    
    Constant Field Values
  - URL_PREFIX
```
public static final String URL_PREFIX
```
    The common URL prefix for all BCE service APIs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    The default string encoding for all BCE service APIs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONTENT_TYPE
```
public static final String DEFAULT_CONTENT_TYPE
```
    The default http request content type for all BCE service APIs.
    
    See Also:
    
    Constant Field Values
  - config
```
protected BceClientConfiguration config
```
    The client configuration for this client.
- Constructor Detail
  - AbstractBceClient
```
public AbstractBceClient(BceClientConfiguration config,
                         HttpResponseHandler[] responseHandlers,
                         boolean isHttpAsyncPutEnabled)
```
    Constructs a new AbstractBceClient with the specified client configuration and handlers.
    The constructor will extract serviceId from the class name automatically. And if there is no endpoint specified in the client configuration, the constructor will create a default one.
    
    Parameters:
    
    config - the client configuration. The constructor makes a copy of this parameter so that it is safe to change the configuration after then.
    
    responseHandlers - a list of handlers for processing HTTP responses from services. See BceHttpClient.execute(InternalRequest, Class, HttpResponseHandler[])
    
    isHttpAsyncPutEnabled - whether or not PUT method use Async manner.
    
    Throws:
    
    IllegalStateException - if the class name does not follow the naming convention for BCE clients.
    
    IllegalArgumentException - if the endpoint specified in the client configuration is not a valid URI.
  - AbstractBceClient
```
public AbstractBceClient(BceClientConfiguration config,
                         HttpResponseHandler[] responseHandlers)
```
    Equivalent to AbstractBceClient(config, responseHandlers, false)
    
    Parameters:
    
    config - the client configuration. The constructor makes a copy of this parameter so that it is safe to change the configuration after then.
    
    responseHandlers - a list of handlers for processing HTTP responses from services. See BceHttpClient.execute(InternalRequest, Class, HttpResponseHandler[])
    
    Throws:
    
    IllegalStateException - if the class name does not follow the naming convention for BCE clients.
    
    IllegalArgumentException - if the endpoint specified in the client configuration is not a valid URI.
- Method Detail
  - isRegionSupported
```
public boolean isRegionSupported()
```
    Returns true if the target service supports regions.
    The result will impact the construction of default service endpoint.
    
    Returns:
    
    true if the target service supports regions.
  - getEndpoint
```
public URI getEndpoint()
```
    Returns the service endpoint to which this client will send requests.
    
    Returns:
    
    the service endpoint to which this client will send requests.
  - getServiceId
```
public String getServiceId()
```
    Returns the target service ID.
    
    Returns:
    
    the target service ID.
  - getClient
```
public BceHttpClient getClient()
```
  - setClient
```
public void setClient(BceHttpClient client)
```
  - shutdown
```
public void shutdown()
```
    Shuts down the client and releases all underlying resources.
    Invoking this method is NOT a must. Once it is called, no subsequent requests should be made.
  - invokeHttpClient
```
protected <T extends AbstractBceResponse> T invokeHttpClient(InternalRequest request,
                                                             Class<T> responseClass)
```
    Subclasses should invoke this method for sending request to the target service.
    This method will add "Content-Type" and "Date" to headers with default values if not present.
    
    Type Parameters:
    
    T - the type of response
    
    Parameters:
    
    request - the request to build up the HTTP request.
    
    responseClass - the response class.
    
    Returns:
    
    the final response object.
  - invokeHttpClient
```
protected <T extends AbstractBceResponse> T invokeHttpClient(InternalRequest request,
                                                             Class<T> responseClass,
                                                             HttpResponseHandler[] customHandlers)
```
    Subclasses should invoke this method for sending request to the target service with custom handlers.
    This method will add "Content-Type" and "Date" to headers with default values if not present.
    
    Type Parameters:
    
    T - the type of response
    
    Parameters:
    
    request - the request to build up the HTTP request.
    
    responseClass - the response class.
    
    customHandlers - custom response handlers to use instead of the default ones.
    
    Returns:
    
    the final response object.
  - computeServiceId
```
public String computeServiceId()
```
    Returns the service ID based on the actual class name.
    The class name should be in the form of "com.baidubce.services.xxx.XxxClient", while "xxx" is the service ID and "Xxx" is the capitalized service ID.
    
    Returns:
    
    the computed service ID.
    
    Throws:
    
    IllegalStateException - if the class name does not follow the naming convention for BCE clients.
  - getBktVirEndpoint
```
public URI getBktVirEndpoint(String bucketName)
```
    Returns the service endpoint(bucket virtual hosting) to which this client will send requests.
    
    Returns:
    
    the service endpoint(bucket virtual hosting) to which this client will send requests.
  - computeBktVirEndpoint
```
public void computeBktVirEndpoint(String bucketName)
```
    BOS
    Returns the bucket virtual hosting service endpoint.
    The endpoint will be in the form of "http(s)://[.].bcebos.com".
    
    Throws:
    
    IllegalArgumentException - if the endpoint specified in the client configuration is not a valid URI.
  - extractHostAnnotationValue
```
protected String extractHostAnnotationValue(AbstractBceRequest bceRequest)
```
    从请求对象中提取 @Host 注解字段的值
    此方法通过反射扫描请求对象的所有字段，查找标记了 Host 注解的字段，并返回该字段的值。该值将被用作主机名前缀拼接到 endpoint 中。
    使用场景：
    - BOS：bucket name 作为子域名
    - VPC：bucket name 作为子域名
    Parameters:
    
    bceRequest - 原始请求对象
    
    Returns:
    
    @Host 注解字段的值，如果不存在则返回 null
  - buildHostEndpoint
```
protected URI buildHostEndpoint(URI originalEndpoint,
                                String hostPrefix)
```
    根据 hostPrefix 构建新的 endpoint
    将 hostPrefix 作为子域名拼接到原始 endpoint 的主机名前面。
    示例：
    - 原始 endpoint: http://bj.bcebos.com
    - hostPrefix: mybucket
    - 结果: http://mybucket.bj.bcebos.com
    Parameters:
    
    originalEndpoint - 原始 endpoint
    
    hostPrefix - 主机名前缀
    
    Returns:
    
    修改后的 endpoint，如果构建失败则返回原始 endpoint
  - createRequest
```
protected InternalRequest createRequest(AbstractBceRequest bceRequest,
                                        HttpMethodName httpMethod,
                                        String... pathVariables)
```
    创建内部请求对象，自动处理 @Host 注解
    此方法是子类创建请求的统一入口，提供以下功能：
    - 自动提取 @Host 注解字段并修改 endpoint
    - 构建完整的 URI（包含路径变量）
    - 设置凭证信息
    使用示例：
```
 // 在子类 Client 中
 InternalRequest internalRequest = this.createRequest(
     request, 
     HttpMethodName.PUT,
     request.getObjectName()
 );
 
```
    Parameters:
    
    bceRequest - 原始 BCE 请求对象
    
    httpMethod - HTTP 方法
    
    pathVariables - 路径变量
    
    Returns:
    
    处理后的内部请求对象
  - createRequest
```
protected InternalRequest createRequest(AbstractBceRequest bceRequest,
                                        HttpMethodName httpMethod,
                                        SignOptions signOptions,
                                        String... pathVariables)
```
    创建内部请求对象，自动处理 @Host 注解，并支持自定义签名选项
    此方法是 createRequest(com.baidubce.model.AbstractBceRequest, com.baidubce.http.HttpMethodName, String...) 的重载版本，支持传入自定义的签名选项。
    
    Parameters:
    
    bceRequest - 原始 BCE 请求对象
    
    httpMethod - HTTP 方法
    
    signOptions - 签名选项（可选，为 null 则不设置）
    
    pathVariables - 路径变量
    
    Returns:
    
    处理后的内部请求对象

Class AbstractBceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SERVICE_DOMAIN

URL_PREFIX

DEFAULT_ENCODING

DEFAULT_CONTENT_TYPE

config

Constructor Detail

AbstractBceClient

AbstractBceClient

Method Detail

isRegionSupported

getEndpoint

getServiceId

getClient

setClient

shutdown

invokeHttpClient

invokeHttpClient

computeServiceId

getBktVirEndpoint

computeBktVirEndpoint

extractHostAnnotationValue

使用场景：

buildHostEndpoint

示例：

createRequest

使用示例：

createRequest