com.helger.photon.basic.security.usergroup

Interface IUserGroupManager

All Known Subinterfaces:

IAccessManager

All Known Implementing Classes:

AccessManager, UserGroupManager

public interface IUserGroupManager

Interface for a user group manager

Author:

Philip Helger

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.
com.helger.commons.state.EChange	deleteUserGroup(String sUserGroupID) Delete the user group with the specified ID
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.
com.helger.commons.callback.CallbackList<IUserGroupModificationCallback>	getUserGroupModificationCallbacks()
IUserGroup	getUserGroupOfID(String sUserGroupID) Get the user group with the specified ID
boolean	isUserAssignedToUserGroup(String sUserGroupID, String sUserID) Check if the passed user is assigned to the specified user group
com.helger.commons.state.EChange	renameUserGroup(String sUserGroupID, String sNewName) Rename the user group with the specified ID
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.

Method Detail

getUserGroupModificationCallbacks

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

Returns:

The user group callback list. Never null.

createNewUserGroup

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

Create a new user group.

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
IUserGroup createPredefinedUserGroup(@Nonnull@Nonempty
                                           String sID,
                                           @Nonnull@Nonempty
                                           String sName,
                                           @Nullable
                                           String sDescription,
                                           @Nullable
                                           Map<String,?> aCustomAttrs)

Create a predefined user group.

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
com.helger.commons.state.EChange deleteUserGroup(@Nullable
                                                       String sUserGroupID)

Delete the user group with the specified ID

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

boolean containsUserGroupWithID(@Nullable
                              String sUserGroupID)

Check if a user group with the specified ID is contained

Parameters:

sUserGroupID - The ID of the user group to check

Returns:

true if no user group exists, false otherwise.

containsAllUserGroupsWithID

boolean containsAllUserGroupsWithID(@Nullable
                                  Collection<String> aUserGroupIDs)

Check if all passed user group IDs are contained

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
IUserGroup getUserGroupOfID(@Nullable
                                   String sUserGroupID)

Get the user group with the specified ID

Parameters:

sUserGroupID - The ID of the user group to search

Returns:

null if no such user group exists

getAllUserGroups

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

Returns:

A non-null list of all user groups

renameUserGroup

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

Rename the user group with the specified ID

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
com.helger.commons.state.EChange setUserGroupData(@Nullable
                                                        String sUserGroupID,
                                                        @Nonnull@Nonempty
                                                        String sNewName,
                                                        @Nullable
                                                        String sNewDescription,
                                                        @Nullable
                                                        Map<String,?> aNewCustomAttrs)

Change the modifiable data of a user group

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
com.helger.commons.state.EChange assignUserToUserGroup(@Nullable
                                                             String sUserGroupID,
                                                             @Nonnull@Nonempty
                                                             String sUserID)

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

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
com.helger.commons.state.EChange unassignUserFromUserGroup(@Nullable
                                                                 String sUserGroupID,
                                                                 @Nullable
                                                                 String sUserID)

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

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
com.helger.commons.state.EChange unassignUserFromAllUserGroups(@Nullable
                                                                     String sUserID)

Unassign the passed user ID from all user groups.

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

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

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

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
Collection<IUserGroup> getAllUserGroupsWithAssignedUser(@Nullable
                                                                                 String sUserID)

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

Parameters:

sUserID - The user ID to search

Returns:

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

getAllUserGroupIDsWithAssignedUser

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

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

Parameters:

sUserID - The user ID to search

Returns:

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

assignRoleToUserGroup

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

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

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
com.helger.commons.state.EChange unassignRoleFromUserGroup(@Nullable
                                                                 String sUserGroupID,
                                                                 @Nullable
                                                                 String sRoleID)

Unassign the passed role ID from the passed user group ID

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
com.helger.commons.state.EChange unassignRoleFromAllUserGroups(@Nullable
                                                                     String sRoleID)

Unassign the passed role ID from existing user groups.

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
Collection<IUserGroup> getAllUserGroupsWithAssignedRole(@Nullable
                                                                                 String sRoleID)

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

Parameters:

sRoleID - The role ID to search

Returns:

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

getAllUserGroupIDsWithAssignedRole

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

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

Parameters:

sRoleID - The role ID to search

Returns:

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