com.helger.photon.basic.security

Class AccessManager

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.GlobalSingleton

com.helger.photon.basic.security.AccessManager

All Implemented Interfaces:

com.helger.commons.scopes.IScopeDestructionAware, IAccessManager, IRoleManager, IUserManager, IUserGroupManager

@ThreadSafe
public final class AccessManager
extends com.helger.commons.scopes.singleton.GlobalSingleton
implements IAccessManager

This is the central manager that encapsulates all security manages. This class is thread-safe under the assumption that the implementing managers are thread-safe.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BASE_PATH
static String	FILENAME_ROLES_XML
static String	FILENAME_USERGROUPS_XML
static String	FILENAME_USERS_XML

Constructor Summary

Constructors

Constructor and Description
AccessManager() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areUserIDAndPasswordValid(String sUserID, String sPlainTextPassword) Check if the passed combination of user ID and password matches.
boolean	areUserLoginNameAndPasswordValid(String sLoginName, String sPlainTextPassword) Check if the passed combination of login name and plain text password are valid
com.helger.commons.state.EChange	assignRoleToUserGroup(String sUserGroupID, String sRoleID) Assign the passed role ID to the user group with the passed ID.
com.helger.commons.state.EChange	assignUserToUserGroup(String sUserGroupID, String sUserID) Assign the passed user ID to the passed user group.
boolean	containsAllRolesWithID(Collection<String> aRoleIDs) Check if all passed role IDs are contained
boolean	containsAllUserGroupsWithID(Collection<String> aUserGroupIDs) Check if all passed user group IDs are contained
boolean	containsRoleWithID(String sRoleID) Check if the role with the specified ID is contained
boolean	containsUserGroupWithID(String sUserGroupID) Check if a user group with the specified ID is contained
boolean	containsUserWithID(String sUserID) Check if a user with the specified ID is present.
IRole	createNewRole(String sName, String sDescription, Map<String,?> aCustomAttrs) Create a new role.
IUser	createNewUser(String sLoginName, String sEmailAddress, String sPlainTextPassword, String sFirstName, String sLastName, String sDescription, Locale aDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Create a new user.
IUserGroup	createNewUserGroup(String sName, String sDescription, Map<String,?> aCustomAttrs) Create a new user group.
IRole	createPredefinedRole(String sID, String sName, String sDescription, Map<String,?> aCustomAttrs) Create a predefined role.
IUser	createPredefinedUser(String sID, String sLoginName, String sEmailAddress, String sPlainTextPassword, String sFirstName, String sLastName, String sDescription, Locale aDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Create a predefined user.
IUserGroup	createPredefinedUserGroup(String sID, String sName, String sDescription, Map<String,?> aCustomAttrs) Create a predefined user group.
com.helger.commons.state.EChange	deleteRole(String sRoleID) Delete the role with the passed ID
com.helger.commons.state.EChange	deleteUser(String sUserID) Delete the user with the specified ID.
com.helger.commons.state.EChange	deleteUserGroup(String sUserGroupID) Delete the user group with the specified ID
com.helger.commons.state.EChange	disableUser(String sUserID) disable the user with the specified ID.
com.helger.commons.state.EChange	enableUser(String sUserID) Enable the user with the specified ID.
Collection<? extends IUser>	getAllActiveUsers()
Collection<? extends IUser>	getAllDeletedUsers()
Collection<? extends IUser>	getAllDisabledUsers()
Collection<? extends IUser>	getAllNotDeletedUsers()
Collection<? extends IRole>	getAllRoles()
Collection<String>	getAllUserGroupIDsWithAssignedRole(String sRoleID) Get a collection of all user group IDs to which a certain role is assigned to.
Collection<String>	getAllUserGroupIDsWithAssignedUser(String sUserID) Get a collection of all user group IDs to which a certain user is assigned to.
Collection<? extends IUserGroup>	getAllUserGroups()
Collection<IUserGroup>	getAllUserGroupsWithAssignedRole(String sRoleID) Get a collection of all user groups to which a certain role is assigned to.
Collection<IUserGroup>	getAllUserGroupsWithAssignedUser(String sUserID) Get a collection of all user groups to which a certain user is assigned to.
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
Collection<? extends IUser>	getAllUsers()
static AccessManager	getInstance()
com.helger.commons.callback.CallbackList<IRoleModificationCallback>	getRoleModificationCallbacks()
IRole	getRoleOfID(String sRoleID) Get the role with the specified ID
com.helger.commons.callback.CallbackList<IUserGroupModificationCallback>	getUserGroupModificationCallbacks()
IUserGroup	getUserGroupOfID(String sUserGroupID) Get the user group with the specified ID
com.helger.commons.callback.CallbackList<IUserModificationCallback>	getUserModificationCallbacks()
IUser	getUserOfEmailAddress(String sEmailAddress) Get the user with the specified email address
IUser	getUserOfID(String sUserID) Get the user with the specified ID.
IUser	getUserOfLoginName(String sLoginName) Get the user with the specified login name
boolean	hasUserAllRoles(String sUserID, Collection<String> aRoleIDs)
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.
boolean	isUserAssignedToUserGroup(String sUserGroupID, String sUserID) Check if the passed user is assigned to the specified user group
void	reloadRoleManager() Reload the content of the role manager.
void	reloadUserGroupManager() Reload the content of the user group manager.
void	reloadUserManager() Reload the content of the user manager.
com.helger.commons.state.EChange	renameRole(String sRoleID, String sNewName) Rename the role with the passed ID
com.helger.commons.state.EChange	renameUserGroup(String sUserGroupID, String sNewName) Rename the user group with the specified ID
com.helger.commons.state.EChange	setRoleData(String sRoleID, String sNewName, String sNewDescription, Map<String,?> aNewCustomAttrs) Change the modifiable data of a user group
com.helger.commons.state.EChange	setUserData(String sUserID, String sNewLoginName, String sNewEmailAddress, String sNewFirstName, String sNewLastName, String sNewDescription, Locale aNewDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Change the modifiable data of a user
com.helger.commons.state.EChange	setUserGroupData(String sUserGroupID, String sNewName, String sNewDescription, Map<String,?> aNewCustomAttrs) Change the modifiable data of a user group
com.helger.commons.state.EChange	setUserPassword(String sUserID, String sNewPlainTextPassword) Change the modifiable data of a user
com.helger.commons.state.EChange	unassignRoleFromAllUserGroups(String sRoleID) Unassign the passed role ID from existing user groups.
com.helger.commons.state.EChange	unassignRoleFromUserGroup(String sUserGroupID, String sRoleID) Unassign the passed role ID from the passed user group ID
com.helger.commons.state.EChange	unassignUserFromAllUserGroups(String sUserID) Unassign the passed user ID from all user groups.
com.helger.commons.state.EChange	unassignUserFromUserGroup(String sUserGroupID, String sUserID) Unassign the specified user ID from the passed user group ID.
com.helger.commons.state.EChange	undeleteUser(String sUserID) Undelete the user with the specified ID.

Methods inherited from class com.helger.commons.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_BASE_PATH

public static final String DEFAULT_BASE_PATH

See Also:

Constant Field Values

FILENAME_USERS_XML

public static final String FILENAME_USERS_XML

See Also:

Constant Field Values

FILENAME_ROLES_XML

public static final String FILENAME_ROLES_XML

See Also:

Constant Field Values

FILENAME_USERGROUPS_XML

public static final String FILENAME_USERGROUPS_XML

See Also:

Constant Field Values

Constructor Detail

AccessManager

@Deprecated
@UsedViaReflection
public AccessManager()
              throws DAOException

Deprecated.

Throws:

DAOException

Method Detail

getInstance

@Nonnull
public static AccessManager getInstance()

reloadUserManager

public void reloadUserManager()
                       throws DAOException

Reload the content of the user manager.

Throws:

DAOException - in case reloading fails

reloadUserGroupManager

public void reloadUserGroupManager()
                            throws DAOException

Reload the content of the user group manager.

Throws:

DAOException - in case reloading fails

reloadRoleManager

public void reloadRoleManager()
                       throws DAOException

Reload the content of the role manager.

Throws:

DAOException - in case reloading fails

getUserModificationCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public com.helger.commons.callback.CallbackList<IUserModificationCallback> getUserModificationCallbacks()

Specified by:

getUserModificationCallbacks in interface IUserManager

Returns:

The user callback list. Never null.

createNewUser

@Nullable
public IUser createNewUser(@Nonnull@Nonempty
                           String sLoginName,
                           @Nullable
                           String sEmailAddress,
                           @Nonnull@Nonempty
                           String sPlainTextPassword,
                           @Nullable
                           String sFirstName,
                           @Nullable
                           String sLastName,
                           @Nullable
                           String sDescription,
                           @Nullable
                           Locale aDesiredLocale,
                           @Nullable
                           Map<String,?> aCustomAttrs,
                           boolean bDisabled)

Description copied from interface: IUserManager

Create a new user.

Specified by:

createNewUser in interface IUserManager

Parameters:

sLoginName - Login name of the user. May neither be null nor empty.This login name must be unique over all existing users.

sEmailAddress - The email address. May be null.

sPlainTextPassword - The plain text password to be used. May neither be null nor empty.

sFirstName - The users first name. May be null.

sLastName - The users last name. May be null.

sDescription - Optional description for the user. May be null.

aDesiredLocale - The users default locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Returns:

The created user or null if another user with the same email address is already present.

createPredefinedUser

@Nullable
public IUser createPredefinedUser(@Nonnull@Nonempty
                                  String sID,
                                  @Nonnull@Nonempty
                                  String sLoginName,
                                  @Nullable
                                  String sEmailAddress,
                                  @Nonnull@Nonempty
                                  String sPlainTextPassword,
                                  @Nullable
                                  String sFirstName,
                                  @Nullable
                                  String sLastName,
                                  @Nullable
                                  String sDescription,
                                  @Nullable
                                  Locale aDesiredLocale,
                                  @Nullable
                                  Map<String,?> aCustomAttrs,
                                  boolean bDisabled)

Description copied from interface: IUserManager

Create a predefined user.

Specified by:

createPredefinedUser in interface IUserManager

Parameters:

sID - The ID to use

sLoginName - Login name of the user. May neither be null nor empty. This login name must be unique over all existing users.

sEmailAddress - The email address. May be null.

sPlainTextPassword - The plain text password to be used. May neither be null nor empty.

sFirstName - The users first name. May be null.

sLastName - The users last name. May be null.

sDescription - Optional description for the user. May be null.

aDesiredLocale - The users default locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Returns:

The created user or null if another user with the same email address is already present.

deleteUser

@Nonnull
public com.helger.commons.state.EChange deleteUser(@Nullable
                                                  String sUserID)

Description copied from interface: IUserManager

Delete the user with the specified ID.

Specified by:

deleteUser in interface IUserManager

Parameters:

sUserID - The ID of the user to delete

Returns:

EChange.CHANGED if the user was deleted, EChange.UNCHANGED otherwise.

undeleteUser

@Nonnull
public com.helger.commons.state.EChange undeleteUser(@Nullable
                                                    String sUserID)

Description copied from interface: IUserManager

Undelete the user with the specified ID.

Specified by:

undeleteUser in interface IUserManager

Parameters:

sUserID - The ID of the user to undelete

Returns:

EChange.CHANGED if the user was undeleted, EChange.UNCHANGED otherwise.

disableUser

@Nonnull
public com.helger.commons.state.EChange disableUser(@Nullable
                                                   String sUserID)

Description copied from interface: IUserManager

disable the user with the specified ID.

Specified by:

disableUser in interface IUserManager

Parameters:

sUserID - The ID of the user to disable

Returns:

EChange.CHANGED if the user was disabled, EChange.UNCHANGED otherwise.

enableUser

@Nonnull
public com.helger.commons.state.EChange enableUser(@Nullable
                                                  String sUserID)

Description copied from interface: IUserManager

Enable the user with the specified ID.

Specified by:

enableUser in interface IUserManager

Parameters:

sUserID - The ID of the user to enable

Returns:

EChange.CHANGED if the user was enabled, EChange.UNCHANGED otherwise.

containsUserWithID

public boolean containsUserWithID(@Nullable
                         String sUserID)

Description copied from interface: IUserManager

Check if a user with the specified ID is present.

Specified by:

containsUserWithID in interface IUserManager

Parameters:

sUserID - The user ID to resolve. May be null.

Returns:

true if such user exists, false otherwise.

getUserOfID

@Nullable
public IUser getUserOfID(@Nullable
                         String sUserID)

Description copied from interface: IUserManager

Get the user with the specified ID.

Specified by:

getUserOfID in interface IUserManager

Parameters:

sUserID - The user ID to resolve. May be null.

Returns:

null if no such user exists

getUserOfLoginName

@Nullable
public IUser getUserOfLoginName(@Nullable
                                String sLoginName)

Description copied from interface: IUserManager

Get the user with the specified login name

Specified by:

getUserOfLoginName in interface IUserManager

Parameters:

sLoginName - The login name to be checked. May be null.

Returns:

null if no such user exists

getUserOfEmailAddress

@Nullable
public IUser getUserOfEmailAddress(@Nullable
                                   String sEmailAddress)

Description copied from interface: IUserManager

Get the user with the specified email address

Specified by:

getUserOfEmailAddress in interface IUserManager

Parameters:

sEmailAddress - The email address to be checked. May be null.

Returns:

null if no such user exists

getAllUsers

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUser> getAllUsers()

Specified by:

getAllUsers in interface IUserManager

Returns:

A non-null collection of all contained users (enabled+disabled and deleted+not-deleted)

getAllActiveUsers

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUser> getAllActiveUsers()

Specified by:

getAllActiveUsers in interface IUserManager

Returns:

A non-null collection of all contained enabled and not-deleted users

getAllDisabledUsers

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUser> getAllDisabledUsers()

Specified by:

getAllDisabledUsers in interface IUserManager

Returns:

A non-null collection of all contained disabled and not-deleted users

getAllNotDeletedUsers

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUser> getAllNotDeletedUsers()

Specified by:

getAllNotDeletedUsers in interface IUserManager

Returns:

A non-null collection of all contained not deleted users

getAllDeletedUsers

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUser> getAllDeletedUsers()

Specified by:

getAllDeletedUsers in interface IUserManager

Returns:

A non-null collection of all contained deleted users

setUserData

@Nonnull
public com.helger.commons.state.EChange setUserData(@Nullable
                                                   String sUserID,
                                                   @Nonnull@Nonempty
                                                   String sNewLoginName,
                                                   @Nullable
                                                   String sNewEmailAddress,
                                                   @Nullable
                                                   String sNewFirstName,
                                                   @Nullable
                                                   String sNewLastName,
                                                   @Nullable
                                                   String sNewDescription,
                                                   @Nullable
                                                   Locale aNewDesiredLocale,
                                                   @Nullable
                                                   Map<String,?> aCustomAttrs,
                                                   boolean bDisabled)

Description copied from interface: IUserManager

Change the modifiable data of a user

Specified by:

setUserData in interface IUserManager

Parameters:

sUserID - The ID of the user to be modified. May be null.

sNewLoginName - The new login name. May not be null.

sNewEmailAddress - The new email address. May be null.

sNewFirstName - The new first name. May be null.

sNewLastName - The new last name. May be null.

sNewDescription - Optional new description for the user. May be null.

aNewDesiredLocale - The new desired locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Returns:

EChange

setUserPassword

@Nonnull
public com.helger.commons.state.EChange setUserPassword(@Nullable
                                                       String sUserID,
                                                       @Nonnull
                                                       String sNewPlainTextPassword)

Description copied from interface: IUserManager

Change the modifiable data of a user

Specified by:

setUserPassword in interface IUserManager

Parameters:

sUserID - The ID of the user to be modified. May be null.

sNewPlainTextPassword - The new password in plain text. May not be null.

Returns:

EChange

areUserIDAndPasswordValid

public boolean areUserIDAndPasswordValid(@Nullable
                                String sUserID,
                                @Nullable
                                String sPlainTextPassword)

Description copied from interface: IUserManager

Check if the passed combination of user ID and password matches.

Specified by:

areUserIDAndPasswordValid in interface IUserManager

Parameters:

sUserID - The ID of the user

sPlainTextPassword - The plan text password to validate.

Returns:

true if the password hash matches the stored hash for the specified user, false otherwise.

areUserLoginNameAndPasswordValid

public boolean areUserLoginNameAndPasswordValid(@Nullable
                                       String sLoginName,
                                       @Nullable
                                       String sPlainTextPassword)

Check if the passed combination of login name and plain text password are valid

Parameters:

sLoginName - The login name of the user to validate.

sPlainTextPassword - The plain text password to validate

Returns:

true if the login name matches a user, and if the hash of the plain text password matches the stored password hash

getUserGroupModificationCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public com.helger.commons.callback.CallbackList<IUserGroupModificationCallback> getUserGroupModificationCallbacks()

Specified by:

getUserGroupModificationCallbacks in interface IUserGroupManager

Returns:

The user group callback list. Never null.

createNewUserGroup

@Nonnull
public IUserGroup createNewUserGroup(@Nonnull@Nonempty
                                    String sName,
                                    @Nullable
                                    String sDescription,
                                    @Nullable
                                    Map<String,?> aCustomAttrs)

Description copied from interface: IUserGroupManager

Create a new user group.

Specified by:

createNewUserGroup in interface IUserGroupManager

Parameters:

sName - The name of the user group to create. May neither be null nor empty.

sDescription - The optional description of the user group. May be null .

aCustomAttrs - A set of custom attributes. May be null.

Returns:

The created user group.

createPredefinedUserGroup

@Nonnull
public IUserGroup createPredefinedUserGroup(@Nonnull@Nonempty
                                           String sID,
                                           @Nonnull@Nonempty
                                           String sName,
                                           @Nullable
                                           String sDescription,
                                           @Nullable
                                           Map<String,?> aCustomAttrs)

Description copied from interface: IUserGroupManager

Create a predefined user group.

Specified by:

createPredefinedUserGroup in interface IUserGroupManager

Parameters:

sID - The ID to use

sName - The name of the user group to create. May neither be null nor empty.

sDescription - The optional description of the user group. May be null .

aCustomAttrs - A set of custom attributes. May be null.

Returns:

The created user group.

deleteUserGroup

@Nonnull
public com.helger.commons.state.EChange deleteUserGroup(@Nullable
                                                       String sUserGroupID)

Description copied from interface: IUserGroupManager

Delete the user group with the specified ID

Specified by:

deleteUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to be deleted. May be null.

Returns:

EChange.CHANGED if the user group was deleted, EChange.UNCHANGED otherwise

containsUserGroupWithID

public boolean containsUserGroupWithID(@Nullable
                              String sUserGroupID)

Description copied from interface: IUserGroupManager

Check if a user group with the specified ID is contained

Specified by:

containsUserGroupWithID in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to check

Returns:

true if no user group exists, false otherwise.

containsAllUserGroupsWithID

public boolean containsAllUserGroupsWithID(@Nullable
                                  Collection<String> aUserGroupIDs)

Description copied from interface: IUserGroupManager

Check if all passed user group IDs are contained

Specified by:

containsAllUserGroupsWithID in interface IUserGroupManager

Parameters:

aUserGroupIDs - The user group IDs to be checked. May be null.

Returns:

true if the collection is empty or if all contained user group IDs are contained

getUserGroupOfID

@Nullable
public IUserGroup getUserGroupOfID(@Nullable
                                   String sUserGroupID)

Description copied from interface: IUserGroupManager

Get the user group with the specified ID

Specified by:

getUserGroupOfID in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to search

Returns:

null if no such user group exists

getAllUserGroups

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IUserGroup> getAllUserGroups()

Specified by:

getAllUserGroups in interface IUserGroupManager

Returns:

A non-null list of all user groups

renameUserGroup

@Nonnull
public com.helger.commons.state.EChange renameUserGroup(@Nullable
                                                       String sUserGroupID,
                                                       @Nonnull@Nonempty
                                                       String sNewName)

Description copied from interface: IUserGroupManager

Rename the user group with the specified ID

Specified by:

renameUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group. May be null.

sNewName - The new name of the user group. May neither be null nor empty.

Returns:

EChange.CHANGED if the user group ID was valid, and the new name was different from the old name

setUserGroupData

@Nonnull
public com.helger.commons.state.EChange setUserGroupData(@Nullable
                                                        String sUserGroupID,
                                                        @Nonnull@Nonempty
                                                        String sNewName,
                                                        @Nullable
                                                        String sNewDescription,
                                                        @Nullable
                                                        Map<String,?> aNewCustomAttrs)

Description copied from interface: IUserGroupManager

Change the modifiable data of a user group

Specified by:

setUserGroupData in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group. May be null.

sNewName - The new name of the user group. May neither be null nor empty.

sNewDescription - The optional new description of the user group. May be null .

aNewCustomAttrs - Custom attributes. May be null.

Returns:

EChange

assignUserToUserGroup

@Nonnull
public com.helger.commons.state.EChange assignUserToUserGroup(@Nullable
                                                             String sUserGroupID,
                                                             @Nonnull@Nonempty
                                                             String sUserID)

Description copied from interface: IUserGroupManager

Assign the passed user ID to the passed user group.
Note: no validity check must be performed for the user ID

Specified by:

assignUserToUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - ID of the user group to assign to

sUserID - ID of the user to be assigned.

Returns:

EChange.CHANGED if the user group ID was valid, and the specified user ID was not already contained.

unassignUserFromUserGroup

@Nonnull
public com.helger.commons.state.EChange unassignUserFromUserGroup(@Nullable
                                                                 String sUserGroupID,
                                                                 @Nullable
                                                                 String sUserID)

Description copied from interface: IUserGroupManager

Unassign the specified user ID from the passed user group ID.

Specified by:

unassignUserFromUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to unassign the user ID from

sUserID - The user ID to be unassigned

Returns:

EChange.CHANGED if the user group ID was resolved, and the passed user ID was assigned to the user group

unassignUserFromAllUserGroups

@Nonnull
public com.helger.commons.state.EChange unassignUserFromAllUserGroups(@Nullable
                                                                     String sUserID)

Description copied from interface: IUserGroupManager

Unassign the passed user ID from all user groups.

Specified by:

unassignUserFromAllUserGroups in interface IUserGroupManager

Parameters:

sUserID - ID of the user to be unassigned.

Returns:

EChange.CHANGED if the passed user ID was at least assigned to one user group.

isUserAssignedToUserGroup

public boolean isUserAssignedToUserGroup(@Nullable
                                String sUserGroupID,
                                @Nullable
                                String sUserID)

Description copied from interface: IUserGroupManager

Check if the passed user is assigned to the specified user group

Specified by:

isUserAssignedToUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - ID of the user group to check

sUserID - ID of the user to be checked.

Returns:

true if the specified user is assigned to the specified user group.

getAllUserGroupsWithAssignedUser

@Nonnull
@ReturnsMutableCopy
public Collection<IUserGroup> getAllUserGroupsWithAssignedUser(@Nullable
                                                                                 String sUserID)

Description copied from interface: IUserGroupManager

Get a collection of all user groups to which a certain user is assigned to.

Specified by:

getAllUserGroupsWithAssignedUser in interface IUserGroupManager

Parameters:

sUserID - The user ID to search

Returns:

A non-nullbut may be empty collection with all matching user groups.

getAllUserGroupIDsWithAssignedUser

@Nonnull
@ReturnsMutableCopy
public Collection<String> getAllUserGroupIDsWithAssignedUser(@Nullable
                                                                               String sUserID)

Description copied from interface: IUserGroupManager

Get a collection of all user group IDs to which a certain user is assigned to.

Specified by:

getAllUserGroupIDsWithAssignedUser in interface IUserGroupManager

Parameters:

sUserID - The user ID to search

Returns:

A non-nullbut may be empty collection with all matching user group IDs.

assignRoleToUserGroup

@Nonnull
public com.helger.commons.state.EChange assignRoleToUserGroup(@Nullable
                                                             String sUserGroupID,
                                                             @Nonnull@Nonempty
                                                             String sRoleID)

Description copied from interface: IUserGroupManager

Assign the passed role ID to the user group with the passed ID.
Note: the role ID must not be checked for consistency

Specified by:

assignRoleToUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to assign the role to.

sRoleID - The ID of the role to be assigned

Returns:

EChange.CHANGED if the passed user group ID was resolved, and the role ID was not already previously contained

unassignRoleFromUserGroup

@Nonnull
public com.helger.commons.state.EChange unassignRoleFromUserGroup(@Nullable
                                                                 String sUserGroupID,
                                                                 @Nullable
                                                                 String sRoleID)

Description copied from interface: IUserGroupManager

Unassign the passed role ID from the passed user group ID

Specified by:

unassignRoleFromUserGroup in interface IUserGroupManager

Parameters:

sUserGroupID - The ID of the user group to unassign the role ID from

sRoleID - The role ID to be unassigned.

Returns:

EChange.CHANGED if the user group ID was resolved and the passed role ID was contained

unassignRoleFromAllUserGroups

@Nonnull
public com.helger.commons.state.EChange unassignRoleFromAllUserGroups(@Nullable
                                                                     String sRoleID)

Description copied from interface: IUserGroupManager

Unassign the passed role ID from existing user groups.

Specified by:

unassignRoleFromAllUserGroups in interface IUserGroupManager

Parameters:

sRoleID - The role ID to be unassigned

Returns:

EChange.CHANGED if the passed role ID was contained in at least one user group

getAllUserGroupsWithAssignedRole

@Nonnull
@ReturnsMutableCopy
public Collection<IUserGroup> getAllUserGroupsWithAssignedRole(@Nullable
                                                                                 String sRoleID)

Description copied from interface: IUserGroupManager

Get a collection of all user groups to which a certain role is assigned to.

Specified by:

getAllUserGroupsWithAssignedRole in interface IUserGroupManager

Parameters:

sRoleID - The role ID to search

Returns:

A non-nullbut may be empty collection with all matching user groups.

getAllUserGroupIDsWithAssignedRole

@Nonnull
@ReturnsMutableCopy
public Collection<String> getAllUserGroupIDsWithAssignedRole(@Nullable
                                                                               String sRoleID)

Description copied from interface: IUserGroupManager

Get a collection of all user group IDs to which a certain role is assigned to.

Specified by:

getAllUserGroupIDsWithAssignedRole in interface IUserGroupManager

Parameters:

sRoleID - The role ID to search

Returns:

A non-nullbut may be empty collection with all matching user group IDs.

getRoleModificationCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public com.helger.commons.callback.CallbackList<IRoleModificationCallback> getRoleModificationCallbacks()

Specified by:

getRoleModificationCallbacks in interface IRoleManager

Returns:

The role callback list. Never null.

createNewRole

@Nonnull
public IRole createNewRole(@Nonnull@Nonempty
                          String sName,
                          @Nullable
                          String sDescription,
                          @Nullable
                          Map<String,?> aCustomAttrs)

Description copied from interface: IRoleManager

Create a new role.

Specified by:

createNewRole in interface IRoleManager

Parameters:

sName - The name of the new role. May neither be null nor empty.

sDescription - Optional description text. May be null.

aCustomAttrs - A set of custom attributes. May be null.

Returns:

The created role and never null.

createPredefinedRole

@Nonnull
public IRole createPredefinedRole(@Nonnull@Nonempty
                                 String sID,
                                 @Nonnull@Nonempty
                                 String sName,
                                 @Nullable
                                 String sDescription,
                                 @Nullable
                                 Map<String,?> aCustomAttrs)

Description copied from interface: IRoleManager

Create a predefined role.

Specified by:

createPredefinedRole in interface IRoleManager

Parameters:

sID - The ID of the new role

sName - The name of the new role

sDescription - Optional description text. May be null.

aCustomAttrs - A set of custom attributes. May be null.

Returns:

The created role and never null.

deleteRole

@Nonnull
public com.helger.commons.state.EChange deleteRole(@Nullable
                                                  String sRoleID)

Description copied from interface: IRoleManager

Delete the role with the passed ID

Specified by:

deleteRole in interface IRoleManager

Parameters:

sRoleID - The role ID to be deleted

Returns:

EChange.CHANGED if the passed role ID was found and deleted

containsRoleWithID

public boolean containsRoleWithID(@Nullable
                         String sRoleID)

Description copied from interface: IRoleManager

Check if the role with the specified ID is contained

Specified by:

containsRoleWithID in interface IRoleManager

Parameters:

sRoleID - The role ID to be check

Returns:

true if such role exists, false otherwise

containsAllRolesWithID

public boolean containsAllRolesWithID(@Nullable
                             Collection<String> aRoleIDs)

Description copied from interface: IRoleManager

Check if all passed role IDs are contained

Specified by:

containsAllRolesWithID in interface IRoleManager

Parameters:

aRoleIDs - The role IDs to be checked. May be null.

Returns:

true if the collection is empty or if all contained role IDs are contained

getRoleOfID

@Nullable
public IRole getRoleOfID(@Nullable
                         String sRoleID)

Description copied from interface: IRoleManager

Get the role with the specified ID

Specified by:

getRoleOfID in interface IRoleManager

Parameters:

sRoleID - The role ID to be resolved

Returns:

null if no such role exists.

getAllRoles

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IRole> getAllRoles()

Specified by:

getAllRoles in interface IRoleManager

Returns:

A non-null collection of all available roles

renameRole

@Nonnull
public com.helger.commons.state.EChange renameRole(@Nullable
                                                  String sRoleID,
                                                  @Nonnull@Nonempty
                                                  String sNewName)

Description copied from interface: IRoleManager

Rename the role with the passed ID

Specified by:

renameRole in interface IRoleManager

Parameters:

sRoleID - The ID of the role to be renamed. May be null.

sNewName - The new name of the role. May neither be null nor empty.

Returns:

EChange.CHANGED if the passed role ID was found, and the new name is different from the old name of he role

setRoleData

@Nonnull
public com.helger.commons.state.EChange setRoleData(@Nullable
                                                   String sRoleID,
                                                   @Nonnull@Nonempty
                                                   String sNewName,
                                                   @Nullable
                                                   String sNewDescription,
                                                   @Nullable
                                                   Map<String,?> aNewCustomAttrs)

Description copied from interface: IRoleManager

Change the modifiable data of a user group

Specified by:

setRoleData in interface IRoleManager

Parameters:

sRoleID - The ID of the role to be renamed. May be null.

sNewName - The new name of the role. May neither be null nor empty.

sNewDescription - The new description text. May be null.

aNewCustomAttrs - Custom attributes. May be null.

Returns:

EChange

hasUserRole

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

Description copied from interface: IAccessManager

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

Specified by:

hasUserRole in interface IAccessManager

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

hasUserAllRoles

public boolean hasUserAllRoles(@Nullable
                      String sUserID,
                      @Nullable
                      Collection<String> aRoleIDs)

getAllUserRoleIDs

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

Description copied from interface: IAccessManager

Get all role IDs the current user has

Specified by:

getAllUserRoleIDs in interface IAccessManager

Parameters:

sUserID - User ID to check

Returns:

Never null.

getAllUserRoles

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

Description copied from interface: IAccessManager

Get all roles the current user has

Specified by:

getAllUserRoles in interface IAccessManager

Parameters:

sUserID - User ID to check

Returns:

Never null.