com.helger.photon.basic.security

Interface IAccessManager

All Superinterfaces:

IRoleManager, IUserGroupManager, IUserManager

All Known Implementing Classes:

AccessManager

public interface IAccessManager
extends IUserManager, IUserGroupManager, IRoleManager

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAllUserRoleIDs(String sUserID) Get all role IDs the current user has
Set<IRole>	getAllUserRoles(String sUserID) Get all roles the current user has
boolean	hasUserRole(String sUserID, String sRoleID) Check if the passed user ID has the passed role by checking all user group role assignments of the user.

Methods inherited from interface com.helger.photon.basic.security.user.IUserManager

areUserIDAndPasswordValid, containsUserWithID, createNewUser, createPredefinedUser, deleteUser, disableUser, enableUser, getAllActiveUsers, getAllDeletedUsers, getAllDisabledUsers, getAllNotDeletedUsers, getAllUsers, getUserModificationCallbacks, getUserOfEmailAddress, getUserOfID, getUserOfLoginName, setUserData, setUserPassword, undeleteUser

Methods inherited from interface com.helger.photon.basic.security.usergroup.IUserGroupManager

assignRoleToUserGroup, assignUserToUserGroup, containsAllUserGroupsWithID, containsUserGroupWithID, createNewUserGroup, createPredefinedUserGroup, deleteUserGroup, getAllUserGroupIDsWithAssignedRole, getAllUserGroupIDsWithAssignedUser, getAllUserGroups, getAllUserGroupsWithAssignedRole, getAllUserGroupsWithAssignedUser, getUserGroupModificationCallbacks, getUserGroupOfID, isUserAssignedToUserGroup, renameUserGroup, setUserGroupData, unassignRoleFromAllUserGroups, unassignRoleFromUserGroup, unassignUserFromAllUserGroups, unassignUserFromUserGroup

Methods inherited from interface com.helger.photon.basic.security.role.IRoleManager

containsAllRolesWithID, containsRoleWithID, createNewRole, createPredefinedRole, deleteRole, getAllRoles, getRoleModificationCallbacks, getRoleOfID, renameRole, setRoleData

Method Detail

hasUserRole

boolean hasUserRole(@Nullable
                  String sUserID,
                  @Nullable
                  String sRoleID)

Check if the passed user ID has the passed role by checking all user group role assignments of the user.

Parameters:

sUserID - User ID to check

sRoleID - Role ID to check

Returns:

true if the user is in at least one user group that has the assigned role, false otherwise

getAllUserRoleIDs

@Nonnull
@ReturnsMutableCopy
Set<String> getAllUserRoleIDs(@Nullable
                                                       String sUserID)

Get all role IDs the current user has

Parameters:

sUserID - User ID to check

Returns:

Never null.

getAllUserRoles

@Nonnull
@ReturnsMutableCopy
Set<IRole> getAllUserRoles(@Nullable
                                                    String sUserID)

Get all roles the current user has

Parameters:

sUserID - User ID to check

Returns:

Never null.