Package org.ametys.plugins.odfweb.restrictions

Class OdfProgramRestrictionManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.restrictions.OdfProgramRestrictionManager

All Implemented Interfaces:

LogEnabled, Disposable, Component, Contextualizable, Serviceable

public class OdfProgramRestrictionManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Disposable

Component able to handle program restrictions related to the "odf-restrictions" site parameter.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	Cocoon context
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point.
protected OdfReferenceTableHelper	_odfReferenceTableHelper	The ODF reference table helper
protected AmetysObjectResolver	_resolver	Ametys object resolver
protected Map<String,OdfProgramRestriction>	_restrictions	The available odf restrictions
protected RootOrgUnitProvider	_rootOrgUnitProvider	Root orgunit provider
protected SiteManager	_siteManager	Site Manager
static final String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
OdfProgramRestrictionManager()

Method Summary

Modifier and Type	Method	Description
protected OdfRestrictionRule	_configureRestrictionRule(Configuration ruleConf)	Configure a restriction rule from a configuration node
protected List<OdfRestrictionRule>	_configureRestrictionRules(Configuration rulesConf)	Create a list of rules from configuration nodes
protected void	_readRestrictionConfigurationFile()	Configured the restrictions from the XML configuration file
void	contextualize(Context context)
void	dispose()
OdfProgramRestriction	getRestriction(Page odfRootPage)	Get the ODF restriction for the given ODF root page
String	getRestrictionRootOrgUnitId(String siteName)	Get the id of the restriction root orgunit
Map<String,OdfProgramRestriction>	getRestrictions()	Retrieves the available restrictions
boolean	hasOrgunitRestrictions(Page rootPage)	Indicate is there is any restriction related to orgunit for this root page
boolean	hasRestrictions(Page rootPage)	Indicate is there is any restriction for this root page
void	service(ServiceManager serviceManager)

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

ROLE

public static final String ROLE

The avalon role.

_siteManager

protected SiteManager _siteManager

Site Manager

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_odfReferenceTableHelper

protected OdfReferenceTableHelper _odfReferenceTableHelper

The ODF reference table helper

_rootOrgUnitProvider

protected RootOrgUnitProvider _rootOrgUnitProvider

Root orgunit provider

_cocoonContext

protected Context _cocoonContext

Cocoon context

_restrictions

protected Map<String,OdfProgramRestriction> _restrictions

The available odf restrictions

Constructor Details

OdfProgramRestrictionManager

public OdfProgramRestrictionManager()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getRestrictions

public Map<String,OdfProgramRestriction> getRestrictions()

Retrieves the available restrictions

Returns:

The map of restriction, where keys are restriction ids.

getRestriction

public OdfProgramRestriction getRestriction(Page odfRootPage)

Get the ODF restriction for the given ODF root page

Parameters:

odfRootPage - The ODF root page

Returns:

The restriction or null

hasRestrictions

public boolean hasRestrictions(Page rootPage)

Indicate is there is any restriction for this root page

Parameters:

rootPage - odf root page

Returns:

true if it is the case

hasOrgunitRestrictions

public boolean hasOrgunitRestrictions(Page rootPage)

Indicate is there is any restriction related to orgunit for this root page

Parameters:

rootPage - odf root page

Returns:

true if it is the case

getRestrictionRootOrgUnitId

public String getRestrictionRootOrgUnitId(String siteName)

Get the id of the restriction root orgunit

Parameters:

siteName - the site name

Returns:

the id of the restriction root orgunit

_readRestrictionConfigurationFile

protected void _readRestrictionConfigurationFile()

Configured the restrictions from the XML configuration file

_configureRestrictionRules

protected List<OdfRestrictionRule> _configureRestrictionRules(Configuration rulesConf)
                                                       throws ConfigurationException

Create a list of rules from configuration nodes

Parameters:

rulesConf - Array of configuration node that represents the set of rules

Returns:

list of rules

Throws:

ConfigurationException - if a configuration error is encountered

_configureRestrictionRule

protected OdfRestrictionRule _configureRestrictionRule(Configuration ruleConf)
                                                throws ConfigurationException

Configure a restriction rule from a configuration node

Parameters:

ruleConf - The configuration node representing the rule

Returns:

The odf restriction rule

Throws:

ConfigurationException - if a configuration error is encountered