SecUserService (Bropen Framework 4.8.1 API)

bropen.framework.core.SecUserService

Field Summary

Fields
Modifiers	Name	Description
`static Object`	`aliasOverridingOrder`

Properties Summary

Properties
Type	Name and description
`AttachmentService`	`attachmentService`
`AuditlogService`	`auditlogService`
`SettingService`	`settingService`
`grails.plugin.springsecurity.SpringSecurityService`	`springSecurityService`

Methods Summary

Methods
Type	Name and description
`void`	`bootStrapInit()`
`Object`	`canDelete(User user, Object canDelEmployee = true)` 检查用户能否被直接删除
`Object`	`delete(User user)` 删除用户
`void`	`deleteAvatar(User user)` 删除头像
`void`	`deleteSignature(User user)` 删除签名
`String`	`encodePassword(String password)` 用户密码加密，以便保存到数据库中
`User`	`getCurrentUser()` 获得当前登录的、只读的用户对象
`Long`	`getCurrentUserId()` 获得当前登录的用户ID
`String`	`getCurrentUsername()` 获得当前登录的用户登录名
`Boolean`	`isPasswordValid(String encPass, String password)` 验证用户输入的密码是否和数据库中保存的密码一致
`Object`	`preDelete(User user)` 删除用户前的一些操作，如修改用户名以免重复、禁用用户、删除角色关联等
`void`	`renderAvatar(javax.servlet.http.HttpServletResponse response, User user, Map options = null)` 渲染员工头像图片，如果没有头像，则渲染默认头像（portal/avatar.png）
`StringBuilder`	`renderAvatar(User user, Map options = null)` 渲染员工头像图片为 `data:image/png;base64,XXX` 字符串
`void`	`renderSignature(javax.servlet.http.HttpServletResponse response, User user, Map options = null)` 渲染员工签名图片，如果没有签名，则生成默认图片
`Object`	`save(Employee emp)` 保存新员工或修改员工时，修改对应的用户信息
`Object`	`save(User user, Map params)` 创建新用户
`Object`	`update(User user, Map params)` 修改用户
`boolean`	`updatePassword(User user, String oldpassword, String newpassword, String newpassword2 = null)` 修改密码
`bropen.toolkit.api.Response`	`uploadAvatar(javax.servlet.http.HttpServletRequest request, User user)` 上传头像
`bropen.toolkit.api.Response`	`uploadSignature(javax.servlet.http.HttpServletRequest request, User user)` 上传签名
`Object`	`validate(User user)` 保存/更新用户时，校验用户对象是否合法
`Boolean`	`validatePassword(User user, String newpassword, Map options = null)` 修改密码时，校验用户密码是否满足密码策略（如长度、复杂度等等）
`String`	`validatePassword(String password)` 校验密码长度、复杂度等

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`Object#wait(long, int), Object#wait(long), Object#wait(), Object#equals(Object), Object#toString(), Object#hashCode(), Object#getClass(), Object#notify(), Object#notifyAll()`

- Field Detail
  - public static Object aliasOverridingOrder
- Property Detail
  - AttachmentService attachmentService
  - AuditlogService auditlogService
  - SettingService settingService
  - grails.plugin.springsecurity.SpringSecurityService springSecurityService
- Method Detail
  - void bootStrapInit()
  - Object canDelete(User user, Object canDelEmployee = true)
    
    检查用户能否被直接删除
    
    Returns:
    true/false
    Parameters:
    user
    canDelEmployee - 是否同时删除员工
  - Object delete(User user)
    
    删除用户
    
    Returns:
    true/false，可以通过bean.hasErrors获得错误消息
    Parameters:
    user
  - void deleteAvatar(User user)
    
    删除头像
  - void deleteSignature(User user)
    
    删除签名
  - @NotTransactional@grails.transaction.NotTransactional String encodePassword(String password)
    
    用户密码加密，以便保存到数据库中
  - @NotTransactional@grails.transaction.NotTransactional User getCurrentUser()
    
    获得当前登录的、只读的用户对象
  - @NotTransactional@grails.transaction.NotTransactional Long getCurrentUserId()
    
    获得当前登录的用户ID
  - @NotTransactional@grails.transaction.NotTransactional String getCurrentUsername()
    
    获得当前登录的用户登录名
  - @NotTransactional@grails.transaction.NotTransactional Boolean isPasswordValid(String encPass, String password)
    
    验证用户输入的密码是否和数据库中保存的密码一致
    Parameters:
    encPass - 保存在数据库中的加密密码
    password - 需要验证的密码明文
  - @Internal@bropen.toolkit.annotation.Internal Object preDelete(User user)
    
    删除用户前的一些操作，如修改用户名以免重复、禁用用户、删除角色关联等
  - void renderAvatar(javax.servlet.http.HttpServletResponse response, User user, Map options = null)
    
    渲染员工头像图片，如果没有头像，则渲染默认头像（portal/avatar.png）
    Parameters:
    options.size - 图片缩放大小，格式为 lg/md/sm/x*y，分别表示大小为 184、100、50 或指定大小（如150*150）的图片；默认为 md。
    options.cacheArgs
  - StringBuilder renderAvatar(User user, Map options = null)
    
    渲染员工头像图片为 data:image/png;base64,XXX 字符串
    Parameters:
    options.size - 图片缩放大小，格式为 lg/md/sm/x*y，分别表示大小为 184、100、50 或指定大小（如150*150）的图片；默认为 md。
    options.cacheArgs
  - void renderSignature(javax.servlet.http.HttpServletResponse response, User user, Map options = null)
    
    渲染员工签名图片，如果没有签名，则生成默认图片
    
    Parameters:
    response - HttpServletResponse
    user - 用户对象
    options.size - 图片缩放大小，格式为 lg/md/sm/x*y，分别表示大小为 184、100、50 或指定大小（如150*150）的图片
    options.confusing - 是否混淆图片，避免被拷贝
    options.cacheArgs - 浏览器缓存参数，参考 http://grails.org/plugin/cache-headers
  - Object save(Employee emp)
    
    保存新员工或修改员工时，修改对应的用户信息
  - Object save(User user, Map params)
    
    创建新用户
    
    Returns:
    true/false，可以通过bean.hasErrors获得错误消息
    Parameters:
    user - 一个空的bean对象
    params - 创建用户所需的数据
  - Object update(User user, Map params)
    
    修改用户
    
    Returns:
    true/false，可以通过bean.hasErrors获得错误消息
    Parameters:
    user - 更新前的bean
    params - 需要更新的数据
  - boolean updatePassword(User user, String oldpassword, String newpassword, String newpassword2 = null)
    
    修改密码
  - bropen.toolkit.api.Response uploadAvatar(javax.servlet.http.HttpServletRequest request, User user)
    
    上传头像
    
    Parameters:
    request - 如果包含裁剪数据参数 imageData（[x: , y:, w: , h:]）则保存时自动裁剪
  - bropen.toolkit.api.Response uploadSignature(javax.servlet.http.HttpServletRequest request, User user)
    
    上传签名
  - Object validate(User user)
    
    保存/更新用户时，校验用户对象是否合法
  - Boolean validatePassword(User user, String newpassword, Map options = null)
    
    修改密码时，校验用户密码是否满足密码策略（如长度、复杂度等等）
    Parameters:
    user - 用户对象，如果为空，则仅校验长度、复杂度
    options.errors - 如果不满足策略要求，是否在 user.errors 中设置验证错误，默认为真
    options.history - 是否校验重复的历史密码，默认为真
  - String validatePassword(String password)
    
    校验密码长度、复杂度等
    Returns:
    校验失败的消息，如果校验成功则返回 null

| Detail:
Field
Property
Constructor
Method

BROPEN Documentation, 2020-04-21 11:00

[Groovy] Class SecUserService

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static Object aliasOverridingOrder

Property Detail

AttachmentService attachmentService

AuditlogService auditlogService

SettingService settingService

grails.plugin.springsecurity.SpringSecurityService springSecurityService

Method Detail

void bootStrapInit()

Object canDelete(User user, Object canDelEmployee = true)

Object delete(User user)

void deleteAvatar(User user)

void deleteSignature(User user)

@NotTransactional@grails.transaction.NotTransactional String encodePassword(String password)

@NotTransactional@grails.transaction.NotTransactional User getCurrentUser()

@NotTransactional@grails.transaction.NotTransactional Long getCurrentUserId()

@NotTransactional@grails.transaction.NotTransactional String getCurrentUsername()

@NotTransactional@grails.transaction.NotTransactional Boolean isPasswordValid(String encPass, String password)

@Internal@bropen.toolkit.annotation.Internal Object preDelete(User user)

void renderAvatar(javax.servlet.http.HttpServletResponse response, User user, Map options = null)

StringBuilder renderAvatar(User user, Map options = null)

void renderSignature(javax.servlet.http.HttpServletResponse response, User user, Map options = null)

Object save(Employee emp)

Object save(User user, Map params)

Object update(User user, Map params)

boolean updatePassword(User user, String oldpassword, String newpassword, String newpassword2 = null)

bropen.toolkit.api.Response uploadAvatar(javax.servlet.http.HttpServletRequest request, User user)

bropen.toolkit.api.Response uploadSignature(javax.servlet.http.HttpServletRequest request, User user)

Object validate(User user)

Boolean validatePassword(User user, String newpassword, Map options = null)

String validatePassword(String password)