HeaderOperation (hutool 6.0.0-M20 API)

Type Parameters:

T - 返回对象类型，方便链式编程

All Known Implementing Classes:

JdkHttpConnection, Request, SoapClient
```
public interface HeaderOperation<T extends HeaderOperation<T>>
```
HTTP请求头的存储和读取相关方法

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default T`	`auth(String content)` 验证，简单插入Authorization头
`default T`	`basicAuth(String username, String password, Charset charset)` 简单验证，生成的头信息类似于： Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
`default T`	`bearerAuth(String token)` 令牌验证，生成的头类似于："Authorization: Bearer XXXXX"，一般用于JWT
`default String`	`contentEncoding()` 获取压缩媒体类型
`default long`	`contentLength()` 获取内容长度，以下情况长度无效： Transfer-Encoding: Chunked Content-Encoding: XXX
`default T`	`contentType(String contentType)` 设置contentType
`default T`	`cookie(Collection<HttpCookie> cookies)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`default T`	`cookie(HttpCookie... cookies)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`default T`	`cookie(String cookie)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`default T`	`disableCookie()` 禁用默认Cookie行为，此方法调用后会将Cookie置为空。
`default T`	`enableDefaultCookie()` 打开默认的Cookie行为（自动回填服务器传回的Cookie）
`default String`	`header(HeaderName headerName)` 获取指定的Header值，如果不存在返回`null`
`default T`	`header(HeaderName name, String value)` 设置一个header 覆盖模式，则替换之前的值
`default T`	`header(HeaderName name, String value, boolean isOverride)` 设置一个header 如果覆盖模式，则替换之前的值，否则加入到值列表中
`default T`	`header(Map<String,? extends Collection<String>> headerMap, boolean isOverride)` 设置请求头不覆盖原有请求头
`default T`	`header(Map<String,String> headerMap)` 设置请求头覆盖原有请求头，请求参数为普通Map,简化使用
`default String`	`header(String name)` 获取指定的Header值，如果不存在返回`null`
`default T`	`header(String name, String value)` 添加请求头，默认覆盖原有头参数
`T`	`header(String name, String value, boolean isOverride)` 设置一个header 如果覆盖模式，则替换之前的值，否则加入到值列表中如果给定值为`null`，则删除这个头信息
`Map<String,? extends Collection<String>>`	`headers()` 获取headers
`default boolean`	`isChunked()` 是否为Transfer-Encoding:Chunked的内容
`default T`	`keepAlive(boolean isKeepAlive)` 设置是否为长连接
`default T`	`proxyAuth(String content)` 验证，简单插入Authorization头

- Method Detail
  - headers
```
Map<String,? extends Collection<String>> headers()
```
    获取headers
    
    Returns:
    
    Headers Map
  - header
```
T header(String name,
         String value,
         boolean isOverride)
```
    设置一个header
    如果覆盖模式，则替换之前的值，否则加入到值列表中
    如果给定值为null，则删除这个头信息
    
    Parameters:
    
    name - Header名，null跳过
    
    value - Header值，null表示删除name对应的头
    
    isOverride - 是否覆盖已有值
    
    Returns:
    
    this
  - header
```
default String header(HeaderName headerName)
```
    获取指定的Header值，如果不存在返回null
    
    Parameters:
    
    headerName - header名
    
    Returns:
    
    header值
  - header
```
default String header(String name)
```
    获取指定的Header值，如果不存在返回null
    
    Parameters:
    
    name - header名
    
    Returns:
    
    header值
  - header
```
default T header(HeaderName name,
                 String value,
                 boolean isOverride)
```
    设置一个header
    如果覆盖模式，则替换之前的值，否则加入到值列表中
    
    Parameters:
    
    name - Header名
    
    value - Header值
    
    isOverride - 是否覆盖已有值
    
    Returns:
    
    T 本身
  - header
```
default T header(HeaderName name,
                 String value)
```
    设置一个header
    覆盖模式，则替换之前的值
    
    Parameters:
    
    name - Header名
    
    value - Header值
    
    Returns:
    
    T 本身
  - header
```
default T header(String name,
                 String value)
```
    添加请求头，默认覆盖原有头参数
    
    Parameters:
    
    name - 请求头参数名称
    
    value - 参数值
    
    Returns:
    
    this
  - header
```
default T header(Map<String,? extends Collection<String>> headerMap,
                 boolean isOverride)
```
    设置请求头
    不覆盖原有请求头
    
    Parameters:
    
    headerMap - 请求头
    
    isOverride - 是否覆盖
    
    Returns:
    
    this
  - header
```
default T header(Map<String,String> headerMap)
```
    设置请求头
    覆盖原有请求头，请求参数为普通Map,简化使用
    
    Parameters:
    
    headerMap - 请求头
    
    Returns:
    
    this
  - contentType
```
default T contentType(String contentType)
```
    设置contentType
    
    Parameters:
    
    contentType - contentType
    
    Returns:
    
    T
  - keepAlive
```
default T keepAlive(boolean isKeepAlive)
```
    设置是否为长连接
    
    Parameters:
    
    isKeepAlive - 是否长连接
    
    Returns:
    
    T
  - contentLength
```
default long contentLength()
```
    获取内容长度，以下情况长度无效：
    - Transfer-Encoding: Chunked
    - Content-Encoding: XXX
    Returns:
    
    长度，-1表示服务端未返回或长度无效
    
    Since:
    
    5.7.9
  - isChunked
```
default boolean isChunked()
```
    是否为Transfer-Encoding:Chunked的内容
    
    Returns:
    
    是否为Transfer-Encoding:Chunked的内容
    
    Since:
    
    4.6.2
  - contentEncoding
```
default String contentEncoding()
```
    获取压缩媒体类型
    
    Returns:
    
    压缩媒体类型
  - basicAuth
```
default T basicAuth(String username,
                    String password,
                    Charset charset)
```
    简单验证，生成的头信息类似于：
```
 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
 
```
    Parameters:
    
    username - 用户名
    
    password - 密码
    
    charset - 编码
    
    Returns:
    
    this
  - bearerAuth
```
default T bearerAuth(String token)
```
    令牌验证，生成的头类似于："Authorization: Bearer XXXXX"，一般用于JWT
    
    Parameters:
    
    token - 令牌内容
    
    Returns:
    
    T this
  - auth
```
default T auth(String content)
```
    验证，简单插入Authorization头
    
    Parameters:
    
    content - 验证内容
    
    Returns:
    
    T this
  - proxyAuth
```
default T proxyAuth(String content)
```
    验证，简单插入Authorization头
    
    Parameters:
    
    content - 验证内容
    
    Returns:
    
    T this
  - cookie
```
default T cookie(Collection<HttpCookie> cookies)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    Parameters:
    
    cookies - Cookie值数组，如果为null则设置无效，使用默认Cookie行为
    
    Returns:
    
    this
    
    Since:
    
    5.4.1
  - cookie
```
default T cookie(HttpCookie... cookies)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    Parameters:
    
    cookies - Cookie值数组，如果为null则设置无效，使用默认Cookie行为
    
    Returns:
    
    this
    
    Since:
    
    3.1.1
  - cookie
```
default T cookie(String cookie)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    Parameters:
    
    cookie - Cookie值，如果为null则设置无效，使用默认Cookie行为
    
    Returns:
    
    this
    
    Since:
    
    3.0.7
  - disableCookie
```
default T disableCookie()
```
    禁用默认Cookie行为，此方法调用后会将Cookie置为空。
    如果想重新启用Cookie，请调用：cookie(String)方法自定义Cookie。
    如果想启动默认的Cookie行为（自动回填服务器传回的Cookie），则调用enableDefaultCookie()
    
    Returns:
    
    this
    
    Since:
    
    3.0.7
  - enableDefaultCookie
```
default T enableDefaultCookie()
```
    打开默认的Cookie行为（自动回填服务器传回的Cookie）
    
    Returns:
    
    this

Interface HeaderOperation<T extends HeaderOperation<T>>

Method Summary

Method Detail

headers

header

header

header

header

header

header

header

header

contentType

keepAlive

contentLength

isChunked

contentEncoding

basicAuth

bearerAuth

auth

proxyAuth

cookie

cookie

cookie

disableCookie

enableDefaultCookie