Page History

Usages

• To provide the ability to integrate users from external system. E.g. Active Directory or LDAP
• Directory Manager Plugin can be used in Settings - Directory Manager.
• A useable Directory Manager plugin must extends Directory Manager Plugin abstract class.

...

用法

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

抽象类

org.joget.directory.model.service.DefaultDirectoryManagerPlugin

• Under wflow-directory moduledirectory模块下
• Extended org继承自org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.ExtDefaultPlugin。请参考  插件基本抽象类和接口。
• 实现了orgImplemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
• A base abstract class to develop a Directory Manager Plugin

Method Detail

Abstract Methods

authenticate

• PropertyEditable。请参考  插件基本抽象类和接口。
• 开发目录管理器插件的基本抽象类

方法细节

抽象方法

authenticate 

public booleanpublic boolean authenticate(java.lang.String username, java.lang.String password)

Method called to authenticate a particular User against the directory用于根据目录对特定用户进行身份验证的方法

getDepartmentById

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

Method called to retrieve a specific Department by Department Id根据Department Id检索部门

getDepartmentByName

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

Method called to retrieve a specific Department by Department Name根据部门名称检索部门

getDepartmentHod

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

Method called to return a specific HOD for a Department根据Department Id检索部门的HOD

getDepartmentList

public javapublic java.util.Collection<orgCollection <org.joget.directory.model.Department>  getDepartmentList()

Generic method called to retrieve all Departments within the directory检索所有部门

getDepartmentList

public java.util.Collection<orgpublic 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)

Method called to retrieve all Departments within the directory filtered by search parameters检索所有部门时带上排序，分页,分页

getDepartmentListByOrganization

public javapublic java.util.Collection<orgCollection <org.joget.directory.model.Department> getDepartmentListByOrganization(javagetDepartmentListByOrganization（java.lang.String organizationId, javaorganizationId，java.lang.String sort, javasort，java.lang.Boolean desc, javadesc，java.lang.Integer start, java.lang.Integer rows)

Method called to retrieve all Departments within a specific Organization filtered by search parameters

getDepartmentsByOrganizationId

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

Method called to retrieve all Departments within a specific Organization filtered by search parameters

getDepartmentsByParentId

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

getDepartmentsByOrganizationId

public javapublic java.util.Collection<orgCollection <org.joget.directory.model.Department> getDepartmentsByParentIdgetDepartmentsByOrganizationId(java.lang.String filterString, java.lang.String parentIdorganizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

Method called to retrieve all sub Department within a specific Department filtered by search parameters

getDepartmentUserByGradeId

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

getDepartmentsByParentId

public javapublic java.util.Collection<orgCollection <org.joget.directory.model.User>Department>  getDepartmentUserByGradeIdgetDepartmentsByParentId(java.lang.String departmentIdfilterString, java.lang.String gradeId)

Method called to retrieve a listing of Users which belongs to a specified Department and Grade

getParentDepartment

 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)

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

getParentDepartment

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

Method called to retrieve a parent Department of a Department方法检索一个部门的父部门。

getParentDepartmentByName

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

Method called to retrieve a parent Department of a Department by Department Name方法调用按部门名称检索部门的父部门。

getTotalDepartments

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

Method called to retrieve the number of Departments within the directory方法检索目录中各部门的数量。

getTotalDepartmentnsByOrganizationId

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

Method called to retrieve the number of Departments within a specific Organization filtered by search parameters方法检索通过搜索参数筛选的特定组织内的部门数量。

getTotalDepartmentsByParentId

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

Method called to retrieve the number of sub Departments within a specific Department 方法检索特定部门中的子部门的数量。

getEmployment

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

Method called to retrieve a specific Employment info 方法检索特定的就业信息。

getEmployments

public javapublic java.util.Collection<orgCollection <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) rows)

方法在搜索参数筛选的目录中检索用户的Employment信息。Method called to retrieve the users' employment info within the directory filtered by search parameters

getTotalEmployments

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

Method called to retrieve the number of users' employment info within the directory调用方法来检索目录内的用户数量

getGradeById

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

Method called to retrieve a specific Grade 调用方法来检索特定的Grade by Grade idID

getGradeByName

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

调用方法来检索按名称的等级Method called to retrieve a specific Grade by Grade Name

getGradeList

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

Generic method called to retrieve all Grades within the directory通用方法调用来检索目录中的所有成绩

getGradesByOrganizationId

public javapublic java.util.Collection<orgCollection <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 startInteger开始, java.lang.Integer rows)Integer行)

调用方法来检索由搜索参数过滤的特定组织内的所有成绩Method called to retrieve all Grades within a specific Organization filtered by search parameters

getTotalGradesByOrganizationId

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

Method called to retrieve the number of Grades within a specific Organization filtered by search parameters调用方法来检索由搜索参数过滤的特定组织中的成绩数

getGroupById

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

Method called to retrieve a specific Group by id调用方法通过id检索特定的组

getGroupByName

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

Method called to retrieve a specific Group by name调用方法通过名称检索特定的组

getGroupsByUserId

public javapublic java.util.Collection<orgCollection <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)

Method called to retrieve a collection of Group in/not in which a user belongs to and filtered by search parameters调用方法来检索一个用户所属的组中的一个集合,并通过搜索参数进行过滤

getGroupByUsername

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

Method called to retrieve a collection of Group in which a user belongs to调用方法来检索用户所属的组的集合

getGroupList

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

Generic method called to retrieve the entire Group listing within the directory通用方法调用来检索目录中的整个组列表

getGroupList

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

Method called to retrieve the entire Group listing within the directory filtered by search parameters调用方法来检索由搜索参数过滤的目录中的整个组列表

getGroupsByOrganizationId

public javapublic java.util.Collection<orgCollection <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 startInteger开始, java.lang.Integer rows)Integer行)

调用方法来检索由搜索参数过滤的特定组织内的所有组Method called to retrieve all groups within a specific Organization filtered by search parameters

getTotalGroups

public javapublic java.lang.Long getTotalGroups()

Method call to retrieve the number of Groups available方法调用来检索可用的组数

getTotalGroupsByOrganizationId

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

方法调用来检索由搜索参数过滤的特定组织内可用的组的数量Method call to retrieve the number of Groups available within a specific Organization filtered by search parameters

getTotalGroupsByUserId

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

Method called to retrieve the number of Group in/not in which a user belongs to调用方法来检索用户所属的组的数量

getOrganization

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

Method called to retrieve a specific Organization by Id调用Id来检索特定组织的方法

getOrganizationByName

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

调用方法来检索名称的特定组织Method called to retrieve a specific Organization by Name

getOrganizationsByFilter

public javapublic java.util.Collection<orgCollection <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)

Method called to retrieve all Organizations filtered by search parameters调用方法来检索按搜索参数筛选的所有组织

getTotalOrganizationsByFilter

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

Method called to retrieve the number of Organizations调用方法来检索组织的数量

getUserByDepartmentId

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

Method called to retrieve a listing of Users by Department id调用方法来检索部门id的用户列表

getUserByGradeId

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

Method called to retrieve a listing of Users by Grade id调用方法来检索按级别id列出的用户

getUserByGroupId

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

Method called to retrieve a listing of Users by Group id调用方法来检索用户按组ID的列表

getUserByGroupName

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

调用方法来检索按组名称列出的用户Method called to retrieve a listing of Users by Group name

getUserById

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

Method called to retrieve a specific User by User id调用方法通过用户标识检索特定的用户

getUserByOrganizationId

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

Method called to retrieve a listing of Users by Organization id调用方法来检索组织标识的用户列表

getUserByUsername

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

Method called to retrieve a specific User by Username调用方法来检索用户名的特定用户

getUserList

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

Generic method called to retrieve the entire User listing within the directory调用通用方法来检索目录中的整个用户列表

getUserList

public javapublic java.util.Collection<orgCollection <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)

Method called to retrieve the entire User listing within the directory filtered by search parameters调用方法来检索由搜索参数过滤的目录中的整个用户列表

getUsers

public javapublic java.util.Collection<orgCollection <org.joget.directory.model.User> getUsers(java.lang.String filterString, java.lang.String organizationId, java.lang.String departmentId, java.lang.String gardeId, java.lang .Stringstring 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)

Method called to retrieve the users within the directory filtered by search parameters调用方法来检索由搜索参数过滤的目录中的用户

getTotalUsers

public javapublic java.lang.Long getTotalUsers()

Method called to retrieve the number of Users available调用方法来检索可用的用户数量

getTotalUsers

public javapublic 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) active)

方法调用来检索由搜索参数过滤的目录中可用的用户数Method call to retrieve the number of Users available within the directory filtered by search parametersisUserInGroup

isUserInGroup

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

Method called to check if a User belongs to a specific Group调用方法检查用户是否属于特定的组

getUserDepartmentUser

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

Method called to retrieve a listing of Users which belongs to the same Department as the specific Username调用方法来检索属于与特定用户名相同部门的用户列表

getUserHod

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

Method called to retrieve a listing of HODs in which a specific User reports to调用方法来检索特定用户向其报告的HOD列表

getUserSubordinate

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

Method called to retrieve a listing of all the subordinates which reports to a specific User调用方法来检索报告给特定用户的所有下属的列表

getUsersSubordinate

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

Method called to retrieve a listing of all the subordinates which reports to a specific User filtered by search parameters调用方法来检索报告给由搜索参数过滤的特定用户的所有下属的列表

getTotalUsersSubordinate

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

Method called to retrieve the number of subordinates which reports to a specific User

getUserRoles

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

GetUserRoles

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

Method called to retrieve the Roles belonging to a specific User by Username

...

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

实现方法

getDirectoryManagerImpl

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

Used by System to retrieve a directory manager implementation

...

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

接口

org.joget.directory.model.service.UserSecurityFactory

• Under wflow-directory module
• An interface that can be implement by a DirectoryManager implementation to provide a UserSecurity implementation

Method Detail

...

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

方法细节

接口方法

getUserSecurity

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

返回UserSecurity实现以提高用户安全性的方法Method to return a UserSecurity implementation to enhance the user security

org.joget.directory.model.service.UserSecurity

• Under wflow-directory module
• Interface for user security enhancement. 
• Used to extend the ability of Directory Manager Plugin when managing local user directory.
• An implementation need to return through the Directory Manager Plugin method in a Directory Manager plugin.

Method Detail

...

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

方法细节

接口方法

getPropertyOptions

public java.lang.String getPropertyOptions()

Get JSON property options to embed into the property options of Directory Manager Plugin

setProperties

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

setProperties方法

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

Set properties to use in User Security Implementation 设置属性以在用户安全实施中使用 

getProperties

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

Get properties to use in User Security Implementation 获取用户安全实施中使用的属性 

getDisableHashLogin

public java.lang.Boolean getDisableHashLogin()

Disable Hash Login?禁用哈希登录？

getAllowSessionTimeout

public java.lang.Boolean getAllowSessionTimeout()

Allow Session Timeout?允许会话超时？

getForceSessionTimeout

public java.lang.Boolean getForceSessionTimeout()

Force Session Timeout? 强制会话超时？ 

getAuthenticateAllApi

public java.lang.Boolean getAuthenticateAllApi()

Authenticate all API?验证所有API？

encryptPassword

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

Encrypt Password with custom methodology 使用自定义方法对密码进行加密 

verifyPassword

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

Verify Password with custom methodology.使用自定义方法验证密码。

passwordPolicies

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

To get a set of password policies to display in user profile form.

Collection <java.lang.String> passwordPolicies()

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

validatePassword

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

To validate password format and validity.

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

返回错误消息字符串的集合。Return Collection of error message String.

validateUserOnInsert

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

To validate user before insert to database

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

返回  错误消息字符串的集合。Return Collection of error message String.

validateUserOnUpdate

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

To validate user before updating

在更新之前验证用户

返回  错误消息字符串的集合。Return Collection of error message String.

validateUserOnProfileUpdate

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

To validate user before updating profile

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

返回  错误消息字符串的集合。Return Collection of error message String.

insertUserPostProcessing

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

Processing after a user is added.在添加用户之后进行处理。

updateUserPostProcessing

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

Processing after a user is modified.用户修改后进行处理。

updateUserProfilePostProcessing

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

Processing after a user profile is updated.用户配置文件更新后处理。

passwordResetPostProcessing

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

Processing after a user password is reset.用户密码重置后处理。

deleteUserPostProcessing

public void deleteUserPostProcessing(java.lang.String username)

Processing after a user is deleted.删除用户后进行处理。

getLoginFormFooter

public java.lang.String getLoginFormFooter()

HTML to add below login form在下面的登录表单中添加HTML

getUserCreationFormFooter

public java.lang.String getUserCreationFormFooter()

HTML to add below user creation form在用户创建表单下面添加HTML

getUserEditingFormFooter

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

HTML to add below user editing form在用户编辑表单下面添加HTML

getUserProfileFooter

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

HTML to add below user profile form在用户配置文件表单下面添加HTML

getUserDetailsButtons

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

HTML to extend user details page buttonHTML来扩展用户详细信息页面按钮

loginPreProcessing

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

Processing before user login authentication在用户登录认证之前处理

loginPostProcessing

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

Processing after user login authentication.用户登录认证后处理。

requestPostProcessing

public void requestPostProcessing()

Processing after HTTP Request Completed.HTTP请求完成后处理。

isDataExist

public boolean isDataExist(java.lang.String usernameUser)

Check whether a custom security data is exist for a user.

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• 如何开发插件

Related Community Plugins

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

插件属性选项

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

教程

• 如何开发插件

相关的社区插件

• 无法使用Not Available