com.helger.photon.basic.security.usergroup

Class UserGroupManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

com.helger.photon.basic.security.usergroup.UserGroupManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IReloadableDAO, IUserGroupManager

@ThreadSafe
public class UserGroupManager
extends AbstractSimpleDAO
implements IUserGroupManager, IReloadableDAO

This class manages the available user groups.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CREATE_DEFAULTS

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
UserGroupManager(String sFilename, IUserManager aUserMgr, IRoleManager aRoleMgr)

Method Summary

Methods

Modifier and Type	Method and Description
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	containsAllUserGroupsWithID(Collection<String> aUserGroupIDs) Check if all passed user group IDs are contained
boolean	containsUserGroupWithID(String sUserGroupID) Check if a user group with the specified ID is contained
IUserGroup	createNewUserGroup(String sName, String sDescription, Map<String,?> aCustomAttrs) Create a new user group.
IUserGroup	createPredefinedUserGroup(String sID, String sName, String sDescription, Map<String,?> aCustomAttrs) Create a predefined user group.
protected com.helger.commons.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
com.helger.commons.state.EChange	deleteUserGroup(String sUserGroupID) Delete the user group with the specified ID
List<String>	getAllUserGroupIDsWithAssignedRole(String sRoleID) Get a collection of all user group IDs to which a certain role is assigned to.
List<String>	getAllUserGroupIDsWithAssignedUser(String sUserID) Get a collection of all user group IDs to which a certain user is assigned to.
List<? extends IUserGroup>	getAllUserGroups()
List<IUserGroup>	getAllUserGroupsWithAssignedRole(String sRoleID) Get a collection of all user groups to which a certain role is assigned to.
List<IUserGroup>	getAllUserGroupsWithAssignedUser(String sUserID) Get a collection of all user groups to which a certain user is assigned to.
IRoleManager	getRoleManager()
com.helger.commons.callback.CallbackList<IUserGroupModificationCallback>	getUserGroupModificationCallbacks()
UserGroup	getUserGroupOfID(String sUserGroupID) Get the user group with the specified ID
IUserManager	getUserManager()
static boolean	isCreateDefaults()
boolean	isUserAssignedToUserGroup(String sUserGroupID, String sUserID) Check if the passed user is assigned to the specified user group
protected com.helger.commons.state.EChange	onInit() Custom initialization routine.
protected com.helger.commons.state.EChange	onRead(com.helger.commons.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
void	reload() Call this method to reload the content from the original source.
com.helger.commons.state.EChange	renameUserGroup(String sUserGroupID, String sNewName) Rename the user group with the specified ID
static void	setCreateDefaults(boolean bCreateDefaults)
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	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.

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

beforeWriteToFile, getDAOIO, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onFilenameChange, toString, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.app.dao.IDAO

getInitCount, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getWriteCount, writeToFileOnPendingChanges

Methods inherited from interface com.helger.photon.basic.app.dao.IChangeable

hasPendingChanges

Methods inherited from interface com.helger.photon.basic.app.dao.IAutoSaveAware

beginWithoutAutoSave, endWithoutAutoSave, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave

Field Detail

DEFAULT_CREATE_DEFAULTS

public static final boolean DEFAULT_CREATE_DEFAULTS

See Also:

Constant Field Values

Constructor Detail

UserGroupManager

public UserGroupManager(@Nonnull@Nonempty
                String sFilename,
                @Nonnull
                IUserManager aUserMgr,
                @Nonnull
                IRoleManager aRoleMgr)
                 throws DAOException

Throws:

DAOException

Method Detail

isCreateDefaults

public static boolean isCreateDefaults()

setCreateDefaults

public static void setCreateDefaults(boolean bCreateDefaults)

getUserManager

@Nonnull
public final IUserManager getUserManager()

getRoleManager

@Nonnull
public final IRoleManager getRoleManager()

reload

public void reload()
            throws DAOException

Description copied from interface: IReloadableDAO

Call this method to reload the content from the original source.

Specified by:

reload in interface IReloadableDAO

Throws:

DAOException - in case reloading fails

onInit

@Nonnull
protected com.helger.commons.state.EChange onInit()

Description copied from class: AbstractSimpleDAO

Custom initialization routine. Called only if the underlying file does not exist yet. This method is only called within a write lock!

Overrides:

onInit in class AbstractSimpleDAO

Returns:

EChange.CHANGED if something was modified inside this method

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                              com.helger.commons.microdom.IMicroDocument aDoc)

Description copied from class: AbstractSimpleDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractSimpleDAO

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

@Nonnull
protected com.helger.commons.microdom.IMicroDocument createWriteData()

Description copied from class: AbstractSimpleDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractSimpleDAO

Returns:

The non-null document to write to the file.

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.

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 UserGroup 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 List<? extends IUserGroup> getAllUserGroups()

Specified by:

getAllUserGroups in interface IUserGroupManager

Returns:

A non-null list of all user groups

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

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 List<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 List<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 List<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 List<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.