Package org.ametys.core.right

Class RightProfilesDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractMyBatisDAO

org.ametys.core.right.RightProfilesDAO

All Implemented Interfaces:

LogEnabled, PluginAware, Initializable, Component, Configurable, Contextualizable, Serviceable

public class RightProfilesDAO
extends AbstractMyBatisDAO
implements Initializable

Manages registration of profiles

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The component role.

Fields inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_manager

Constructor Summary

Constructors

Constructor	Description
RightProfilesDAO()

Method Summary

Modifier and Type	Method	Description
Profile	addProfile(String label)	Creates a new profile with null context.
Profile	addProfile(String label, String context)	Creates a new profile.
Profile	addProfile(String id, String label, String context)	Creates a new profile
void	addProfile(Profile profile)	Add a new profile
void	addProfile(Profile profile, boolean silent)	Add a new profile
void	addRight(Profile profile, String rightId)	Add a right to a profile
void	addRights(Profile profile, List<String> rightIds)	Add a right to a profile
void	clearCache()	Clear the profiles cache
void	deleteProfile(Profile profile)	Delete a profile
void	deleteProfile(Profile profile, boolean silent)	Delete a profile
Profile	getProfile(String id)	Get the profile with given identifier
List<Profile>	getProfiles()	Get all existing profiles
List<Profile>	getProfiles(String context)	Get the profiles on a given context
Set<String>	getProfilesWithRight(String rightId)	Get all profiles containing the right with given id
List<String>	getRights(String profileId)	Get the rights of a profile
List<String>	getRights(Profile profile)	Get the rights of a profile
void	initialize()
void	removeRight(Profile profile, String rightId)	Remove a right from a profile
void	removeRight(Profile profile, String rightId, boolean silent)	Remove a right from a profile
void	removeRights(Profile profile)	Add a right to a profile
void	removeRights(Profile profile, boolean silent)	Add a right to a profile
void	renameProfile(Profile profile, String newLabel)	Rename a profile
void	renameProfile(Profile profile, String newLabel, boolean silent)	Rename a profile
void	service(ServiceManager smanager)
void	updateRights(Profile profile, List<String> rights)	Update the rights of a profile
void	updateRights(Profile profile, List<String> rights, boolean silent)	Update the rights of a profile

Methods inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_configureDatasource, _getDataSourceId, _getMyBatisConfiguration, configure, contextualize, getSession, getSession, reload, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The component role.

Constructor Detail

RightProfilesDAO

public RightProfilesDAO()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractMyBatisDAO

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

clearCache

public void clearCache()

Clear the profiles cache

getProfiles

public List<Profile> getProfiles()

Get all existing profiles

Returns:

The list for profiles

getProfiles

public List<Profile> getProfiles(String context)

Get the profiles on a given context

Parameters:

context - The context. Can be null. If null, the profiles with no context are returned.

Returns:

The list for profiles for this context

getProfile

public Profile getProfile(String id)

Get the profile with given identifier

Parameters:

id - The id of profile to retrieve

Returns:

The profile

getProfilesWithRight

public Set<String> getProfilesWithRight(String rightId)

Get all profiles containing the right with given id

Parameters:

rightId - The id of right

Returns:

The id of profiles with this right

addProfile

public Profile addProfile(String label)

Creates a new profile with null context. The identifier of the profile will be automatically generated from label.

Parameters:

label - The label of profile

Returns:

The create profile

addProfile

public Profile addProfile(String label,
                          String context)

Creates a new profile. The identifier of the profile will be automatically generated from label.

Parameters:

label - The label of profile

context - The context. Can be null

Returns:

The create profile

addProfile

public Profile addProfile(String id,
                          String label,
                          String context)

Creates a new profile

Parameters:

id - The unique identifier of profile

label - The label of profile

context - The context. Can be null

Returns:

The create profile

addProfile

public void addProfile(Profile profile,
                       boolean silent)

Add a new profile

Parameters:

profile - The profile to add

silent - Set to true to not notify observer of this update

addProfile

public void addProfile(Profile profile)

Add a new profile

Parameters:

profile - The profile to add

renameProfile

public void renameProfile(Profile profile,
                          String newLabel)

Rename a profile

Parameters:

profile - The profile to rename

newLabel - The updated label

renameProfile

public void renameProfile(Profile profile,
                          String newLabel,
                          boolean silent)

Rename a profile

Parameters:

profile - The profile to rename

newLabel - The updated label

silent - Set to true to not notify observer of this update

getRights

public List<String> getRights(String profileId)

Get the rights of a profile

Parameters:

profileId - The profile id

Returns:

The rights

getRights

public List<String> getRights(Profile profile)

Get the rights of a profile

Parameters:

profile - The profile

Returns:

The rights

addRight

public void addRight(Profile profile,
                     String rightId)

Add a right to a profile

Parameters:

profile - The profile

rightId - The id of right to add

addRights

public void addRights(Profile profile,
                      List<String> rightIds)

Add a right to a profile

Parameters:

profile - The profile

rightIds - The id of rights to add

updateRights

public void updateRights(Profile profile,
                         List<String> rights)

Update the rights of a profile

Parameters:

profile - The profile

rights - The rights of the profile

updateRights

public void updateRights(Profile profile,
                         List<String> rights,
                         boolean silent)

Update the rights of a profile

Parameters:

profile - The profile

rights - The rights of the profile

silent - Set to true to not notify observer of this update

removeRights

public void removeRights(Profile profile)

Add a right to a profile

Parameters:

profile - The profile

removeRights

public void removeRights(Profile profile,
                         boolean silent)

Add a right to a profile

Parameters:

profile - The profile

silent - Set to true to not notify observer of this update

removeRight

public void removeRight(Profile profile,
                        String rightId)

Remove a right from a profile

Parameters:

profile - The profile

rightId - The id of right to add

removeRight

public void removeRight(Profile profile,
                        String rightId,
                        boolean silent)

Remove a right from a profile

Parameters:

profile - The profile

rightId - The id of right to add

silent - Set to true to not notify observer of this update

deleteProfile

public void deleteProfile(Profile profile)

Delete a profile

Parameters:

profile - The profile to delete

deleteProfile

public void deleteProfile(Profile profile,
                          boolean silent)

Delete a profile

Parameters:

profile - The profile to delete

silent - Set to true to not notify observer of this update