AuthTool (emap_pub 1.9.54.B254 API)

java.lang.Object
- com.wisedu.emap.auth.AuthTool

```
public class AuthTool
extends Object
```
认证相关的工具。

从以下版本开始:

1.4.30

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static IUser`	`currentUser()` 获取当前的用户对象。
`static IUser`	`currentUser(boolean createGuest)` 获取当前的用户对象。
`static IUser`	`currentUser(boolean createGuest, self.micromagic.eterna.model.AppData appData)` 获取当前的用户对象。
`static String`	`currentUserId()` 获取当前的用户编号。
`static DataInfo`	`getDataInfo(DataInfo info)` 获取当前用户相关的数据信息。
`static DataInfo`	`getDataInfo(DataInfo info, IUser user)` 获取指定用户相关的数据信息。
`static IRole`	`getRole(String roleId)` 根据角色编号获取角色对象。
`static String`	`getRoleFromCampusphere(IUser user, javax.servlet.http.HttpServletRequest request)` 获取campusphere传入的角色.
`static void`	`gotoLoginPage(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)` 跳转到登录页面。
`static boolean`	`hasPermission(String path, self.micromagic.eterna.model.AppData appData)` 判断是否有访问指定地址的权限。
`static boolean`	`hasPermission(String uri, javax.servlet.http.HttpServletRequest req)` 已过时。 `hasPermission(String, AppData)`
`static boolean`	`isAdmin()` 当前登录的用户是否为管理员。
`static boolean`	`isAdmin(self.micromagic.eterna.model.AppData appData)` 当前登录的用户是否为管理员。
`static boolean`	`isValid()` 认证工具是否有效。
`static boolean`	`logout(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)` 注销。
`static void`	`setAuthContext(com.wisedu.emap.auth.IAuthContext context)`
`static void`	`updateUser(IUser user)` 更新用户信息。

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

- 方法详细资料
  - isValid
```
public static boolean isValid()
```
    认证工具是否有效。
    
    返回:
    
    boolean
  - isAdmin
```
public static boolean isAdmin()
```
    当前登录的用户是否为管理员。
    
    返回:
    
    boolean
  - isAdmin
```
public static boolean isAdmin(self.micromagic.eterna.model.AppData appData)
```
    当前登录的用户是否为管理员。
    
    参数:
    
    appData - 线程变量
    
    返回:
    
    boolean
  - currentUser
```
public static IUser currentUser()
```
    获取当前的用户对象。
    
    返回:
    
    user
  - currentUser
```
public static IUser currentUser(boolean createGuest)
```
    获取当前的用户对象。
    
    参数:
    
    createGuest - 当用户未登录时是否创建guest用户
    
    返回:
    
    user
  - currentUser
```
public static IUser currentUser(boolean createGuest,
                                self.micromagic.eterna.model.AppData appData)
```
    获取当前的用户对象。
    
    参数:
    
    createGuest - 当用户未登录时是否创建guest用户
    
    appData - 线程变量
    
    返回:
    
    boolean
  - currentUserId
```
public static String currentUserId()
```
    获取当前的用户编号。
    
    返回:
    
    string
  - getRoleFromCampusphere
```
public static String getRoleFromCampusphere(IUser user,
                                            javax.servlet.http.HttpServletRequest request)
```
    获取campusphere传入的角色.
    
    参数:
    
    user - 用户
    
    request - 请求对象
    
    返回:
    
    string
    
    从以下版本开始:
    
    1.7.68.B68
  - hasPermission
```
@Deprecated
public static boolean hasPermission(String uri,
                                                 javax.servlet.http.HttpServletRequest req)
```
    已过时。 hasPermission(String, AppData)
    
    判断是否有访问指定地址的权限。
    
    参数:
    
    uri - 路径
    
    req - 请求对象
    
    返回:
    
    boolean
  - hasPermission
```
public static boolean hasPermission(String path,
                                    self.micromagic.eterna.model.AppData appData)
```
    判断是否有访问指定地址的权限。
    
    参数:
    
    path - 需要访问的地址，只需要上下文根之后的路径
    
    appData - 上下文环境对象
    
    返回:
    
    boolean
    
    从以下版本开始:
    
    1.8.60.B136
    
    另请参阅:
    
    AppData.getCurrentData()
  - getDataInfo
```
public static DataInfo getDataInfo(DataInfo info)
```
    获取当前用户相关的数据信息。
    
    参数:
    
    info - key
    
    返回:
    
    info
  - getDataInfo
```
public static DataInfo getDataInfo(DataInfo info,
                                   IUser user)
```
    获取指定用户相关的数据信息。
    
    参数:
    
    info - key
    
    user - 用户
    
    返回:
    
    info
    
    从以下版本开始:
    
    1.8.8.B84
  - getRole
```
public static IRole getRole(String roleId)
```
    根据角色编号获取角色对象。
    
    参数:
    
    roleId - 角色编号
    
    返回:
    
    角色编号对应的角色对象, 如果没有对应的角色则返回null
    
    从以下版本开始:
    
    1.6.46
  - gotoLoginPage
```
public static void gotoLoginPage(javax.servlet.http.HttpServletRequest req,
                                 javax.servlet.http.HttpServletResponse resp)
                          throws javax.servlet.ServletException,
                                 IOException
```
    跳转到登录页面。
    
    参数:
    
    req - request
    
    resp - response
    
    抛出:
    
    IOException - err
    
    javax.servlet.ServletException - err
  - logout
```
public static boolean logout(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)
                      throws javax.servlet.ServletException,
                             IOException
```
    注销。
    
    参数:
    
    req - request
    
    resp - response
    
    返回:
    
    boolean
    
    抛出:
    
    IOException - err
    
    javax.servlet.ServletException - err
  - updateUser
```
public static void updateUser(IUser user)
```
    更新用户信息。
    将更新过的用户信息保存下来。
    
    参数:
    
    user - 用户
  - setAuthContext
```
public static void setAuthContext(com.wisedu.emap.auth.IAuthContext context)
```

类 AuthTool

方法概要

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

方法详细资料

isValid

isAdmin

isAdmin

currentUser

currentUser

currentUser

currentUserId

getRoleFromCampusphere

hasPermission

hasPermission

getDataInfo

getDataInfo

getRole

gotoLoginPage

logout

updateUser

setAuthContext