com.aliyun.oss.common.comm

Class ServiceClient

java.lang.Object

com.aliyun.oss.common.comm.ServiceClient

Direct Known Subclasses:

DefaultServiceClient

public abstract class ServiceClient
extends Object

Abstract service client that provides interfaces to access OSS services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceClient.Request Wrapper class based on HttpMessage that represents HTTP request message to OSS.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientConfiguration	config

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceClient(ClientConfiguration config)

Method Summary

Modifier and Type	Method and Description
ClientConfiguration	getClientConfiguration()
String	getConnectionPoolStats()
protected abstract RetryStrategy	getDefaultRetryStrategy()
ResponseMessage	sendRequest(RequestMessage request, ExecutionContext context) Send HTTP request with specified context to OSS and wait for HTTP response.
protected abstract ResponseMessage	sendRequestCore(ServiceClient.Request request, ExecutionContext context) Implements the core logic to send requests to Aliyun OSS services.
abstract void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

config

protected ClientConfiguration config

Constructor Detail

ServiceClient

protected ServiceClient(ClientConfiguration config)

Method Detail

getClientConfiguration

public ClientConfiguration getClientConfiguration()

sendRequest

public ResponseMessage sendRequest(RequestMessage request,
                                   ExecutionContext context)
                            throws ServiceException,
                                   ClientException

Send HTTP request with specified context to OSS and wait for HTTP response.

Parameters:

request - a request message.

context - http request context.

Returns:

A ResponseMessage instance.

Throws:

ClientException - If any errors are encountered in the client while making the request or handling the response.

ServiceException - The base exception class to represent any expected or unexpected OSS server side errors.

sendRequestCore

protected abstract ResponseMessage sendRequestCore(ServiceClient.Request request,
                                                   ExecutionContext context)
                                            throws IOException

Implements the core logic to send requests to Aliyun OSS services.

Parameters:

request - a request message.

context - http request context.

Returns:

A ResponseMessage instance.

Throws:

IOException - An IO errors are encountered in the client while making the request or handling the response.

getDefaultRetryStrategy

protected abstract RetryStrategy getDefaultRetryStrategy()

shutdown

public abstract void shutdown()

getConnectionPoolStats

public String getConnectionPoolStats()