ImSession (Sinlmao Commons Network Utils 1.5.2 API)

java.lang.Object
- cn.sinlmao.commons.network.http.ImSession

```
public class ImSession
extends Object
```
会话状态控制对象类
该类用于需要使用会话状态控制的场景，作为数据存储的对象使用

Session state control object class
This class is used for scenarios that require session state control and is used as an object of data storage.
program: Sinlmao Commons Network Utils
description: 会话状态控制对象类
create: 2019-11-07 14:55

从以下版本开始:

1.4.1

作者:

Sinlmao

字段概要

字段
限定符和类型字段和说明

protected boolean ExecCallbackNow

字段
限定符和类型	字段和说明
`protected boolean`	`ExecCallbackNow`

构造器概要

构造器
构造器和说明

ImSession()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ImSession`	`addCookie(com.alibaba.fastjson.JSONObject cookies)` 添加Cookie，当数据已经存在，则不再添加 Add a Cookie, when the data already exists, it will not be added
`ImSession`	`addCookie(Map<String,String> cookies)` 添加Cookie，当数据已经存在，则不再添加 Add a Cookie, when the data already exists, it will not be added
`ImSession`	`addCookie(String name, String value)` 添加Cookie，当数据已经存在，则不再添加 Add a Cookie, when the data already exists, it will not be added
`ImSession`	`addExtra(com.alibaba.fastjson.JSONObject extras)` 添加Extra（额外/附加）数据，当数据已经存在，则不再添加 Add Extra (extra/additional) data, when the data already exists, it will not be added
`ImSession`	`addExtra(Map<String,Object> extras)` 添加Extra（额外/附加）数据，当数据已经存在，则不再添加 Add Extra (extra/additional) data, when the data already exists, it will not be added
`ImSession`	`addExtra(String name, Object value)` 添加Extra（额外/附加）数据，当数据已经存在，则不再添加 Add Extra (extra/additional) data, when the data already exists, it will not be added
`ImSession`	`addHeader(com.alibaba.fastjson.JSONObject headers)` 添加Header，当数据已经存在，则不再添加 Add a Header, when the data already exists, it will not be added
`ImSession`	`addHeader(Map<String,String> headers)` 添加Header，当数据已经存在，则不再添加 Add a Header, when the data already exists, it will not be added
`ImSession`	`addHeader(String name, String value)` 添加Header，当数据已经存在，则不再添加 Add a Header, when the data already exists, it will not be added
`int`	`getAutoAuthenticationTryCount()` 获取自动处理身份认证时最大次数 Get the maximum number of automatic processing of identity authentication
`protected ImSessionCallback`	`getCallback()`
`String`	`getCookieData(String name)` 根据Cookie键获得对应值 Get the corresponding value according to the Cookie key
`Set<String>`	`getCookieNames()` 获得所有Cookie键 Get all Cookie keys
`protected Map<String,String>`	`getCookies()`
`int`	`getCookieSize()` 获得Cookie数量 Get the count of Cookies
`Set<String>`	`getExtraNames()` 获得所有Extra（额外/附加）数据键 Get all Extra (extra/additional) data keys
`int`	`getExtraSize()` 获得Extra（额外/附加）数据数量 Get the count of Extra (extra/additional) datas
`Object`	`getExtraValue(String name)` 根据Extra（额外/附加）数据键获得对应值 Get the corresponding value according to the Extra (extra/additional) data key
`Set<String>`	`getHeaderNames()` 获得所有Header键 Get all Header keys
`protected Map<String,String>`	`getHeaders()`
`int`	`getHeaderSize()` 获得Header数量 Get the count of Headers
`String`	`getHeaderValue(String name)` 根据Header键获得对应值 Get the corresponding value according to the Header key
`boolean`	`isAutoAuthentication()` 获取是否需要自动处理身份认证 Get the need to automatically handle identity authentication
`boolean`	`isNeedAuthentication()` 获取是否需要身份认证 Get whether authentication is required
`ImSession`	`setAutoAuthentication(boolean autoAuthentication)` 设置是否需要自动处理身份认证当设置该标记后，还需要设置NeedAuthentication和ImSessionCallback，否则该项不会生效 Set the need to automatically handle identity authentication After setting this flag, you need to set NeedAuthentication and ImSessionCallback, otherwise the item will not take effect.
`ImSession`	`setAutoAuthenticationTryCount(int autoAuthenticationTryCount)` 设置自动处理身份认证时最大次数（最小1次，最大5次）当设置该值后，还需要设置NeedAuthentication、AutoAuthentication和ImSessionCallback，否则该项不会生效 Set the maximum number of automatic processing of identity authentication (minimum 1 time, maximum 5 times) After setting this value, you also need to set NeedAuthentication, AutoAuthentication and ImSessionCallback, otherwise the item will not take effect.
`void`	`setCallback(ImSessionCallback callback)` 设置ImSessionCallback的实现接口类 Set the implementation interface class of ImSessionCallback
`ImSession`	`setCookie(com.alibaba.fastjson.JSONObject cookies)` 添加Cookie，当数据已经存在，则以最后设置的为准 Set the Cookie.
`ImSession`	`setCookie(Map<String,String> cookies)` 添加Cookie，当数据已经存在，则以最后设置的为准 Set the Cookie.
`ImSession`	`setCookie(String name, String value)` 添加Cookie，当数据已经存在，则以最后设置的为准 Set the Cookie.
`protected void`	`setCookies(Map<String,String> cookies)`
`ImSession`	`setExtra(com.alibaba.fastjson.JSONObject extras)` 设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准 Set the Extra (extra/additional) data.
`ImSession`	`setExtra(Map<String,Object> extras)` 设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准 Set the Extra (extra/additional) data.
`ImSession`	`setExtra(String name, Object value)` 设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准 Set the Extra (extra/additional) data.
`ImSession`	`setHeader(com.alibaba.fastjson.JSONObject headers)` 设置Header，当数据已经存在，则以最后设置的为准 Set the Header.
`ImSession`	`setHeader(Map<String,String> headers)` 设置Header，当数据已经存在，则以最后设置的为准 Set the Header.
`ImSession`	`setHeader(String name, String value)` 设置Header，当数据已经存在，则以最后设置的为准 Set the Header.
`protected void`	`setHeaders(Map<String,String> headers)`
`ImSession`	`setNeedAuthentication(boolean needAuthentication)` 设置是否需要身份认证当设置该标记后，还需要设置ImSessionCallback，否则该项不会生效 Set whether authentication is required After setting this flag, you also need to set ImSessionCallback, otherwise the item will not take effect.

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

- 字段详细资料
  - ExecCallbackNow
```
protected boolean ExecCallbackNow
```
- 构造器详细资料
  - ImSession
```
public ImSession()
```
- 方法详细资料
  - setNeedAuthentication
```
public ImSession setNeedAuthentication(boolean needAuthentication)
```
    设置是否需要身份认证
    当设置该标记后，还需要设置ImSessionCallback，否则该项不会生效
    Set whether authentication is required
    After setting this flag, you also need to set ImSessionCallback, otherwise the item will not take effect.
    
    参数:
    
    needAuthentication - 是否需要身份认证
    Whether authentication is required
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - isNeedAuthentication
```
public boolean isNeedAuthentication()
```
    获取是否需要身份认证
    Get whether authentication is required
    
    返回:
    
    needAuthentication 是否需要身份认证
    Whether authentication is required
  - setAutoAuthentication
```
public ImSession setAutoAuthentication(boolean autoAuthentication)
```
    设置是否需要自动处理身份认证
    当设置该标记后，还需要设置NeedAuthentication和ImSessionCallback，否则该项不会生效
    Set the need to automatically handle identity authentication
    After setting this flag, you need to set NeedAuthentication and ImSessionCallback, otherwise the item will not take effect.
    
    参数:
    
    autoAuthentication - 是否需要自动处理身份认证
    Whether need to handle identity authentication automatically
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - isAutoAuthentication
```
public boolean isAutoAuthentication()
```
    获取是否需要自动处理身份认证
    Get the need to automatically handle identity authentication
    
    返回:
    
    autoAuthentication 是否需要自动处理身份认证
    Whether need to handle identity authentication automatically
  - setAutoAuthenticationTryCount
```
public ImSession setAutoAuthenticationTryCount(int autoAuthenticationTryCount)
```
    设置自动处理身份认证时最大次数（最小1次，最大5次）
    当设置该值后，还需要设置NeedAuthentication、AutoAuthentication和ImSessionCallback，否则该项不会生效
    Set the maximum number of automatic processing of identity authentication (minimum 1 time, maximum 5 times)
    After setting this value, you also need to set NeedAuthentication, AutoAuthentication and ImSessionCallback, otherwise the item will not take effect.
    
    参数:
    
    autoAuthenticationTryCount - 自动处理身份认证时最大次数
    Maximum number of automatic processing of identity authentication
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - getAutoAuthenticationTryCount
```
public int getAutoAuthenticationTryCount()
```
    获取自动处理身份认证时最大次数
    Get the maximum number of automatic processing of identity authentication
    
    返回:
    
    autoAuthenticationTryCount 自动处理身份认证时最大次数
    Maximum number of automatic processing of identity authentication
  - setCallback
```
public void setCallback(ImSessionCallback callback)
```
    设置ImSessionCallback的实现接口类
    Set the implementation interface class of ImSessionCallback
    
    参数:
    
    callback - ImSessionCallback的实现接口类
    ImSessionCallback implementation interface class
    
    另请参阅:
    
    ImSessionCallback
  - addHeader
```
public ImSession addHeader(String name,
                           String value)
```
    添加Header，当数据已经存在，则不再添加
    Add a Header, when the data already exists, it will not be added
    
    参数:
    
    name - Header键
    Header Key
    
    value - Header值
    Header Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addHeader
```
public ImSession addHeader(Map<String,String> headers)
```
    添加Header，当数据已经存在，则不再添加
    Add a Header, when the data already exists, it will not be added
    
    参数:
    
    headers - Map类型的Header数据
    Map type Header data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addHeader
```
public ImSession addHeader(com.alibaba.fastjson.JSONObject headers)
```
    添加Header，当数据已经存在，则不再添加
    Add a Header, when the data already exists, it will not be added
    
    参数:
    
    headers - JSONObject类型的Header数据
    JSONObject type Header data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setHeader
```
public ImSession setHeader(String name,
                           String value)
```
    设置Header，当数据已经存在，则以最后设置的为准
    Set the Header. When the data already exists, the last setting is subject to
    
    参数:
    
    name - Header键
    Header Key
    
    value - Header值
    Header Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setHeader
```
public ImSession setHeader(com.alibaba.fastjson.JSONObject headers)
```
    设置Header，当数据已经存在，则以最后设置的为准
    Set the Header. When the data already exists, the last setting is subject to
    
    参数:
    
    headers - JSONObject类型的Header数据
    JSONObject type Header data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setHeader
```
public ImSession setHeader(Map<String,String> headers)
```
    设置Header，当数据已经存在，则以最后设置的为准
    Set the Header. When the data already exists, the last setting is subject to
    
    参数:
    
    headers - Map类型的Header数据
    Map type Header data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addCookie
```
public ImSession addCookie(String name,
                           String value)
```
    添加Cookie，当数据已经存在，则不再添加
    Add a Cookie, when the data already exists, it will not be added
    
    参数:
    
    name - Cookie键
    Cookie Key
    
    value - Cookie值
    Cookie Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addCookie
```
public ImSession addCookie(Map<String,String> cookies)
```
    添加Cookie，当数据已经存在，则不再添加
    Add a Cookie, when the data already exists, it will not be added
    
    参数:
    
    cookies - Map类型的Cookie数据
    Map type Cookie data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addCookie
```
public ImSession addCookie(com.alibaba.fastjson.JSONObject cookies)
```
    添加Cookie，当数据已经存在，则不再添加
    Add a Cookie, when the data already exists, it will not be added
    
    参数:
    
    cookies - JSONObject类型的Cookie数据
    JSONObject type Cookie data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setCookie
```
public ImSession setCookie(String name,
                           String value)
```
    添加Cookie，当数据已经存在，则以最后设置的为准
    Set the Cookie. When the data already exists, the last setting is subject to
    
    参数:
    
    name - Cookie键
    Cookie Key
    
    value - Cookie值
    Cookie Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setCookie
```
public ImSession setCookie(Map<String,String> cookies)
```
    添加Cookie，当数据已经存在，则以最后设置的为准
    Set the Cookie. When the data already exists, the last setting is subject to
    
    参数:
    
    cookies - Map类型的Cookie数据
    Map type Cookie data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setCookie
```
public ImSession setCookie(com.alibaba.fastjson.JSONObject cookies)
```
    添加Cookie，当数据已经存在，则以最后设置的为准
    Set the Cookie. When the data already exists, the last setting is subject to
    
    参数:
    
    cookies - JSONObject类型的Cookie数据
    JSONObject type Cookie data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addExtra
```
public ImSession addExtra(String name,
                          Object value)
```
    添加Extra（额外/附加）数据，当数据已经存在，则不再添加
    Add Extra (extra/additional) data, when the data already exists, it will not be added
    
    参数:
    
    name - Extra键
    Extra Key
    
    value - Extra值
    Extra Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addExtra
```
public ImSession addExtra(Map<String,Object> extras)
```
    添加Extra（额外/附加）数据，当数据已经存在，则不再添加
    Add Extra (extra/additional) data, when the data already exists, it will not be added
    
    参数:
    
    extras - Map类型的Header数据
    Map type Extra data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - addExtra
```
public ImSession addExtra(com.alibaba.fastjson.JSONObject extras)
```
    添加Extra（额外/附加）数据，当数据已经存在，则不再添加
    Add Extra (extra/additional) data, when the data already exists, it will not be added
    
    参数:
    
    extras - JSONObject类型的Header数据
    JSONObject type Extra data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setExtra
```
public ImSession setExtra(String name,
                          Object value)
```
    设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准
    Set the Extra (extra/additional) data. When the data already exists, the last setting is subject to
    
    参数:
    
    name - Header键
    Extra Key
    
    value - Header值
    Extra Value
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setExtra
```
public ImSession setExtra(com.alibaba.fastjson.JSONObject extras)
```
    设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准
    Set the Extra (extra/additional) data. When the data already exists, the last setting is subject to
    
    参数:
    
    extras - JSONObject类型的Header数据
    JSONObject type Extra data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - setExtra
```
public ImSession setExtra(Map<String,Object> extras)
```
    设置Extra（额外/附加）数据，当数据已经存在，则以最后设置的为准
    Set the Extra (extra/additional) data. When the data already exists, the last setting is subject to
    
    参数:
    
    extras - Map类型的Header数据
    Map type Extra data
    
    返回:
    
    ImSession对象实体
    ImSession object entity
  - getHeaderValue
```
public String getHeaderValue(String name)
```
    根据Header键获得对应值
    Get the corresponding value according to the Header key
    
    参数:
    
    name - Header键
    Header Key
    
    返回:
    
    Header值
    Header Value
  - getHeaderNames
```
public Set<String> getHeaderNames()
```
    获得所有Header键
    Get all Header keys
    
    返回:
    
    所有Header键
    All Header keys
  - getHeaderSize
```
public int getHeaderSize()
```
    获得Header数量
    Get the count of Headers
    
    返回:
    
    Header数量
    Headers count
  - getCookieData
```
public String getCookieData(String name)
```
    根据Cookie键获得对应值
    Get the corresponding value according to the Cookie key
    
    参数:
    
    name - Cookie键
    Cookie Key
    
    返回:
    
    Cookie值
    Cookie Value
  - getCookieNames
```
public Set<String> getCookieNames()
```
    获得所有Cookie键
    Get all Cookie keys
    
    返回:
    
    所有Cookie键
    All Cookie keys
  - getCookieSize
```
public int getCookieSize()
```
    获得Cookie数量
    Get the count of Cookies
    
    返回:
    
    Cookie数量
    Cookies count
  - getExtraValue
```
public Object getExtraValue(String name)
```
    根据Extra（额外/附加）数据键获得对应值
    Get the corresponding value according to the Extra (extra/additional) data key
    
    参数:
    
    name - Extra键
    Extra Key
    
    返回:
    
    Extra值
    Extra Value
  - getExtraNames
```
public Set<String> getExtraNames()
```
    获得所有Extra（额外/附加）数据键
    Get all Extra (extra/additional) data keys
    
    返回:
    
    所有Extra键
    All Extra keys
  - getExtraSize
```
public int getExtraSize()
```
    获得Extra（额外/附加）数据数量
    Get the count of Extra (extra/additional) datas
    
    返回:
    
    Extra数量
    Extra count
  - getCallback
```
protected ImSessionCallback getCallback()
```
  - getHeaders
```
protected Map<String,String> getHeaders()
```
  - setHeaders
```
protected void setHeaders(Map<String,String> headers)
```
  - getCookies
```
protected Map<String,String> getCookies()
```
  - setCookies
```
protected void setCookies(Map<String,String> cookies)
```

类 ImSession

字段概要

构造器概要

方法概要

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

字段详细资料

ExecCallbackNow

构造器详细资料

ImSession

方法详细资料

setNeedAuthentication

isNeedAuthentication

setAutoAuthentication

isAutoAuthentication

setAutoAuthenticationTryCount

getAutoAuthenticationTryCount

setCallback

addHeader

addHeader

addHeader

setHeader

setHeader

setHeader

addCookie

addCookie

addCookie

setCookie

setCookie

setCookie

addExtra

addExtra

addExtra

setExtra

setExtra

setExtra

getHeaderValue

getHeaderNames

getHeaderSize

getCookieData

getCookieNames

getCookieSize

getExtraValue

getExtraNames

getExtraSize

getCallback

getHeaders

setHeaders

getCookies

setCookies