Package org.ametys.cms.workflow

Class AmetysObjectCheckRightsCondition

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.workflow.component.CheckRightsCondition

org.ametys.cms.workflow.AmetysObjectCheckRightsCondition

All Implemented Interfaces:

com.opensymphony.workflow.Condition, EnhancedCondition, Disposable, Initializable, LogEnabled, Serviceable

Direct Known Subclasses:

FormCheckRightsCondition

public class AmetysObjectCheckRightsCondition
extends CheckRightsCondition

Condition for checking rights of an user for the current action using the right ametys object context.

The following configuration can be used for checking rights:

 <condition type="avalon">
   <arg name="role">org.ametys.cms.workflow.AmetysObjectCheckRightsCondition</arg>
   <arg name="right">Right_Edition</arg>
 </condition>
 

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMETYS_OBJECT_KEY	Constant for storing the ametys object into the transient variables map.

Fields inherited from class org.ametys.plugins.workflow.component.CheckRightsCondition

__CONTEXT_KEY, __DEFAULT_CONTEXT, __RIGHT_KEY, _i18nUtils, _rightManager, _rightsExtensionPoint, FORCE

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
AmetysObjectCheckRightsCondition()

Method Summary

Modifier and Type	Method	Description
protected Object	_computeContext(Map transientVars, Map args, UserIdentity user, String right)	Compute the context to use. Default implementation uses standard context "/cms".
protected I18nizableText	_getSingleConditionDescriptionKey(List<String> parameters)	Get condition description when there is one right
protected WorkflowAwareAmetysObject	getAmetysObject(Map transientVars)	Retrieve the ametys object associated with the workflow.
I18nizableText	getLabel()	Get the label for this condition

Methods inherited from class org.ametys.plugins.workflow.component.CheckRightsCondition

_checkRights, _getMultipleConditionsDescriptionKey, _getRightsEnumerator, checkMultipleAndRights, checkMultipleOrRights, dispose, getArguments, getFullLabel, hasRight, initialize, passesCondition

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser, service

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedCondition

getVisibilities

Field Details

AMETYS_OBJECT_KEY

public static final String AMETYS_OBJECT_KEY

Constant for storing the ametys object into the transient variables map.

Constructor Details

AmetysObjectCheckRightsCondition

public AmetysObjectCheckRightsCondition()

Method Details

_computeContext

protected Object _computeContext(Map transientVars,
 Map args,
 UserIdentity user,
 String right)
                          throws com.opensymphony.workflow.WorkflowException

Description copied from class: CheckRightsCondition

Compute the context to use.
Default implementation uses standard context "/cms".

Overrides:

_computeContext in class CheckRightsCondition

Parameters:

transientVars - variables that will not be persisted.

args - the properties for this function invocation.

user - the current user.

right - the needed right.

Returns:

the computed context.

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs.

getAmetysObject

protected WorkflowAwareAmetysObject getAmetysObject(Map transientVars)
                                             throws com.opensymphony.workflow.WorkflowException

Retrieve the ametys object associated with the workflow.

Parameters:

transientVars - the parameters from the call.

Returns:

the ametys object.

Throws:

com.opensymphony.workflow.WorkflowException - if the content is not found.

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedCondition

Get the label for this condition

Specified by:

getLabel in interface EnhancedCondition

Overrides:

getLabel in class CheckRightsCondition

Returns:

the label

_getSingleConditionDescriptionKey

protected I18nizableText _getSingleConditionDescriptionKey(List<String> parameters)

Description copied from class: CheckRightsCondition

Get condition description when there is one right

Overrides:

_getSingleConditionDescriptionKey in class CheckRightsCondition

Parameters:

parameters - the right label as a List

Returns:

the description