AbstractBceClient (bce-sdk-java 0.10.272 API)

java.lang.Object
- com.baidubce.AbstractBceClient

Direct Known Subclasses:

AbstractIotHiskBceClient, AbstractRuleEngineBceClient, AbstractTableStorageBceClient, AbstractTsdbBceClient, AclClient, AdaptorClient, AppBlbClient, AsGroupClient, BacnetClient, BaseBceClient, BaseDuMapClient, BaseLpsClient, BaseRosClient, BatchClient, BbcClient, BccClient, BcdClient, BciClient, BcmClient, BecClient, BesClient, BillingClient, BinaryParserClient, BlbClient, BmrClient, BosClient, BvwClient, CdnClient, CertClient, CfcClient, CnapClient, CvcaClient, DccClient, DocClient, DuGoClient, EipBpClient, EipClient, EipGroupClient, EipTpClient, EndpointClient, EniClient, EsgClient, EvsClient, IotAlarmClient, IoTCoreClient, IotDmClient, IotDmV2Client, IotDmV3Client, IotHubClient, IotShcClient, IotSmsReceiverClient, IotTimerClient, IotVizClient, Ipv6GatewayClient, KmsClient, LssClient, MediaClient, MmsClient, ModbusClient, MolaDbClient, MvsClient, NatClient, OcrClient, PeerConnClient, PlatformClient, RdsClient, RouteClient, RuleDictClient, RuleEngineClient, ScsClient, SesClientSupport, SmsClientSupport, StsClient, SubnetClient, TagClient, VcaClient, VcrClient, VmsClient, VodClient, VodproClient, VpcClient, VpnClient
```
@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
`void`	`computeBktVirEndpoint(String bucketName)` BOS Returns the bucket virtual hosting service endpoint.
`String`	`computeServiceId()` Returns the service ID based on the actual class name.
`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.
`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.
  - 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.

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

computeServiceId

getBktVirEndpoint

computeBktVirEndpoint