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 org.joget.directory.model.service.DefaultDirectoryManagerPlugin abstract class.
Abstract Class
org.joget.directory.model.service.DefaultDirectoryManagerPlugin
- Under wflow-directory module
- Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
- Implemented 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
boolean authenticate(String username, String password)
Method called to authenticate a particular User against the directory
getDepartmentById
Department getDepartmentById(String departmentId)
Method called to retrieve a specific Department by Department Id
getDepartmentByName
Department getDepartmentByName(String name)
Method called to retrieve a specific Department by Department Name
getDepartmentHod
User getDepartmentHod(String departmentId)
Method called to return a specific HOD for a Department
getDepartmentList
Collection<Department> getDepartmentList()
Generic method called to retrieve all Departments within the directory
getDepartmentList
Collection<Department> getDepartmentList(String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all Departments within the directory filtered by search parameters
getDepartmentListByOrganization
Collection<Department> getDepartmentListByOrganization(String organizationId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all Departments within a specific Organization filtered by search parameters
getDepartmentsByOrganizationId
Collection<Department> getDepartmentsByOrganizationId(String filterString, String organizationId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all Departments within a specific Organization filtered by search parameters
getDepartmentsByParentId
Collection<Department> getDepartmentsByParentId(String filterString, String parentId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all sub Department within a specific Department filtered by search parameters
getDepartmentUserByGradeId
Collection<User> getDepartmentUserByGradeId(String departmentId, String gradeId)
Method called to retrieve a listing of Users which belongs to a specified Department and Grade
getParentDepartment
Department getParentDepartment(String id)
Method called to retrieve a parent Department of a Department
getParentDepartmentByName
Department getParentDepartmentByName(String name)
Method called to retrieve a parent Department of a Department by Department Name
getTotalDepartments
Long getTotalDepartments(String organizationId)
Method called to retrieve the number of Departments within the directory
getTotalDepartmentnsByOrganizationId
Long getTotalDepartmentnsByOrganizationId(String filterString, String organizationId)
Method called to retrieve the number of Departments within a specific Organization filtered by search parameters
getTotalDepartmentsByParentId
Long getTotalDepartmentsByParentId(String filterString, String parentId)
Method called to retrieve the number of sub Departments within a specific Department
getEmployment
Employment getEmployment(String id)
Method called to retrieve a specific Employment info
getEmployments
Collection<Employment> getEmployments(String filterString, String organizationId, String departmentId, String gradeId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve the users' employment info within the directory filtered by search parameters
getTotalEmployments
Long getTotalEmployments(String filterString, String organizationId, String departmentId, String gradeId)
Method called to retrieve the number of users' employment info within the directory
getGradeById
Grade getGradeById(String gradeId)
Method called to retrieve a specific Grade by Grade id
getGradeByName
Grade getGradeByName(String name)
Method called to retrieve a specific Grade by Grade Name
getGradeList
Collection<Grade> getGradeList()
Generic method called to retrieve all Grades within the directory
getGradesByOrganizationId
Collection<Grade> getGradesByOrganizationId(String filterString, String organizationId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all Grades within a specific Organization filtered by search parameters
getTotalGradesByOrganizationId
Long getTotalGradesByOrganizationId(String filterString, String organizationId)
Method called to retrieve the number of Grades within a specific Organization filtered by search parameters
getGroupById
Group getGroupById(String groupId)
Method called to retrieve a specific Group by id
getGroupByName
Group getGroupByName(String groupName)
Method called to retrieve a specific Group by name
getGroupsByUserId
Collection<Group> getGroupsByUserId(String filterString, String userId, String organizationId, Boolean inGroup, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve a collection of Group in/not in which a user belongs to and filtered by search parameters
getGroupByUsername
Collection<Group> getGroupByUsername(String username)
Method called to retrieve a collection of Group in which a user belongs to
getGroupList
Collection<Group> getGroupList()
Generic method called to retrieve the entire Group listing within the directory
getGroupList
Collection<Group> getGroupList(String nameFilter, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve the entire Group listing within the directory filtered by search parameters
getGroupsByOrganizationId
Collection<Group> getGroupsByOrganizationId(String filterString, String organizationId, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all groups within a specific Organization filtered by search parameters
getTotalGroups
Long getTotalGroups()
Method call to retrieve the number of Groups available
getTotalGroupsByOrganizationId
Long getTotalGroupsByOrganizationId(String filterString, String organizationId)
Method call to retrieve the number of Groups available within a specific Organization filtered by search parameters
getTotalGroupsByUserId
Long getTotalGroupsByUserId(String filterString, String userId, String organizationId, Boolean inGroup)
Method called to retrieve the number of Group in/not in which a user belongs to
getOrganization
Organization getOrganization(String id)
Method called to retrieve a specific Organization by Id
getOrganizationByName
Organization getOrganizationByName(String name)
Method called to retrieve a specific Organization by Name
getOrganizationsByFilter
Collection<Organization> getOrganizationsByFilter(String filterString, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve all Organizations filtered by search parameters
getTotalOrganizationsByFilter
Long getTotalOrganizationsByFilter(String filterString)
Method called to retrieve the number of Organizations
getUserByDepartmentId
Collection<User> getUserByDepartmentId(String departmentId)
Method called to retrieve a listing of Users by Department id
getUserByGradeId
Collection<User> getUserByGradeId(String gradeId)
Method called to retrieve a listing of Users by Grade id
getUserByGroupId
Collection<User> getUserByGroupId(String groupId)
Method called to retrieve a listing of Users by Group id
getUserByGroupName
Collection<User> getUserByGroupName(String groupName)
Method called to retrieve a listing of Users by Group name
getUserById
User getUserById(String userId)
Method called to retrieve a specific User by User id
getUserByOrganizationId
Collection<User> getUserByOrganizationId(String organizationId)
Method called to retrieve a listing of Users by Organization id
getUserByUsername
User getUserByUsername(String username)
Method called to retrieve a specific User by Username
getUserList
Collection<User> getUserList()
Generic method called to retrieve the entire User listing within the directory
getUserList
Collection<User> getUserList(String nameFilter, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve the entire User listing within the directory filtered by search parameters
getUsers
Collection<User> getUsers(String filterString, String organizationId, String departmentId, String gardeId, String groupId, String roleId, String active, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve the users within the directory filtered by search parameters
getTotalUsers
Long getTotalUsers()
Method called to retrieve the number of Users available
getTotalUsers
Long getTotalUsers(String filterString, String organizationId, String departmentId, String gardeId, String groupId, String roleId, String active)
Method call to retrieve the number of Users available within the directory filtered by search parametersisUserInGroup
boolean isUserInGroup(String username, String groupName)
Method called to check if a User belongs to a specific Group
getUserDepartmentUser
Collection<User> getUserDepartmentUser(String username)
Method called to retrieve a listing of Users which belongs to the same Department as the specific Username
getUserHod
Collection<User> getUserHod(String username)
Method called to retrieve a listing of HODs in which a specific User reports to
getUserSubordinate
Collection<User> getUserSubordinate(String username)
Method called to retrieve a listing of all the subordinates which reports to a specific User
getUsersSubordinate
Collection<User> getUsersSubordinate(String username, String sort, Boolean desc, Integer start, Integer rows)
Method called to retrieve a listing of all the subordinates which reports to a specific User filtered by search parameters
getTotalUsersSubordinate
Long getTotalUsersSubordinate(String username)
Method called to retrieve the number of subordinates which reports to a specific User
getUserRoles
Collection<Role> getUserRoles(String username)
Method called to retrieve the Roles belonging to a specific User by Username
Utility Methods
getDirectoryManagerImpl
public org.joget.directory.model.service.DirectoryManager getDirectoryManagerImpl(java.util.Map properties)
Used by System to retrieve a directory manager implementation