UserContext (Java SDK API Reference for AWS PaaS)

java.lang.Object
- com.actionsoft.bpms.server.UserContext

```
public final class UserContext
extends java.lang.Object
```
用户上下文对象

另请参阅:

会话常量, 用户身份常量, AWS用户模型, AWS单位模型, AWS部门模型, AWS角色模型, 使用API创建Session, 使用API检查Session合法性, 使用API关闭Session

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static UserContext`	`fromSessionId(SessionModel sessionModel, java.lang.String clientIp)`
`static UserContext`	`fromSessionId(java.lang.String sid)` 从一个会话串构建UserContext
`static UserContext`	`fromSessionId(java.lang.String sid, java.lang.String clientIp)` 从一个会话串构建UserContext
`static UserContext`	`fromUID(java.lang.String uid)` 从一个uid登录账户构建UserContext，构建的UserContext可以方便开发者获取该用户相信息，如该账户的属性、所在部门、角色等。
`java.lang.String`	`getClientIP()` 用户登录IP地址
`CompanyModel`	`getCompanyModel()` 访问该用户的主单位模型
`DepartmentModel`	`getDepartmentModel()` 访问该用户的主部门模型
`java.lang.String`	`getDeviceType()` 访问者登录终端类型
`java.lang.Object`	`getExtParam(java.lang.String key)` 获得用户登录页面的开发者自定义变量值、开发者为该session保存的临时变量值
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtParams()` 获得用户登录页面的开发者自定义变量/值、开发者为该session保存的临时变量/值
`java.lang.String`	`getInstName()` AWS服务实例名称。
`java.lang.String`	`getLanguage()` 访问者界面语言
`java.lang.String`	`getLookAndFeelType()` 当前帐户的门户风格
`RoleModel`	`getRoleModel()` 访问该用户的主角色模型
`java.lang.String`	`getSessionId()` 访问者会话值，一个序列化的字符串。
`java.lang.String`	`getSessionIp()` 访问者IP地址
`java.lang.String`	`getSessionScope()` Session会话有效范围
`java.util.Date`	`getSessionStart()` Session会话创建时间，如果无Session，返回null
`java.sql.Timestamp`	`getSubscribeDate()` 如果是SaaS多租户模式，返回订阅的逾期时间。
`java.lang.String`	`getTimeZone()` 返回当前用户登录时所在的时区
`java.lang.String`	`getUID()` 登录账户名，全局不重复。
`java.lang.String`	`getUniqueId()` 由系统自动分配的全局唯一注册id，默认为一个36位的uuid串。
`UserModel`	`getUserModel()` 访问该用户模型
`java.lang.String`	`getUserName()` 用户姓名
`boolean`	`isCreateBySDK()` 判断Session由SDK API创建还是用户登录创建
`boolean`	`isMobileClient()` 访问者是否由手机登录
`boolean`	`isSaaSModel()` 该账户是否为SaaS多租户
`boolean`	`isTabletClient()` 访问者是否由平板电脑登录
`void`	`setDeviceType(java.lang.String deviceType)` 改变用户访问设备
`void`	`setExtParam(java.lang.String key, java.lang.Object obj)` 为当前session设置自定义的临时变量和值
`void`	`setExtParams(java.util.Map<java.lang.String,java.lang.Object> extParams)` 为当前session设置自定义的临时变量和值
`void`	`setInstName(java.lang.String instName)` 设置该会话之后的请求来自指定的AWS实例节点，在集群模式时有效
`void`	`setLanguages(java.lang.String lang)` 改变用户界面语言
`java.lang.String`	`toString()`
`int`	`validateSession()` 检查会话是否有效

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

- 方法详细资料
  - fromSessionId
```
public static UserContext fromSessionId(java.lang.String sid)
                                 throws AWSException
```
    从一个会话串构建UserContext
    
    参数:
    
    sid - session会话串
    
    返回:
    
    用户上下文对象
    
    抛出:
    
    AWSException - 如果该Session不存在或已被销毁，抛出异常；如果创建该Session的用户被删除或不存在，抛出异常
  - fromSessionId
```
public static UserContext fromSessionId(java.lang.String sid,
                                        java.lang.String clientIp)
```
    从一个会话串构建UserContext
    
    参数:
    
    sid - session会话串
    
    clientIp - 访问者IP地址
    
    返回:
    
    用户上下文对象
  - fromSessionId
```
public static UserContext fromSessionId(SessionModel sessionModel,
                                        java.lang.String clientIp)
```
  - fromUID
```
public static UserContext fromUID(java.lang.String uid)
```
    从一个uid登录账户构建UserContext，构建的UserContext可以方便开发者获取该用户相信息，如该账户的属性、所在部门、角色等。但不能作为合法的登录上下文会话，也无法获得常规Session附加信息，如客户端设备类型、界面语言、客户端ip等
    
    参数:
    
    uid - AWS登录账户
    
    返回:
    
    用户上下文对象
  - validateSession
```
public int validateSession()
```
    检查会话是否有效
    
    返回:
    
    检查结果。1为有效，其他值无效
    
    另请参阅:
    
    SessionConst.SESSION_STATUS_OK, SessionConst.SESSION_STATUS_ERROR, SessionConst.SESSION_STATUS_NOTFIND, SessionConst.SESSION_STATUS_OVERTIME, SessionConst.SESSION_STATUS_USER_NOTFIND
  - getSessionStart
```
public java.util.Date getSessionStart()
```
    Session会话创建时间，如果无Session，返回null
    
    返回:
    
    创建日期
  - isCreateBySDK
```
public boolean isCreateBySDK()
```
    判断Session由SDK API创建还是用户登录创建
    
    返回:
    
    如果由SDK接口创建，返回true
    
    另请参阅:
    
    PortalAPI
  - getSessionIp
```
public java.lang.String getSessionIp()
```
    访问者IP地址
    
    返回:
    
    IP地址，如果无Session构建，返回null
  - getSessionScope
```
public java.lang.String getSessionScope()
```
    Session会话有效范围
    
    返回:
    
    代号
    
    另请参阅:
    
    LoginConst.SYSTEM_ADMIN_CONSOLE, LoginConst.SYSTEM_COE, LoginConst.SYSTEM_PORTAL_CLIENT
  - getLanguage
```
public java.lang.String getLanguage()
```
    访问者界面语言
    
    返回:
    
    语言，对应了i18n语言配置项
    
    另请参阅:
    
    LoginConst.DEFAULT_LANG, AppAPI.i18NValue(String, UserContext, String)
  - setLanguages
```
public void setLanguages(java.lang.String lang)
```
    改变用户界面语言
    
    参数:
    
    lang - 语言，对应了i18n语言配置项
    
    另请参阅:
    
    PlatformAPI.getlanguages()
  - setDeviceType
```
public void setDeviceType(java.lang.String deviceType)
```
    改变用户访问设备
    
    参数:
    
    deviceType - 设备类型，参见：LoginConst
  - isMobileClient
```
public boolean isMobileClient()
```
    访问者是否由手机登录
    
    返回:
    
    手机登录返回true
    
    另请参阅:
    
    LoginConst.DEVICE_MOBILE
  - isTabletClient
```
public boolean isTabletClient()
```
    访问者是否由平板电脑登录
    
    返回:
    
    平板电脑登录返回true
    
    另请参阅:
    
    LoginConst.DEVICE_TABLET
  - getDeviceType
```
public java.lang.String getDeviceType()
```
    访问者登录终端类型
    
    返回:
    
    类型名称，如果无Session，返回默认终端类型(pc)
    
    另请参阅:
    
    LoginConst.DEVICE_TABLET, LoginConst.DEVICE_MOBILE, LoginConst.DEVICE_PC
  - getSessionId
```
public java.lang.String getSessionId()
```
    访问者会话值，一个序列化的字符串。如果该会话含有扩展属性，以Base64格式附加到36位串之后
    
    返回:
    
    sessionId, 如果无Session返回null
  - getInstName
```
public java.lang.String getInstName()
```
    AWS服务实例名称。当处于集群部署时，如果该值为空表示由Web层的算法指定该Session请求的AWS目标节点;如果该值指定一个AWS实例名，则Web层请求总是指向该AWS节点。
    
    返回:
    
    AWS服务实例名称，如果未指定返回空串
    
    另请参阅:
    
    AWSServerConf#getInstanceName()
  - setInstName
```
public void setInstName(java.lang.String instName)
```
    设置该会话之后的请求来自指定的AWS实例节点，在集群模式时有效
    
    参数:
    
    instName - 有效的AWS节点实例名，值为空或空串时可取消固定请求。如果该节点不存在或处于不可用状态，异常被抛出
  - getTimeZone
```
public java.lang.String getTimeZone()
```
    返回当前用户登录时所在的时区
    
    返回:
    
    时区信息
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    由系统自动分配的全局唯一注册id，默认为一个36位的uuid串。平台内部对用户进行操作或构建Web端变量（如树节点Id）时使用该值
    
    返回:
    
    内部注册Id
  - getUID
```
public java.lang.String getUID()
```
    登录账户名，全局不重复。该值为AWS平台上层及业务解决方案引用账户的唯一标识
    
    返回:
    
    登录账户名
  - getUserName
```
public java.lang.String getUserName()
```
    用户姓名
    
    返回:
    
    姓名
  - getClientIP
```
public java.lang.String getClientIP()
```
    用户登录IP地址
    
    返回:
    
    IP地址
  - getUserModel
```
public UserModel getUserModel()
```
    访问该用户模型
    
    返回:
    
    AWS用户模型
    
    另请参阅:
    
    UserModel
  - getCompanyModel
```
public CompanyModel getCompanyModel()
```
    访问该用户的主单位模型
    
    返回:
    
    AWS单位模型
    
    另请参阅:
    
    CompanyModel
  - getDepartmentModel
```
public DepartmentModel getDepartmentModel()
```
    访问该用户的主部门模型
    
    返回:
    
    AWS部门模型
    
    另请参阅:
    
    DepartmentModel
  - getRoleModel
```
public RoleModel getRoleModel()
```
    访问该用户的主角色模型
    
    返回:
    
    AWS角色模型
    
    另请参阅:
    
    RoleModel
  - isSaaSModel
```
public boolean isSaaSModel()
```
    该账户是否为SaaS多租户
    
    返回:
    
    如果是，该组织下的所有账户均不能访问该单位外的数据和组织信息
  - getSubscribeDate
```
public java.sql.Timestamp getSubscribeDate()
```
    如果是SaaS多租户模式，返回订阅的逾期时间。该属性只支持只读，不提供set，防止被恶意赋值
    
    返回:
    
    逾期时间，超过逾期在创建Session时抛出租赁逾期的异常错误码。如果未设置返回null
  - getExtParams
```
public java.util.Map<java.lang.String,java.lang.Object> getExtParams()
```
    获得用户登录页面的开发者自定义变量/值、开发者为该session保存的临时变量/值
  - getExtParam
```
public java.lang.Object getExtParam(java.lang.String key)
```
    获得用户登录页面的开发者自定义变量值、开发者为该session保存的临时变量值
  - setExtParams
```
public void setExtParams(java.util.Map<java.lang.String,java.lang.Object> extParams)
```
    为当前session设置自定义的临时变量和值
  - setExtParam
```
public void setExtParam(java.lang.String key,
                        java.lang.Object obj)
```
    为当前session设置自定义的临时变量和值
    
    参数:
    
    key - 变量名
    
    obj - 值
  - getLookAndFeelType
```
public java.lang.String getLookAndFeelType()
```
    当前帐户的门户风格
    
    返回:
    
    门户风格Id
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 UserContext

方法概要

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

方法详细资料

fromSessionId

fromSessionId

fromSessionId

fromUID

validateSession

getSessionStart

isCreateBySDK

getSessionIp

getSessionScope

getLanguage

setLanguages

setDeviceType

isMobileClient

isTabletClient

getDeviceType

getSessionId

getInstName

setInstName

getTimeZone

getUniqueId

getUID

getUserName

getClientIP

getUserModel

getCompanyModel

getDepartmentModel

getRoleModel

isSaaSModel

getSubscribeDate

getExtParams

getExtParam

setExtParams

setExtParam

getLookAndFeelType

toString