com.helger.photon.basic.security.role

Class RoleManager

java.lang.Object

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

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

com.helger.photon.basic.security.role.RoleManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IReloadableDAO, IRoleManager

@ThreadSafe
public final class RoleManager
extends AbstractSimpleDAO
implements IRoleManager, IReloadableDAO

This class manages the available roles.

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
RoleManager(String sFilename)

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.
protected com.helger.commons.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
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()
Role	getRoleOfID(String sRoleID) Get the role with the specified ID
static boolean	isCreateDefaults()
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	renameRole(String sRoleID, String sNewName) Rename the role with the passed ID
static void	setCreateDefaults(boolean bCreateDefaults)
com.helger.commons.state.EChange	setRoleData(String sRoleID, String sNewName, String sNewDescription, Map<String,?> aNewCustomAttrs) Change the modifiable data of a user group

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

RoleManager

public RoleManager(@Nonnull@Nonempty
           String sFilename)
            throws DAOException

Throws:

DAOException

Method Detail

isCreateDefaults

public static boolean isCreateDefaults()

Returns:

true if the default built-in roles should be created if no roles are present, false if not.

setCreateDefaults

public static void setCreateDefaults(boolean bCreateDefaults)

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.

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.

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 Role 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

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

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