# com.eos.foundation.eoscommon.OnlineUserManagerUtil

# 构件包说明

本工具类实现了对在线用户管理的操作。

# 运算逻辑构件使用说明

说明

对于该运算逻辑的例子，需要从页面流http://127.0.0.1:8080/eos-default/example/com.primeton.eos.foundation.example.onlineUserManager.flow进入。
关于UserObject的说明，请参见《EOS基础参考手册》中"MUO\用户对象"。

该构件包包含以下构件：

序号	方法	功能描述
1	evictByUniqueId(String uniqueId)	根据uniqueId逐出一个用户
2	evictByUserId(String userId)	根据userId逐出多个用户
3	getUserObjects()	获取所有在线用户
4	getUserObjectsByUniqueId(String uniqueId)	根据uniqueId获取一个用户
5	getUserObjectsByUserId(String userId)	根据userId获取多个用户
6	login(UserCredential credential)	使用用户身份凭证登录
7	login(IUserObject userObject)	使用UserObject登录
8	logoutByUniqueId()	根据当前Session里的UserObject的uniqueId登出一个用户
9	logoutByUniqueId(String uniqueId)	根据uniqueId登出一个用户
10	logoutByUserId()	根据当前Session里的UserObject的userId登出多个用户
11	logoutByUserId(String userId)	根据userId登出多个用户

# evictByUniqueId：根据uniqueId逐出一个用户

# 【功能说明】

根据uniqueId逐出一个用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.evictByUniqueId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	uniqueId	java.lang.String	用户对象的唯一标识
返回值	userObject	com.eos.data.datacontext.UserObject	被逐出的用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据uniqueId逐出一个用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	uniqueId	java.lang.String	uniqueId	变量	传引用
返回值	userObject	com.eos.data.datacontext.UserObject	userObjects	变量	传引用

参数描述第一个参数uniqueId是用户对象的唯一标识。返回值userObject是被逐出的用户对象。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObject>
    </__root>
</bizContext>

# evictByUserId：根据userId逐出多个用户

# 【功能说明】

根据userId逐出多个用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.evictByUserId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	userId	java.lang.String	用户id
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	被逐出的用户对象数组

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据userId逐出多个用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	userId	java.lang.String	userId	变量	传引用
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	userObjects	变量	传引用

参数描述第一个参数userId是用户id。返回值userObject[]是被逐出的用户对象数组。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
        <userObjects __collection="array" __collectionid="1"
__componentType="java:com.eos.data.datacontext.IUserObject" __id="2" __index="0"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="4" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b739b50037</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test1</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
        <userObjects __collection="array" __collectionid="1" __id="3" __index="1"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="5" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">F1DED9610E9D84F4C2A963BAADE4330A</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b764cc003a</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
    </__root>
</bizContext>

# getUserObjects：获取所有在线用户

# 【功能说明】

获取所有在线用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.getUserObjects，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	用户对象数组

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：获取所有在线用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	userObjects	变量	传引用

参数描述返回值userObject[]是所有在线用户。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userObjects __id="1" __isNullOrEmpty="empty"
__type="java:[Lcom.eos.data.datacontext.IUserObject;"/>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userObjects __collection="array" __collectionid="1"
__componentType="java:com.eos.data.datacontext.IUserObject" __id="2" __index="0"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="5" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67fa50350044</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test1</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
        <userObjects __collection="array" __collectionid="1" __id="3" __index="1"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="6" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">09C2F1C372BADBB1FD07B8E963903051</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67fa6aa30047</uniqueId>
            <userId __type="java:java.lang.String">333</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test3</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
        <userObjects __collection="array" __collectionid="1" __id="4" __index="2"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="7" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">F1DED9610E9D84F4C2A963BAADE4330A</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67fa301a0041</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
    </__root>
</bizContext>

# getUserObjectsByUniqueId：根据uniqueId获取一个用户

# 【功能说明】

根据uniqueId获取一个用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.getUserObjectsByUniqueId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	uniqueId	java.lang.String	用户对象的唯一标识
返回值	userObject	com.eos.data.datacontext.UserObject	对应的用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据uniqueId获取一个用户对象。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	uniqueId	java.lang.String	uniqueId	变量	传引用
返回值	userObject	com.eos.data.datacontext.UserObject	userObject	变量	传引用

参数描述第一个参数uniqueId是用户对象的唯一标识。返回值userObject是查询出来的用户对象。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObject>
    </__root>
</bizContext>

# getUserObjectsByUserId：根据userId获取多个用户

# 【功能说明】

根据userId获取多个用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.getUserObjectsByUserId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	userId	java.lang.String	用户id
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	用户对象数组

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据userId查询出多个用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	userId	java.lang.String	userId	变量	传引用
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	userObjects	变量	传引用

参数描述第一个参数userId是用户id。返回值userObject[]是查询出来的用户对象数组。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
        <userObjects __collection="array" __collectionid="1"
__componentType="java:com.eos.data.datacontext.IUserObject" __id="2" __index="0"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="4" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b739b50037</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test1</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
        <userObjects __collection="array" __collectionid="1" __id="3" __index="1"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="5" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">F1DED9610E9D84F4C2A963BAADE4330A</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b764cc003a</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
    </__root>
</bizContext>

# 【功能说明】

根据传入的用户身份凭证，调用回调接口（IUserLoginCallback）创建出一个UserObject，然后调用OnlineUserManager.login(IUserObject)方法，完成用户登录，并返回创建出的UserObject。

说明

UserCredential是一个实现了Map接口的用户身份认证的对象，用于收集用户登录时所填写的用户名、密码等。关于登录回调接口，请参见《EOS基础参考手册》中的"MUO\用户登录回调接口"。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.login，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	credential	com.eos.common.muo.UserCredential	用户身份凭证
返回值	userObject	com.eos.data.datacontext.UserObject	用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：用户登录。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	credential	com.eos.common.muo.UserCredential	userCredential	变量	传引用
返回值	userObject	com.eos.data.datacontext.UserObject	userObject	变量	传引用

参数描述第一个参数credential是用户身份凭证。返回值userObject是调用回调接口生成的UserObject。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userCredential __id="1" __type="java:com.eos.common.muo.UserCredential">
            <userId __type="java:java.lang.String">111</userId>
            <userName __type="java:java.lang.String">test_user</userName>
        </userCredential>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="3" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e6797859e0029</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObject>
        <userCredential __id="2" __type="java:com.eos.common.muo.UserCredential">
            <userId __type="java:java.lang.String">111</userId>
            <userName __type="java:java.lang.String">test_user</userName>
        </userCredential>
    </__root>
</bizContext>

# 【功能说明】

登录一个UserObject。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.login，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	userObject	com.eos.data.datacontext.UserObject	用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：用户登录。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
类型	名称	数据类型	值	值类别	传递方式
参数	userObject	com.eos.data.datacontext.UserObject	userObject	变量	传引用

参数描述第一个参数userObject是用户对象。
参数描述无。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __isNullOrEmpty="null"/>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __isNullOrEmpty="null"/>
        </userObject>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObject>
    </__root>
</bizContext>

# logoutByUniqueId：根据当前Session里的UserObject的uniqueId登出一个用户

# 【功能说明】

根据当前线程上下文中的Session，获取UserObject并根据UserObject中的uniqueId进行登出。如果当前上下文中不存在session，返回null。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.logoutByUniqueId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
返回值	userObject	com.eos.data.datacontext.UserObject	登出的用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：把当前线程中的用户作登出。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
返回值	userObject	com.eos.data.datacontext.UserObject	tmp	变量	传引用

参数描述返回值userObject是登出的用户对象。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <tmp __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">3E1A4718098E4FABB327D1621058A2DC</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1f8cede5011f8cf2731f0004</uniqueId>
            <userId __type="java:java.lang.String">1234</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">1234</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </tmp>
    </__root>
</bizContext>

# logoutByUniqueId：根据uniqueId登出一个用户

# 【功能说明】

根据uniqueId登出一个用户。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.logoutByUniqueId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	uniqueId	java.lang.String	用户对象的唯一标识
返回值	userObject	com.eos.data.datacontext.UserObject	登出的用户对象

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：用户登出。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	uniqueId	java.lang.String	uniqueId	变量	传引用
返回值	userObject	com.eos.data.datacontext.UserObject	userObject	变量	传引用

参数描述第一个参数uniqueId是用户对象的唯一标识。返回值userObject是登出的用户对象。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
        <userObject __id="1" __type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="2" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e679de71a002d</uniqueId>
            <userId __type="java:java.lang.String">222</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test_user2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObject>
    </__root>
</bizContext>

# logoutByUserId：根据当前Session里的UserObject的userId登出多个用户

# 【功能说明】

根据当前线程上下文中的Session，获取UserObject并根据UserObject中的userId进行登出。如果当前上下文中不存在session，返回空数组。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.logoutByUserId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	用户对象数组

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据当前线程上下文中Session里的UserObject的userId登出多个用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
类型	名称	数据类型	值	值类别	传递方式
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	tmp	变量	传引用

参数描述返回值userObject[]是登出的用户对象数组。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <tmp __collection="array" __collectionid="1"
__componentType="java:com.eos.data.datacontext.IUserObject" __id="2" __index="0"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="4" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">688748440C9952F57CC0667EC0D5697A</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1f8d0692011f8d10d5510058</uniqueId>
            <userId __type="java:java.lang.String">qq</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">qq1</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </tmp>
        <tmp __collection="array" __collectionid="1" __id="3" __index="1"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="5" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">CA1275D3008C62B73D5D7BAA025C0400</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1f8d0692011f8d1101c0005b</uniqueId>
            <userId __type="java:java.lang.String">qq</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">qq2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </tmp>
    </__root>
</bizContext>

# logoutByUserId：根据userId登出多个用户

# 【功能说明】

根据userId登出多个用户。适用于多个session具有相同的userId或一个userId的多个用户都有session，需要一起登出的场景。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

本运算逻辑构件对应JAVA方法路径： com.eos.foundation.eoscommon.OnlineUserManagerUtil.logoutByUserId，包含在com.eos.foundation.jar中。
运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

参数说明

类型	名称	数据类型	参数描述
参数	userId	java.lang.String	用户id
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	用户对象数组

抛出异常说明无。
规则说明无。

# 【参考案例】

示例：根据userId登出多个用户。

场景描述无。
参数设置

类型	名称	数据类型	值	值类别	传递方式
参数	userId	java.lang.String	userId	变量	传引用
返回值	userObject[]	com.eos.data.datacontext.UserObject[]	userObjects	变量	传引用

参数描述第一个参数userId是用户id。返回值userObject[]是登出的用户对象数组。
其他说明无。
调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
    </__root>
</bizContext>

调用后的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <userId __type="java:java.lang.String">111</userId>
        <userObjects __collection="array" __collectionid="1"
__componentType="java:com.eos.data.datacontext.IUserObject" __id="2" __index="0"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="4" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">D10805ECEE56F3B2BECA595F5FE68236</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b739b50037</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test1</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
        <userObjects __collection="array" __collectionid="1" __id="3" __index="1"
__type="java:com.eos.data.datacontext.UserObject">
            <attributes __id="5" __isNullOrEmpty="empty" __type="java:java.util.HashMap"/>
            <sessionId __type="java:java.lang.String">F1DED9610E9D84F4C2A963BAADE4330A</sessionId>
            <uniqueId __type="java:java.lang.String">4028801e1e6739bd011e67b764cc003a</uniqueId>
            <userId __type="java:java.lang.String">111</userId>
            <userMail __isNullOrEmpty="null"/>
            <userName __type="java:java.lang.String">test2</userName>
            <userOrgId __isNullOrEmpty="null"/>
            <userOrgName __isNullOrEmpty="null"/>
            <userRealName __isNullOrEmpty="null"/>
            <userRemoteIP __type="java:java.lang.String">127.0.0.1</userRemoteIP>
        </userObjects>
    </__root>
</bizContext>

← SDO数据操作类DataObjectUtil 定时器 →

# com.eos.foundation.eoscommon.OnlineUserManagerUtil

# 构件包说明

# 运算逻辑构件使用说明

# evictByUniqueId：根据uniqueId逐出一个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# evictByUserId：根据userId逐出多个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# getUserObjects：获取所有在线用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# getUserObjectsByUniqueId：根据uniqueId获取一个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# getUserObjectsByUserId：根据userId获取多个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# login：使用用户身份凭证登录

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# login：使用UserObject登录

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# logoutByUniqueId：根据当前Session里的UserObject的uniqueId登出一个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# logoutByUniqueId：根据uniqueId登出一个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# logoutByUserId：根据当前Session里的UserObject的userId登出多个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】

# logoutByUserId：根据userId登出多个用户

# 【功能说明】

# 【版本说明】

# 【引用路径】

# 【使用说明】

# 【参考案例】