com.helger.photon.basic.security.role

Interface IRoleManager

All Known Subinterfaces:

IAccessManager

All Known Implementing Classes:

AccessManager, RoleManager

public interface IRoleManager

Interface for a role manager.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAllRolesWithID(Collection<String> aRoleIDs) Check if all passed role IDs are contained
boolean	containsRoleWithID(String sRoleID) Check if the role with the specified ID is contained
IRole	createNewRole(String sName, String sDescription, Map<String,?> aCustomAttrs) Create a new role.
IRole	createPredefinedRole(String sID, String sName, String sDescription, Map<String,?> aCustomAttrs) Create a predefined role.
com.helger.commons.state.EChange	deleteRole(String sRoleID) Delete the role with the passed ID
Collection<? extends IRole>	getAllRoles()
com.helger.commons.callback.CallbackList<IRoleModificationCallback>	getRoleModificationCallbacks()
IRole	getRoleOfID(String sRoleID) Get the role with the specified ID
com.helger.commons.state.EChange	renameRole(String sRoleID, String sNewName) Rename the role with the passed ID
com.helger.commons.state.EChange	setRoleData(String sRoleID, String sNewName, String sNewDescription, Map<String,?> aNewCustomAttrs) Change the modifiable data of a user group

Method Detail

getRoleModificationCallbacks

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

Returns:

The role callback list. Never null.

createNewRole

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

Create a new role.

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

Create a predefined role.

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

Delete the role with the passed ID

Parameters:

sRoleID - The role ID to be deleted

Returns:

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

containsRoleWithID

boolean containsRoleWithID(@Nullable
                         String sRoleID)

Check if the role with the specified ID is contained

Parameters:

sRoleID - The role ID to be check

Returns:

true if such role exists, false otherwise

containsAllRolesWithID

boolean containsAllRolesWithID(@Nullable
                             Collection<String> aRoleIDs)

Check if all passed role IDs are contained

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
IRole getRoleOfID(@Nullable
                         String sRoleID)

Get the role with the specified ID

Parameters:

sRoleID - The role ID to be resolved

Returns:

null if no such role exists.

getAllRoles

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

Returns:

A non-null collection of all available roles

renameRole

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

Rename the role with the passed ID

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

Change the modifiable data of a user group

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