Package org.ametys.plugins.forms.workflow

Class FormCheckRightsCondition

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.workflow.component.CheckRightsCondition

org.ametys.cms.workflow.AmetysObjectCheckRightsCondition

org.ametys.plugins.forms.workflow.FormCheckRightsCondition

All Implemented Interfaces:

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

public class FormCheckRightsCondition
extends AmetysObjectCheckRightsCondition
implements FormEntryCondition

Worklow condition for checking rights on form entry

Nested Class Summary

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

AbstractWorkflowComponent.ConditionFailure

Field Summary

Fields

Modifier and Type	Field	Description
protected FormDirectoryDAO	_formDirectoryDAO	The form directory DAO

Fields inherited from class org.ametys.cms.workflow.AmetysObjectCheckRightsCondition

AMETYS_OBJECT_KEY

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
FormCheckRightsCondition()

Method Summary

Modifier and Type	Method	Description
protected StaticEnumerator	_getRightsEnumerator()	Get the rights enumerator
protected I18nizableText	_getSingleConditionDescriptionKey(List<String> parameters)	Get condition description when there is one right
protected boolean	checkAnyConnectedRightOnForm(Form form, Map args)	Check for any connected a right (or combination of rights separated by '|' or '&') on a form entry
protected Map<UserIdentity,RightManager.RightResult>	collectANDFromAllowedUsers(Form form, String[] rights)	Collect UserIdentity with their RightManager.RightResult with AND semantics, using merge strategy where DENY wins.
protected Map<UserIdentity,RightManager.RightResult>	collectFromAllowedUsers(Form form, String rightNeeded)	Collect UserIdentity with their RightManager.RightResult from AllowedUsers for a right (or combination of rights separated by '|' or '&') on a form
protected Map<UserIdentity,RightManager.RightResult>	collectORFromAllowedUsers(Form form, String[] rights)	Collect UserIdentity with their RightManager.RightResult with OR semantics, using merge strategy where ALLOW wins.
RightManager.RightResult	getAnyConnectedPermissions(FormEntry entry, Map args)	Get the right result for any connected user passes the condition on the form entry
List<WorkflowArgument>	getArguments()	Get the list of accepted arguments for this condition
I18nizableText	getLabel()	Get the label for this condition
List<WorkflowHelper.WorkflowVisibility>	getVisibilities()	Get the condition's visibilities depending on rights
Map<UserIdentity,RightManager.RightResult>	getWorkflowActorsPermissions(FormEntry entry, Map args)	Returns all users with their corresponding permission result.
protected boolean	multipleANDAnyConnectedRightResult(Form form, String[] rights)	Check multiple rights on any connected with AND semantics: returns true only if all rights are allowed.
protected boolean	multipleORAnyConnectedRightResult(Form form, String[] rights)	Check multiple rights on any connected with OR semantics: returns true if any right is allowed.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.workflow.AmetysObjectCheckRightsCondition

_computeContext, getAmetysObject

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Details

_formDirectoryDAO

protected FormDirectoryDAO _formDirectoryDAO

The form directory DAO

Constructor Details

FormCheckRightsCondition

public FormCheckRightsCondition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

getArguments

public List<WorkflowArgument> getArguments()

Description copied from interface: EnhancedCondition

Get the list of accepted arguments for this condition

Specified by:

getArguments in interface EnhancedCondition

Overrides:

getArguments in class CheckRightsCondition

Returns:

a List of argument names and associated description

_getRightsEnumerator

protected StaticEnumerator _getRightsEnumerator()

Description copied from class: CheckRightsCondition

Get the rights enumerator

Overrides:

_getRightsEnumerator in class CheckRightsCondition

Returns:

the rights enumerator

getVisibilities

public List<WorkflowHelper.WorkflowVisibility> getVisibilities()

Description copied from interface: EnhancedCondition

Get the condition's visibilities depending on rights

Specified by:

getVisibilities in interface EnhancedCondition

Returns:

a list of all the allowed right profiles

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 AmetysObjectCheckRightsCondition

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 AmetysObjectCheckRightsCondition

Parameters:

parameters - the right label as a List

Returns:

the description

getAnyConnectedPermissions

public RightManager.RightResult getAnyConnectedPermissions(FormEntry entry,
 Map args)

Description copied from interface: FormEntryCondition

Get the right result for any connected user passes the condition on the form entry

Specified by:

getAnyConnectedPermissions in interface FormEntryCondition

Parameters:

entry - the form entry

args - the condition arguments

Returns:

the right result for any connected user passes the condition on the form entry

checkAnyConnectedRightOnForm

protected boolean checkAnyConnectedRightOnForm(Form form,
 Map args)

Check for any connected a right (or combination of rights separated by '|' or '&') on a form entry

Parameters:

form - the form to check the rights on

args - the workflow arguments containing the right key

Returns:

true if any connected user has the right(s), false otherwise

multipleORAnyConnectedRightResult

protected boolean multipleORAnyConnectedRightResult(Form form,
 String[] rights)

Check multiple rights on any connected with OR semantics: returns true if any right is allowed.

Parameters:

form - the form to check the rights on

rights - the rights to check

Returns:

true if at least one right is allowed

multipleANDAnyConnectedRightResult

protected boolean multipleANDAnyConnectedRightResult(Form form,
 String[] rights)

Check multiple rights on any connected with AND semantics: returns true only if all rights are allowed.

Parameters:

form - the form to check the rights on

rights - the rights to check

Returns:

true if all rights are allowed

getWorkflowActorsPermissions

public Map<UserIdentity,RightManager.RightResult> getWorkflowActorsPermissions(FormEntry entry,
 Map args)

Description copied from interface: FormEntryCondition

Returns all users with their corresponding permission result. The associated RightManager.RightResult indicates whether the user passes the condition or not.

Specified by:

getWorkflowActorsPermissions in interface FormEntryCondition

Parameters:

entry - the form entry

args - the condition arguments

Returns:

a map containing each evaluated user and their corresponding RightManager.RightResult

collectFromAllowedUsers

protected Map<UserIdentity,RightManager.RightResult> collectFromAllowedUsers(Form form,
 String rightNeeded)

Collect UserIdentity with their RightManager.RightResult from AllowedUsers for a right (or combination of rights separated by '|' or '&') on a form

Parameters:

form - the form context

rightNeeded - the right string, possibly containing '|' or '&'

Returns:

the collected map of UserIdentity to RightManager.RightResult

collectORFromAllowedUsers

protected Map<UserIdentity,RightManager.RightResult> collectORFromAllowedUsers(Form form,
 String[] rights)

Collect UserIdentity with their RightManager.RightResult with OR semantics, using merge strategy where ALLOW wins.

Parameters:

form - the form context

rights - the rights to check, separated by '|' in the original string

Returns:

the collected map of UserIdentity to RightManager.RightResult

collectANDFromAllowedUsers

protected Map<UserIdentity,RightManager.RightResult> collectANDFromAllowedUsers(Form form,
 String[] rights)

Collect UserIdentity with their RightManager.RightResult with AND semantics, using merge strategy where DENY wins.

Parameters:

form - the form context

rights - the rights to check, separated by '&' in the original string

Returns:

the collected map of UserIdentity to RightManager.RightResult