ClientConfiguration (Aliyun OSS SDK for Java 2.8.1 API)

java.lang.Object
- com.aliyun.oss.ClientConfiguration

```
public class ClientConfiguration
extends Object
```
Client configurations for accessing to OSS services.

字段概要

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_CNAME_EXCLUDE_LIST`
`static int`	`DEFAULT_CONNECTION_REQUEST_TIMEOUT`
`static int`	`DEFAULT_CONNECTION_TIMEOUT`
`static long`	`DEFAULT_CONNECTION_TTL`
`static long`	`DEFAULT_IDLE_CONNECTION_TIME`
`static int`	`DEFAULT_MAX_CONNECTIONS`
`static int`	`DEFAULT_REQUEST_TIMEOUT`
`static long`	`DEFAULT_SLOW_REQUESTS_THRESHOLD`
`static int`	`DEFAULT_SOCKET_TIMEOUT`
`static int`	`DEFAULT_THREAD_POOL_WAIT_TIME`
`static boolean`	`DEFAULT_USE_REAPER`
`static int`	`DEFAULT_VALIDATE_AFTER_INACTIVITY`

构造器概要

构造器
构造器和说明

ClientConfiguration()

构造器
构造器和说明
`ClientConfiguration()`

方法概要

方法
限定符和类型	方法和说明
`void`	`addDefaultHeader(String key, String value)` 添加默认请求头，每个请求发送到时会添加默认请求头。
`List<String>`	`getCnameExcludeList()` 获取CNAME排除列表（不可修改），以列表元素作为后缀的域名将不进行CNAME解析。
`int`	`getConnectionRequestTimeout()` 返回从连接池中获取连接的超时时间（单位：毫秒）。
`int`	`getConnectionTimeout()` 返回建立连接的超时时间（单位：毫秒）。
`long`	`getConnectionTTL()` 获取连接池中连接过期时间。
`Map<String,String>`	`getDefaultHeaders()` 获取默认请求头，每个请求发送到时会添加默认请求头。
`long`	`getIdleConnectionTime()` 获取关闭空闲连接的时长。
`int`	`getMaxConnections()` 返回允许打开的最大HTTP连接数。
`int`	`getMaxErrorRetry()` 返回一个值表示当可重试的请求失败后最大的重试次数。
`Protocol`	`getProtocol()` 获取连接OSS所采用的协议（HTTP/HTTPS）。
`String`	`getProxyDomain()` 返回访问NTLM验证的代理服务器的Windows域名（可选）。
`String`	`getProxyHost()` 返回代理服务器主机地址。
`String`	`getProxyPassword()` 返回代理服务器验证的密码。
`int`	`getProxyPort()` 返回代理服务器端口。
`String`	`getProxyUsername()` 返回代理服务器验证的用户名。
`String`	`getProxyWorkstation()` 返回NTLM代理服务器的Windows工作站名称。
`int`	`getRequestTimeout()` 获取请求超时时间，单位毫秒。
`long`	`getSlowRequestsThreshold()` 设置慢请求阈值，用时超过该阈值的请求将打印到日志中，单位毫秒，默认5分钟。
`int`	`getSocketTimeout()` 返回通过打开的连接传输数据的超时时间（单位：毫秒）。
`String`	`getUserAgent()` 构造用户代理。
`int`	`getValidateAfterInactivity()` 连接空闲该时间后，重用前检查该连接的有效性，默认2秒，单位毫秒。
`boolean`	`isCrcCheckEnabled()` 获取是否启动CRC校验，启动后上传下载请求数据会启动CRC校验。
`boolean`	`isRequestTimeoutEnabled()` 获取是否开启了请求超时，默认关闭。
`boolean`	`isSLDEnabled()` 获取是否开启二级域名（Second Level Domain）的访问方式，默认不开启。
`boolean`	`isSupportCname()` 获取是否支持Cname作为Endpoint，默认支持该方式。
`boolean`	`isUseReaper()` 查看是否使用`IdleConnectionReaper`管理过期连接。
`void`	`setCnameExcludeList(List<String> cnameExcludeList)` 设置CNAME排除列表。
`void`	`setConnectionRequestTimeout(int connectionRequestTimeout)` 设置从连接池中获取连接的超时时间（单位：毫秒）。
`void`	`setConnectionTimeout(int connectionTimeout)` 设置建立连接的超时时间（单位：毫秒）。
`void`	`setConnectionTTL(long connectionTTL)` 设置连接池中连接过期时间。
`void`	`setCrcCheckEnabled(boolean crcCheckEnabled)` 设置是否启动CRC校验，启动后上传下载请求数据会启动CRC校验。
`void`	`setDefaultHeaders(Map<String,String> defaultHeaders)` 设置默认请求头，每个请求发送到时会添加默认请求头。
`void`	`setIdleConnectionTime(long idleConnectionTime)` 设置空闲连接的时长，连接空闲该时间后关闭，单位毫秒，默认60秒。
`void`	`setMaxConnections(int maxConnections)` 设置允许打开的最大HTTP连接数。
`void`	`setMaxErrorRetry(int maxErrorRetry)` 设置一个值表示当可重试的请求失败后最大的重试次数。
`void`	`setProtocol(Protocol protocol)` 设置连接OSS所采用的协议（HTTP/HTTPS）。
`void`	`setProxyDomain(String proxyDomain)` 设置访问NTLM验证的代理服务器的Windows域名（可选）。
`void`	`setProxyHost(String proxyHost)` 设置代理服务器主机地址。
`void`	`setProxyPassword(String proxyPassword)` 设置代理服务器验证的密码。
`void`	`setProxyPort(int proxyPort)` 设置代理服务器端口。
`void`	`setProxyUsername(String proxyUsername)` 设置代理服务器验证的用户名。
`void`	`setProxyWorkstation(String proxyWorkstation)` 设置NTLM代理服务器的Windows工作站名称。
`void`	`setRequestTimeout(int requestTimeout)` 设置请求超时时间，单位毫秒，默认5分钟。
`void`	`setRequestTimeoutEnabled(boolean requestTimeoutEnabled)` 设置是否开启请求超时。
`ClientConfiguration`	`setSLDEnabled(boolean enabled)` 设置是否开启二级域名（Second Level Domain）的访问方式。
`void`	`setSlowRequestsThreshold(long slowRequestsThreshold)` 获取慢请求阈值，用时超过该阈值的请求将打印到日志中，单位毫秒。
`void`	`setSocketTimeout(int socketTimeout)` 设置通过打开的连接传输数据的超时时间（单位：毫秒）。
`ClientConfiguration`	`setSupportCname(boolean supportCname)` 设置是否支持Cname作为Endpoint。
`void`	`setUserAgent(String userAgent)` 设置用户代理。
`void`	`setUseReaper(boolean useReaper)` 设置是否使用`IdleConnectionReaper`管理过期连接。

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

- 字段详细资料
  - DEFAULT_CONNECTION_REQUEST_TIMEOUT
```
public static final int DEFAULT_CONNECTION_REQUEST_TIMEOUT
```
    另请参阅:
    常量字段值
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final int DEFAULT_CONNECTION_TIMEOUT
```
    另请参阅:
    常量字段值
  - DEFAULT_SOCKET_TIMEOUT
```
public static final int DEFAULT_SOCKET_TIMEOUT
```
    另请参阅:
    常量字段值
  - DEFAULT_MAX_CONNECTIONS
```
public static final int DEFAULT_MAX_CONNECTIONS
```
    另请参阅:
    常量字段值
  - DEFAULT_CONNECTION_TTL
```
public static final long DEFAULT_CONNECTION_TTL
```
    另请参阅:
    常量字段值
  - DEFAULT_IDLE_CONNECTION_TIME
```
public static final long DEFAULT_IDLE_CONNECTION_TIME
```
    另请参阅:
    常量字段值
  - DEFAULT_VALIDATE_AFTER_INACTIVITY
```
public static final int DEFAULT_VALIDATE_AFTER_INACTIVITY
```
    另请参阅:
    常量字段值
  - DEFAULT_THREAD_POOL_WAIT_TIME
```
public static final int DEFAULT_THREAD_POOL_WAIT_TIME
```
    另请参阅:
    常量字段值
  - DEFAULT_REQUEST_TIMEOUT
```
public static final int DEFAULT_REQUEST_TIMEOUT
```
    另请参阅:
    常量字段值
  - DEFAULT_SLOW_REQUESTS_THRESHOLD
```
public static final long DEFAULT_SLOW_REQUESTS_THRESHOLD
```
    另请参阅:
    常量字段值
  - DEFAULT_USE_REAPER
```
public static final boolean DEFAULT_USE_REAPER
```
    另请参阅:
    常量字段值
  - DEFAULT_CNAME_EXCLUDE_LIST
```
public static final String DEFAULT_CNAME_EXCLUDE_LIST
```
    另请参阅:
    常量字段值
- 构造器详细资料
  - ClientConfiguration
```
public ClientConfiguration()
```
- 方法详细资料
  - getUserAgent
```
public String getUserAgent()
```
    构造用户代理。
    
    返回:
    用户代理。
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    设置用户代理。
    
    参数:
    userAgent - 用户代理。
  - getProxyHost
```
public String getProxyHost()
```
    返回代理服务器主机地址。
    
    返回:
    代理服务器主机地址。
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    设置代理服务器主机地址。
    
    参数:
    proxyHost - 代理服务器主机地址。
  - getProxyPort
```
public int getProxyPort()
```
    返回代理服务器端口。
    
    返回:
    代理服务器端口。
  - setProxyPort
```
public void setProxyPort(int proxyPort)
                  throws ClientException
```
    设置代理服务器端口。
    
    参数:
    proxyPort - 代理服务器端口。
    
    抛出:
    
    ClientException
  - getProxyUsername
```
public String getProxyUsername()
```
    返回代理服务器验证的用户名。
    
    返回:
    用户名。
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    设置代理服务器验证的用户名。
    
    参数:
    proxyUsername - 用户名。
  - getProxyPassword
```
public String getProxyPassword()
```
    返回代理服务器验证的密码。
    
    返回:
    密码。
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    设置代理服务器验证的密码。
    
    参数:
    proxyPassword - 密码。
  - getProxyDomain
```
public String getProxyDomain()
```
    返回访问NTLM验证的代理服务器的Windows域名（可选）。
    
    返回:
    域名。
  - setProxyDomain
```
public void setProxyDomain(String proxyDomain)
```
    设置访问NTLM验证的代理服务器的Windows域名（可选）。
    
    参数:
    proxyDomain - 域名。
  - getProxyWorkstation
```
public String getProxyWorkstation()
```
    返回NTLM代理服务器的Windows工作站名称。
    
    返回:
    NTLM代理服务器的Windows工作站名称。
  - setProxyWorkstation
```
public void setProxyWorkstation(String proxyWorkstation)
```
    设置NTLM代理服务器的Windows工作站名称。（可选，如果代理服务器非NTLM，不需要设置该参数）。
    
    参数:
    proxyWorkstation - NTLM代理服务器的Windows工作站名称。
  - getMaxConnections
```
public int getMaxConnections()
```
    返回允许打开的最大HTTP连接数。
    
    返回:
    最大HTTP连接数。
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    设置允许打开的最大HTTP连接数。
    
    参数:
    maxConnections - 最大HTTP连接数。
  - getSocketTimeout
```
public int getSocketTimeout()
```
    返回通过打开的连接传输数据的超时时间（单位：毫秒）。 0表示无限等待（但不推荐使用）。
    
    返回:
    通过打开的连接传输数据的超时时间（单位：毫秒）。
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
```
    设置通过打开的连接传输数据的超时时间（单位：毫秒）。 0表示无限等待（但不推荐使用）。
    
    参数:
    socketTimeout - 通过打开的连接传输数据的超时时间（单位：毫秒）。
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    返回建立连接的超时时间（单位：毫秒）。
    
    返回:
    建立连接的超时时间（单位：毫秒）。
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    设置建立连接的超时时间（单位：毫秒）。
    
    参数:
    connectionTimeout - 建立连接的超时时间（单位：毫秒）。
  - getConnectionRequestTimeout
```
public int getConnectionRequestTimeout()
```
    返回从连接池中获取连接的超时时间（单位：毫秒）。 0表示无限等待。负值表示未定义，默认-1。
    
    返回:
    从连接池中获取连接的超时时间。
  - setConnectionRequestTimeout
```
public void setConnectionRequestTimeout(int connectionRequestTimeout)
```
    设置从连接池中获取连接的超时时间（单位：毫秒）。
    
    参数:
    connectionRequestTimeout - 设置从连接池中获取连接的超时时间。
  - getMaxErrorRetry
```
public int getMaxErrorRetry()
```
    返回一个值表示当可重试的请求失败后最大的重试次数。（默认值为3）
    
    返回:
    当可重试的请求失败后最大的重试次数。
  - setMaxErrorRetry
```
public void setMaxErrorRetry(int maxErrorRetry)
```
    设置一个值表示当可重试的请求失败后最大的重试次数。（默认值为3）
    
    参数:
    maxErrorRetry - 当可重试的请求失败后最大的重试次数。
  - getConnectionTTL
```
public long getConnectionTTL()
```
    获取连接池中连接过期时间。
    
    返回:
    连接过期时间。
  - setConnectionTTL
```
public void setConnectionTTL(long connectionTTL)
```
    设置连接池中连接过期时间。
    
    参数:
    connectionTTL - 连接过期时间（单位为毫秒）。
  - isUseReaper
```
public boolean isUseReaper()
```
    查看是否使用IdleConnectionReaper管理过期连接。
  - setUseReaper
```
public void setUseReaper(boolean useReaper)
```
    设置是否使用IdleConnectionReaper管理过期连接。
  - getIdleConnectionTime
```
public long getIdleConnectionTime()
```
    获取关闭空闲连接的时长。
    
    返回:
    关闭空闲连接的时长。
  - setIdleConnectionTime
```
public void setIdleConnectionTime(long idleConnectionTime)
```
    设置空闲连接的时长，连接空闲该时间后关闭，单位毫秒，默认60秒。
  - getProtocol
```
public Protocol getProtocol()
```
    获取连接OSS所采用的协议（HTTP/HTTPS）。
  - setProtocol
```
public void setProtocol(Protocol protocol)
```
    设置连接OSS所采用的协议（HTTP/HTTPS）。
  - getCnameExcludeList
```
public List<String> getCnameExcludeList()
```
    获取CNAME排除列表（不可修改），以列表元素作为后缀的域名将不进行CNAME解析。
    
    返回:
    CNAME排除列表。
  - setCnameExcludeList
```
public void setCnameExcludeList(List<String> cnameExcludeList)
```
    设置CNAME排除列表。
    
    参数:
    cnameExcludeList - CNAME排除列表。
  - isSupportCname
```
public boolean isSupportCname()
```
    获取是否支持Cname作为Endpoint，默认支持该方式。
    
    返回:
    若支持返回True，否则返回False
  - setSupportCname
```
public ClientConfiguration setSupportCname(boolean supportCname)
```
    设置是否支持Cname作为Endpoint。
    当设置为True时，则先检查Cname排除列表，如果不在其中则认为是Cname，否则就认为是三级域名方式访问；当设置为False时，不检查Cname排除列表，总是以三级域名方式访问。
    
    参数:
    supportCname - 是否支持Cname作为Endpoint。
  - isSLDEnabled
```
public boolean isSLDEnabled()
```
    获取是否开启二级域名（Second Level Domain）的访问方式，默认不开启。
    
    返回:
    若开启则返回True，否则返回False
  - setSLDEnabled
```
public ClientConfiguration setSLDEnabled(boolean enabled)
```
    设置是否开启二级域名（Second Level Domain）的访问方式。
    
    参数:
    enabled - 是否开启二级域名访问方式
  - getValidateAfterInactivity
```
public int getValidateAfterInactivity()
```
    连接空闲该时间后，重用前检查该连接的有效性，默认2秒，单位毫秒。
    
    返回:
    连接空闲时间
  - isRequestTimeoutEnabled
```
public boolean isRequestTimeoutEnabled()
```
    获取是否开启了请求超时，默认关闭。
    
    返回:
    true 开启， false 关闭
  - setRequestTimeoutEnabled
```
public void setRequestTimeoutEnabled(boolean requestTimeoutEnabled)
```
    设置是否开启请求超时。
    
    参数:
    requestTimeoutEnabled -
  - setRequestTimeout
```
public void setRequestTimeout(int requestTimeout)
```
    设置请求超时时间，单位毫秒，默认5分钟。
  - getRequestTimeout
```
public int getRequestTimeout()
```
    获取请求超时时间，单位毫秒。
  - getSlowRequestsThreshold
```
public long getSlowRequestsThreshold()
```
    设置慢请求阈值，用时超过该阈值的请求将打印到日志中，单位毫秒，默认5分钟。
  - setSlowRequestsThreshold
```
public void setSlowRequestsThreshold(long slowRequestsThreshold)
```
    获取慢请求阈值，用时超过该阈值的请求将打印到日志中，单位毫秒。
  - getDefaultHeaders
```
public Map<String,String> getDefaultHeaders()
```
    获取默认请求头，每个请求发送到时会添加默认请求头。具体操作请求头与默认请求头有重复时，前者覆盖后者，具体请求头优先级更高。
  - setDefaultHeaders
```
public void setDefaultHeaders(Map<String,String> defaultHeaders)
```
    设置默认请求头，每个请求发送到时会添加默认请求头。具体操作请求头与默认请求头有重复时，前者覆盖后者，具体请求头优先级更高。
    
    参数:
    defaultHeaders - 默认请求头
  - addDefaultHeader
```
public void addDefaultHeader(String key,
                    String value)
```
    添加默认请求头，每个请求发送到时会添加默认请求头。具体操作请求头与默认请求头有重复时，前者覆盖后者，具体请求头优先级更高。
    
    参数:
    key - 默认请求头
    value - 默认请求头的值
  - isCrcCheckEnabled
```
public boolean isCrcCheckEnabled()
```
    获取是否启动CRC校验，启动后上传下载请求数据会启动CRC校验。默认启用。
    
    返回:
    true 开启， false 关闭
  - setCrcCheckEnabled
```
public void setCrcCheckEnabled(boolean crcCheckEnabled)
```
    设置是否启动CRC校验，启动后上传下载请求数据会启动CRC校验。默认启用。
    
    参数:
    crcCheckEnabled -

类 ClientConfiguration

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_CONNECTION_REQUEST_TIMEOUT

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_SOCKET_TIMEOUT

DEFAULT_MAX_CONNECTIONS

DEFAULT_CONNECTION_TTL

DEFAULT_IDLE_CONNECTION_TIME

DEFAULT_VALIDATE_AFTER_INACTIVITY

DEFAULT_THREAD_POOL_WAIT_TIME

DEFAULT_REQUEST_TIMEOUT

DEFAULT_SLOW_REQUESTS_THRESHOLD

DEFAULT_USE_REAPER

DEFAULT_CNAME_EXCLUDE_LIST

构造器详细资料

ClientConfiguration

方法详细资料

getUserAgent

setUserAgent

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

getProxyDomain

setProxyDomain

getProxyWorkstation

setProxyWorkstation

getMaxConnections

setMaxConnections

getSocketTimeout

setSocketTimeout

getConnectionTimeout

setConnectionTimeout

getConnectionRequestTimeout

setConnectionRequestTimeout

getMaxErrorRetry

setMaxErrorRetry

getConnectionTTL

setConnectionTTL

isUseReaper

setUseReaper

getIdleConnectionTime

setIdleConnectionTime

getProtocol

setProtocol

getCnameExcludeList

setCnameExcludeList

isSupportCname

setSupportCname

isSLDEnabled

setSLDEnabled

getValidateAfterInactivity

isRequestTimeoutEnabled

setRequestTimeoutEnabled

setRequestTimeout

getRequestTimeout

getSlowRequestsThreshold

setSlowRequestsThreshold

getDefaultHeaders

setDefaultHeaders

addDefaultHeader

isCrcCheckEnabled

setCrcCheckEnabled