Package org.ametys.cms.model.restrictions

Class DefaultRestriction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.model.restrictions.DefaultRestriction

All Implemented Interfaces:

Restriction, LogEnabled, Component, Configurable, Serviceable

Direct Known Subclasses:

SharedOnlyRestriction

public class DefaultRestriction
extends AbstractLogEnabled
implements Restriction, Configurable, Serviceable, Component

Default implementation for restrictions on content attributes.
Restrictions can be on read or write direction, based on rights and/or workflow step ids, according its XML configuration:

  <cannot read-write-direction="read|write"/>
  <right read-write-direction="read|write" id="RightId"/>
  <workflow read-write-direction="read|write" step="3"/>
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.model.restrictions.Restriction

Restriction.RestrictionResult

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	Current user provider.
protected RightManager	_rightManager	The rights manager.
protected WorkflowProvider	_workflowProvider	The workflow provider
protected Set<String>	_writeRightIds	Read workflow step ids.

Constructor Summary

Constructors

Constructor	Description
DefaultRestriction()

Method Summary

Modifier and Type	Method	Description
protected boolean	_hasRights(Content content, RestrictedModelItem modelItem, Set<String> rightLimitations)	Check if current user has the given rights.
protected boolean	_isInWorkflowStep(WorkflowAwareContent content, Set<Integer> workflowLimitations)	Check if content is on given workflow steps
Restriction.RestrictionResult	canRead(Content content, RestrictedModelItem modelItem)	Determine whether a model item can be read at this time.
Restriction.RestrictionResult	canWrite(Content content, RestrictedModelItem modelItem)	Determine whether a model item can be written at this time.
void	configure(Configuration configuration)
void	service(ServiceManager manager)

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

_rightManager

protected RightManager _rightManager

The rights manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider.

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_writeRightIds

protected Set<String> _writeRightIds

Read workflow step ids.

Constructor Details

DefaultRestriction

public DefaultRestriction()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

canRead

public Restriction.RestrictionResult canRead(Content content,
 RestrictedModelItem modelItem)

Description copied from interface: Restriction

Determine whether a model item can be read at this time.

Specified by:

canRead in interface Restriction

Parameters:

content - The content where item is to be written on. Can be null, on content creation.

modelItem - the model item on which check the restrictions

Returns:

The restriction result

canWrite

public Restriction.RestrictionResult canWrite(Content content,
 RestrictedModelItem modelItem)

Description copied from interface: Restriction

Determine whether a model item can be written at this time.

Specified by:

canWrite in interface Restriction

Parameters:

content - The content where item is to be written on. Can be null, on content creation.

modelItem - the model item on which check the restrictions

Returns:

The restriction result

_hasRights

protected boolean _hasRights(Content content,
 RestrictedModelItem modelItem,
 Set<String> rightLimitations)

Check if current user has the given rights.

Parameters:

content - the content.

modelItem - the model item on which check the restrictions

rightLimitations - the right limitations.

Returns:

true if user has at least one right, false otherwise.

_isInWorkflowStep

protected boolean _isInWorkflowStep(WorkflowAwareContent content,
 Set<Integer> workflowLimitations)
                             throws AmetysRepositoryException

Check if content is on given workflow steps

Parameters:

content - the content.

workflowLimitations - the workflow step ids

Returns:

true if it is on at least one step, false otherwise.

Throws:

AmetysRepositoryException - if failed to get content's workflow current step