Package org.ametys.core.ui.right

Class ExternalRightsDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.right.ExternalRightsDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ExternalRightsDAO
extends AbstractLogEnabled
implements Component, Serviceable

Helper to manage rights from rights.xml file

Field Summary

Fields

Modifier and Type	Field	Description
protected RightProfilesDAO	_profileDAO	The profile DAO
protected SourceResolver	_resolver	Avalon SourceResolver
protected RightManager	_rightManager	The right manager
protected RightsExtensionPoint	_rightsExtensionPoint	The rights extension point

Constructor Summary

Constructors

Constructor	Description
ExternalRightsDAO()

Method Summary

Modifier and Type	Method	Description
protected void	_saxRights(TransformerHandler handler)	Sax external rights in rights.xml ?
Map<String,Object>	addRight(String id, String label, String description, String category)	Add a right to the right EP then write it in rights.xml
Map<String,Object>	getRightsCategories()	Get all the right categories
Set<String>	getRightsIds()	Get the set of used right ids
Map<String,Object>	getRightsToDelete()	Get the available rights for deletion
Map<String,Object>	removeRight(String id)	Remove the right from the rightEP and rights.xml
void	service(ServiceManager manager)
protected void	writeRightsXML()	Write the rights.xml file with the list of external rights

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 Details

_rightsExtensionPoint

protected RightsExtensionPoint _rightsExtensionPoint

The rights extension point

_rightManager

protected RightManager _rightManager

The right manager

_profileDAO

protected RightProfilesDAO _profileDAO

The profile DAO

_resolver

protected SourceResolver _resolver

Avalon SourceResolver

Constructor Details

ExternalRightsDAO

public ExternalRightsDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getRightsCategories

public Map<String,Object> getRightsCategories()

Get all the right categories

Returns:

a map of the categories' labels

getRightsToDelete

public Map<String,Object> getRightsToDelete()

Get the available rights for deletion

Returns:

a map of the rights id and label

addRight

public Map<String,Object> addRight(String id,
 String label,
 String description,
 String category)

Add a right to the right EP then write it in rights.xml

Parameters:

id - the id for the new right

label - the label for the new right

description - the description for the new right

category - the category for the new right

Returns:

a map with an optionnal error message

removeRight

public Map<String,Object> removeRight(String id)

Remove the right from the rightEP and rights.xml

Parameters:

id - the right to delete's id

Returns:

a map with rightId or error message

writeRightsXML

protected void writeRightsXML()
                       throws Exception

Write the rights.xml file with the list of external rights

Throws:

Exception - if an error occured

_saxRights

protected void _saxRights(TransformerHandler handler)
                   throws SAXException

Sax external rights in rights.xml ?

Parameters:

handler - the transformer

Throws:

SAXException - exception during SAX

getRightsIds

public Set<String> getRightsIds()

Get the set of used right ids

Returns:

a set of right ids