目录管理插件

用法

提供从外部系统集成用户的能力。例如活动目录或LDAP
目录管理器插件可用于设置 - 目录管理器。
一个可用的目录管理器插件必须延伸org.joget.directory.model.service.DefaultDirectoryManagerPlugin抽象类。

抽象类

org.joget.directory.model.service.DefaultDirectoryManagerPlugin

wflow-directory模块下
继承自org.joget.plugin.base.ExtDefaultPlugin。请参考插件基本抽象类和接口。
实现了org.joget.plugin.property.model.PropertyEditable。请参考插件基本抽象类和接口。
开发目录管理器插件的基本抽象类

方法细节

抽象方法

认证

公共布尔authenticate（java.lang.String用户名，java.lang.String密码）(java.lang.String username, java.lang.String password)

用于根据目录对特定用户进行身份验证的方法

getDepartmentById

public org.joget.directory.model.Department getDepartmentById（java.lang.String departmentId）(java.lang.String departmentId)

根据Department Id检索部门

getDepartmentByName

public org.joget.directory.model.Department getDepartmentByName（java.lang.String name）(java.lang.String name)

根据部门名称检索部门

getDepartmentHod

public org.joget.directory.model.User getDepartmentHod（java.lang.String departmentId）(java.lang.String departmentId)

根据Department Id检索部门的HOD

getDepartmentList

public java.util.Collection <org.joget.directory.model.Department> getDepartmentList（）<org.joget.directory.model.Department> getDepartmentList()

检索所有部门

getDepartmentList

public java.util.Collection <org.joget.directory.model.Department> getDepartmentList（java.lang.String sort，java.lang.Boolean desc，java.lang.Integer start，java.lang.Integer rows）<org.joget.directory.model.Department> getDepartmentList(java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

检索所有部门时带上排序，分页,分页

getDepartmentListByOrganization

public java.util.Collection <org.joget.directory.model.Department> getDepartmentListByOrganization（java.lang.String organizationId，java.lang.String sort，java.lang.Boolean desc，java.lang.Integer start，java.lang 。整数行）<org.joget.directory.model.Department> getDepartmentListByOrganization(java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

检索由搜索参数过滤的特定组织内的所有部门。

getDepartmentsByOrganizationId

public java.util.Collection <org.joget.directory.model.Department> getDepartmentsByOrganizationId（java.lang.String filterString，java.lang.String organizationId，java.lang.String sort，java.lang.Boolean desc，java.lang .Integer开始，java.lang.Integer行）<org.joget.directory.model.Department> getDepartmentsByOrganizationId(java.lang.String filterString, java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

检索由搜索参数过滤的特定组织内的所有部门。

getDepartmentsByParentId

public java.util.Collection <org.joget.directory.model.Department> getDepartmentsByParentId（java.lang.String filterString，java.lang.String parentId，java.lang.String sort，java.lang.Boolean desc，java.lang .Integer开始，java.lang.Integer行）<org.joget.directory.model.Department> getDepartmentsByParentId(java.lang.String filterString, java.lang.String parentId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

方法通过搜索参数检索特定部门内的所有子部门。

getDepartmentUserByGradeId

public java.util.Collection <org.joget.directory.model.User> getDepartmentUserByGradeId（java.lang.String departmentId，java.lang.String gradeId）<org.joget.directory.model.User> getDepartmentUserByGradeId(java.lang.String departmentId, java.lang.String gradeId)

方法检索属于指定部门和级别的用户列表。

getParentDepartment

public org.joget.directory.model.Department getParentDepartment(java.lang.String id)

方法检索一个部门的父部门。

getParentDepartmentByName

public org.joget.directory.model.Department getParentDepartmentByName(java.lang.String name)

方法调用按部门名称检索部门的父部门。

getTotalDepartments

public java.lang.Long getTotalDepartments(java.lang.String organizationId)

方法检索目录中各部门的数量。

getTotalDepartmentnsByOrganizationId

public java.lang.Long getTotalDepartmentnsByOrganizationId(java.lang.String filterString,java.lang.String organizationId)

方法检索通过搜索参数筛选的特定组织内的部门数量。

getTotalDepartmentsByParentId

public java.lang.Long getTotalDepartmentsByParentId(java.lang.String filterString,java.lang.String parentId)

方法检索特定部门中的子部门的数量。

getEmployment

public org.joget.directory.model.Employment getEmployment(java.lang.String id)

方法检索特定的就业信息。

getEmployments

public java.util.Collection <org.joget.directory.model.Employment> getEmployments(java.lang.String filterString,java.lang.String organizationId,java.lang.String departmentId,java.lang.String gradeId,java.lang .String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang.Integer rows)

方法在搜索参数筛选的目录中检索用户的Employment信息。

getTotalEmployments

public java.lang.Long getTotalEmployments(java.lang.String filterString,java.lang.String organizationId,java.lang.String departmentId,java.lang.String gradeId)

调用方法来检索目录内的用户数量

getGradeById

public org.joget.directory.model.Grade getGradeById(java.lang.String gradeId)

调用方法来检索特定的Grade by Grade ID

getGradeByName

public org.joget.directory.model.Grade getGradeByName(java.lang.String name)

调用方法来检索按名称的等级

getGradeList

public java.util.Collection <org.joget.directory.model.Grade> getGradeList()

通用方法调用来检索目录中的所有成绩

getGradesByOrganizationId

public java.util.Collection <org.joget.directory.model.Grade> getGradesByOrganizationId(java.lang.String filterString,java.lang.String organizationId,java.lang.String sort,java.lang.Boolean desc,java.lang .Integer开始,java.lang.Integer行)

调用方法来检索由搜索参数过滤的特定组织内的所有成绩

getTotalGradesByOrganizationId

public java.lang.Long getTotalGradesByOrganizationId(java.lang.String filterString,java.lang.String organizationId)

调用方法来检索由搜索参数过滤的特定组织中的成绩数

getGroupById

public org.joget.directory.model.Group getGroupById(java.lang.String groupId)

调用方法通过id检索特定的组

getGroupByName

public org.joget.directory.model.Group getGroupByName(java.lang.String groupName)

调用方法通过名称检索特定的组

getGroupsByUserId

public java.util.Collection <org.joget.directory.model.Group> getGroupsByUserId(java.lang.String filterString,java.lang.String userId,java.lang.String organizationId,java.lang.Boolean inGroup,java.lang .String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang.Integer rows)

调用方法来检索一个用户所属的组中的一个集合,并通过搜索参数进行过滤

getGroupByUsername

public java.util.Collection <org.joget.directory.model.Group> getGroupByUsername(java.lang.String username)

调用方法来检索用户所属的组的集合

getGroupList

public java.util.Collection <org.joget.directory.model.Group> getGroupList()

通用方法调用来检索目录中的整个组列表

getGroupList

public java.util.Collection <org.joget.directory.model.Group> getGroupList(java.lang.String nameFilter,java.lang.String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang 。整数行)

调用方法来检索由搜索参数过滤的目录中的整个组列表

getGroupsByOrganizationId

public java.util.Collection <org.joget.directory.model.Group> getGroupsByOrganizationId(java.lang.String filterString,java.lang.String organizationId,java.lang.String sort,java.lang.Boolean desc,java.lang .Integer开始,java.lang.Integer行)

调用方法来检索由搜索参数过滤的特定组织内的所有组

getTotalGroups

public java.lang.Long getTotalGroups()

方法调用来检索可用的组数

getTotalGroupsByOrganizationId

public java.lang.Long getTotalGroupsByOrganizationId(java.lang.String filterString,java.lang.String organizationId)

方法调用来检索由搜索参数过滤的特定组织内可用的组的数量

getTotalGroupsByUserId

public java.lang.Long getTotalGroupsByUserId(java.lang.String filterString,java.lang.String userId,java.lang.String organizationId,java.lang.Boolean inGroup)

调用方法来检索用户所属的组的数量

getOrganization

public org.joget.directory.model.Organization getOrganization(java.lang.String id)

调用Id来检索特定组织的方法

getOrganizationByName

public org.joget.directory.model.Organization getOrganizationByName(String name)

调用方法来检索名称的特定组织

getOrganizationsByFilter

public java.util.Collection <org.joget.directory.model.Organization> getOrganizationsByFilter(java.lang.String filterString,java.lang.String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang.Integer rows)

调用方法来检索按搜索参数筛选的所有组织

getTotalOrganizationsByFilter

public java.lang.Long getTotalOrganizationsByFilter(java.lang.String filterString)

调用方法来检索组织的数量

getUserByDepartmentId

public java.util.Collection <org.joget.directory.model.User> getUserByDepartmentId(java.lang.String departmentId)

调用方法来检索部门id的用户列表

getUserByGradeId

public java.util.Collection <org.joget.directory.model.User> getUserByGradeId(java.lang.String gradeId)

调用方法来检索按级别id列出的用户

getUserByGroupId

public java.util.Collection <org.joget.directory.model.User> getUserByGroupId(java.lang.String groupId)

调用方法来检索用户按组ID的列表

getUserByGroupName

public java.util.Collection <org.joget.directory.model.User> getUserByGroupName(java.lang.String groupName)

调用方法来检索按组名称列出的用户

getUserById

public org.joget.directory.model.User getUserById(java.lang.String userId)

调用方法通过用户标识检索特定的用户

getUserByOrganizationId

public java.util.Collection <org.joget.directory.model.User> getUserByOrganizationId(java.lang.String organizationId)

调用方法来检索组织标识的用户列表

getUserByUsername

public org.joget.directory.model.User getUserByUsername(java.lang.String username)

调用方法来检索用户名的特定用户

getUserList

public java.util.Collection <org.joget.directory.model.User> getUserList()

调用通用方法来检索目录中的整个用户列表

getUserList

public java.util.Collection <org.joget.directory.model.User> getUserList(java.lang.String nameFilter,java.lang.String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang.Integer rows)

调用方法来检索由搜索参数过滤的目录中的整个用户列表

getUsers

public java.util.Collection <org.joget.directory.model.User> getUsers(java.lang.String filterString,java.lang.String organizationId,java.lang.String departmentId,java.lang.String gardeId,java.lang .string groupId,java.lang.String roleId,java.lang.String active,java.lang.String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang.Integer rows)

调用方法来检索由搜索参数过滤的目录中的用户

getTotalUsers

public java.lang.Long getTotalUsers()

调用方法来检索可用的用户数量

getTotalUsers

public java.lang.Long getTotalUsers(java.lang.String filterString,java.lang.String organizationId,java.lang.String departmentId,java.lang.String gardeId,java.lang.String groupId,java.lang.String roleId, java.lang.String active)

方法调用来检索由搜索参数过滤的目录中可用的用户数

isUserInGroup

public boolean isUserInGroup(java.lang.String username,java.lang.String groupName)

调用方法检查用户是否属于特定的组

getUserDepartmentUser

public java.util.Collection <org.joget.directory.model.User> getUserDepartmentUser(java.lang.String username)

调用方法来检索属于与特定用户名相同部门的用户列表

getUserHod

public java.util.Collection <org.joget.directory.model.User> getUserHod(java.lang.String username)

调用方法来检索特定用户向其报告的HOD列表

getUserSubordinate

public java.util.Collection <org.joget.directory.model.User> getUserSubordinate(java.lang.String username)

调用方法来检索报告给特定用户的所有下属的列表

getUsersSubordinate

public java.util.Collection <org.joget.directory.model.User> getUsersSubordinate(java.lang.String username,java.lang.String sort,java.lang.Boolean desc,java.lang.Integer start,java.lang 。整数行)

调用方法来检索报告给由搜索参数过滤的特定用户的所有下属的列表

getTotalUsersSubordinate

public java.lang.Long getTotalUsersSubordinate(java.lang.String username)

调用方法来检索报告给特定用户的下属的数量

GetUserRoles

public java.util.Collection <org.joget.directory.model.Role> getUserRoles(java.lang.String username)

调用方法来检索用户名属于特定用户的角色

实现方法

getDirectoryManagerImpl

public org.joget.directory.model.service.DirectoryManager getDirectoryManagerImpl(java.util.MapProperties)

系统用于检索目录管理器实现

接口

org.joget.directory.model.service.UserSecurityFactory

在wflow目录模块下
一个可由DirectoryManager实现实现的接口,用于提供UserSecurity实现

方法细节

接口方法

getUserSecurity

public org.joget.directory.model.service.UserSecurity getUserSecurity()

返回UserSecurity实现以提高用户安全性的方法

org.joget.directory.model.service.UserSecurity

在wflow目录模块下
用户安全增强接口。
用于在管理本地用户目录时扩展Directory Manager Plugin的功能。
实现需要通过Directory Manager插件中的getUserSecurity方法返回。

方法细节

接口方法

getPropertyOptions

public java.lang.String getPropertyOptions()

获取JSON属性选项以嵌入到Directory Manager插件的属性选项中

setProperties方法

public void setProperties(java.util.Map <java.lang.String,java.lang.Object> properties)

设置属性以在用户安全实施中使用

的GetProperties

public java.util.Map <java.lang.String,java.lang.Object> getProperties()

获取用户安全实施中使用的属性

getDisableHashLogin

public java.lang.Boolean getDisableHashLogin()

禁用哈希登录？

getAllowSessionTimeout

public java.lang.Boolean getAllowSessionTimeout()

允许会话超时？

getForceSessionTimeout

public java.lang.Boolean getForceSessionTimeout()

强制会话超时？

getAuthenticateAllApi

public java.lang.Boolean getAuthenticateAllApi()

验证所有API？

encryptPassword

public java.lang.String encryptPassword(java.lang.String username,java.lang.String password)

使用自定义方法对密码进行加密

验证密码

public java.lang.Boolean verifyPassword(org.joget.directory.model.User user,java.lang.String password)

使用自定义方法验证密码。

passwordPolicies

public java.util.Collection <java.lang.String> passwordPolicies()

获取一组密码策略以用户配置文件的形式显示。

validatePassword

public java.util.Collection <java.lang.String> validatePassword(java.lang.String username,java.lang.String oldPassword,java.lang.String newPassword,java.lang.String confirmPassword)

验证密码的格式和有效性。

返回错误消息字符串的集合。

validateUserOnInsert

public java.util.Collection <java.lang.String> validateUserOnInsert(org.joget.directory.model.User user)

在插入数据库之前验证用户

返回错误消息字符串的集合。

validateUserOnUpdate

public java.util.Collection <java.lang.String> validateUserOnUpdate(org.joget.directory.model.User user)

在更新之前验证用户

返回错误消息字符串的集合。

validateUserOnProfileUpdate

public java.util.Collection <java.lang.String> validateUserOnProfileUpdate(org.joget.directory.model.User user)

在更新配置文件之前验证用户

返回错误消息字符串的集合。

insertUserPostProcessing

public void insertUserPostProcessing(org.joget.directory.model.User user)

在添加用户之后进行处理。

updateUserPostProcessing

public void updateUserPostProcessing(org.joget.directory.model.User user)

用户修改后进行处理。

updateUserProfilePostProcessing

public void updateUserProfilePostProcessing(org.joget.directory.model.User user)

用户配置文件更新后处理。

passwordResetPostProcessing

public void passwordResetPostProcessing(org.joget.directory.model.User user)

用户密码重置后处理。

deleteUserPostProcessing

public void deleteUserPostProcessing(java.lang.String username)

删除用户后进行处理。

getLoginFormFooter

public java.lang.String getLoginFormFooter()

在下面的登录表单中添加HTML

getUserCreationFormFooter

public java.lang.String getUserCreationFormFooter()

在用户创建表单下面添加HTML

getUserEditingFormFooter

public java.lang.String getUserEditingFormFooter(org.joget.directory.model.User user)

在用户编辑表单下面添加HTML

getUserProfileFooter

public java.lang.String getUserProfileFooter(org.joget.directory.model.User user)

在用户配置文件表单下面添加HTML

getUserDetailsButtons

public java.lang.String getUserDetailsButtons(org.joget.directory.model.User user)

HTML来扩展用户详细信息页面按钮

loginPreProcessing

public void loginPreProcessing(org.joget.directory.model.User user,java.lang.String password)

在用户登录认证之前处理

loginPostProcessing

public void loginPostProcessing(org.joget.directory.model.User user,java.lang.String password,java.lang.Boolean loggedIn)

用户登录认证后处理。

requestPostProcessing

public void requestPostProcessing()

HTTP请求完成后处理。

isDataExist

public boolean isDataExist(java.lang.String User)

检查用户是否存在自定义安全数据。

插件属性选项

请参阅插件属性选项以获取更多信息。

教程

如何开发插件

Page tree

目录管理插件

用法

抽象类

org.joget.directory.model.service.DefaultDirectoryManagerPlugin

方法细节

抽象方法

认证

getDepartmentById

getDepartmentByName

getDepartmentHod

getDepartmentList

getDepartmentList

getDepartmentListByOrganization

getDepartmentsByOrganizationId

getDepartmentsByParentId

getDepartmentUserByGradeId

getParentDepartment

getParentDepartmentByName

getTotalDepartments

getTotalDepartmentnsByOrganizationId

getTotalDepartmentsByParentId

getEmployment

getEmployments

getTotalEmployments

getGradeById

getGradeByName

getGradeList

getGradesByOrganizationId

getTotalGradesByOrganizationId

getGroupById

getGroupByName

getGroupsByUserId

getGroupByUsername

getGroupList

getGroupList

getGroupsByOrganizationId

getTotalGroups

getTotalGroupsByOrganizationId

getTotalGroupsByUserId

getOrganization

getOrganizationByName

getOrganizationsByFilter

getTotalOrganizationsByFilter

getUserByDepartmentId

getUserByGradeId

getUserByGroupId

getUserByGroupName

getUserById

getUserByOrganizationId

getUserByUsername

getUserList

getUserList

getUsers

getTotalUsers

getTotalUsers

isUserInGroup

getUserDepartmentUser

getUserHod

getUserSubordinate

getUsersSubordinate

getTotalUsersSubordinate

GetUserRoles

实现方法

getDirectoryManagerImpl

接口

org.joget.directory.model.service.UserSecurityFactory

方法细节

接口方法

getUserSecurity

org.joget.directory.model.service.UserSecurity

方法细节

接口方法

getPropertyOptions

setProperties方法

的GetProperties

getDisableHashLogin

getAllowSessionTimeout

getForceSessionTimeout

getAuthenticateAllApi