ClientBuilder (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.httpvisitor.client.ClientBuilder<Builder>

Type Parameters:

Builder -

All Implemented Interfaces:

ClientBuilderInterface<Builder>

Direct Known Subclasses:

SingleClientBuilder
```
public abstract class ClientBuilder<Builder extends ClientBuilder<Builder>>
extends Object
implements ClientBuilderInterface<Builder>
```
抽象通讯客户端构造

Author:

yancheng11334

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Builder`	`allowRedirects(boolean allowRedirects)` If follow get/head redirect, default true.
`Builder`	`auth(KeyCert cert)` 秘钥认证
`Builder`	`auth(PasswordCert cert)` 口令认证
`Builder`	`auth(String userName, String password)` 口令认证
`Builder`	`auth(String certPath, String password, String certType)` 秘钥认证
`ClientInterface`	`build()` 构建客户端实例
`Builder`	`compress(boolean compress)` if send compress requests.
`Builder`	`connectTimeout(int timeout)` Set connect timeout in millis
`protected Context`	`getContext()`
`protected Context`	`getContext(HttpConfigTemplate template)`
`List<RequestInterceptor>`	`getInterceptorList()`
`Builder`	`intercept(List<RequestInterceptor> interceptorList)` 批量注册请求拦截器
`Builder`	`intercept(RequestInterceptor interceptor)` 注册请求拦截器
`Builder`	`proxy(Proxy proxy)` 代理
`Builder`	`proxy(String host, int port)` 无验证代理
`Builder`	`proxy(String host, int port, String proxyName, String password)` 带验证代理
`protected abstract Builder`	`self()`
`Builder`	`socketTimeout(int timeout)` Set socket timeout in millis
`Builder`	`timeout(int timeout)` Set socket timeout and connect timeout in millis
`Builder`	`timeToLive(long timeToLive)` how long http connection keep, in milliseconds.
`Builder`	`userAgent(String userAgent)` set userAgent
`Builder`	`verify(boolean verify)` if verify http certificate, default true

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

- Method Detail
  - self
```
protected abstract Builder self()
```
  - build
```
public ClientInterface build()
```
    构建客户端实例
    
    Returns:
  - getContext
```
protected Context getContext()
```
  - getContext
```
protected Context getContext(HttpConfigTemplate template)
```
  - timeToLive
```
public Builder timeToLive(long timeToLive)
```
    Description copied from interface: ClientBuilderInterface
    
    how long http connection keep, in milliseconds. default -1, get from server response
    
    Specified by:
    
    timeToLive in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - userAgent
```
public Builder userAgent(String userAgent)
```
    Description copied from interface: ClientBuilderInterface
    
    set userAgent
    
    Specified by:
    
    userAgent in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - verify
```
public Builder verify(boolean verify)
```
    Description copied from interface: ClientBuilderInterface
    
    if verify http certificate, default true
    
    Specified by:
    
    verify in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - allowRedirects
```
public Builder allowRedirects(boolean allowRedirects)
```
    Description copied from interface: ClientBuilderInterface
    
    If follow get/head redirect, default true. This method not set following redirect for post/put/delete method, use allowPostRedirects if you want this
    
    Specified by:
    
    allowRedirects in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - compress
```
public Builder compress(boolean compress)
```
    Description copied from interface: ClientBuilderInterface
    
    if send compress requests. default true
    
    Specified by:
    
    compress in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - timeout
```
public Builder timeout(int timeout)
```
    Description copied from interface: ClientBuilderInterface
    
    Set socket timeout and connect timeout in millis
    
    Specified by:
    
    timeout in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - socketTimeout
```
public Builder socketTimeout(int timeout)
```
    Description copied from interface: ClientBuilderInterface
    
    Set socket timeout in millis
    
    Specified by:
    
    socketTimeout in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - connectTimeout
```
public Builder connectTimeout(int timeout)
```
    Description copied from interface: ClientBuilderInterface
    
    Set connect timeout in millis
    
    Specified by:
    
    connectTimeout in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
  - proxy
```
public Builder proxy(String host,
                     int port,
                     String proxyName,
                     String password)
```
    Description copied from interface: ClientBuilderInterface
    
    带验证代理
    
    Specified by:
    
    proxy in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - proxy
```
public Builder proxy(String host,
                     int port)
```
    Description copied from interface: ClientBuilderInterface
    
    无验证代理
    
    Specified by:
    
    proxy in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - proxy
```
public Builder proxy(Proxy proxy)
```
    Description copied from interface: ClientBuilderInterface
    
    代理
    
    Specified by:
    
    proxy in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - auth
```
public Builder auth(String userName,
                    String password)
```
    Description copied from interface: ClientBuilderInterface
    
    口令认证
    
    Specified by:
    
    auth in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - auth
```
public Builder auth(PasswordCert cert)
```
    Description copied from interface: ClientBuilderInterface
    
    口令认证
    
    Specified by:
    
    auth in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - auth
```
public Builder auth(String certPath,
                    String password,
                    String certType)
```
    Description copied from interface: ClientBuilderInterface
    
    秘钥认证
    
    Specified by:
    
    auth in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - auth
```
public Builder auth(KeyCert cert)
```
    Description copied from interface: ClientBuilderInterface
    
    秘钥认证
    
    Specified by:
    
    auth in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - intercept
```
public Builder intercept(RequestInterceptor interceptor)
```
    Description copied from interface: ClientBuilderInterface
    
    注册请求拦截器
    
    Specified by:
    
    intercept in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - intercept
```
public Builder intercept(List<RequestInterceptor> interceptorList)
```
    Description copied from interface: ClientBuilderInterface
    
    批量注册请求拦截器
    
    Specified by:
    
    intercept in interface ClientBuilderInterface<Builder extends ClientBuilder<Builder>>
    
    Returns:
  - getInterceptorList
```
public List<RequestInterceptor> getInterceptorList()
```

Class ClientBuilder<Builder extends ClientBuilder<Builder>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

self

build

getContext

getContext

timeToLive

userAgent

verify

allowRedirects

compress

timeout

socketTimeout

connectTimeout

proxy

proxy

proxy

auth

auth

auth

auth

intercept

intercept

getInterceptorList