org.alfresco.cmis.mapping

Class CompositeActionEvaluator

java.lang.Object

org.alfresco.cmis.mapping.AbstractActionEvaluator

org.alfresco.cmis.mapping.CompositeActionEvaluator

All Implemented Interfaces:

CMISActionEvaluator

public class CompositeActionEvaluator
extends AbstractActionEvaluator

This action evaluator introduces simplified interface to construct set of conditions to determine, if an action is available for a specified object. It is generic evaluator, which doesn't limit validation for any type of the objects. Also it introduces a possibility to build chain of the conditions.

Evaluator allows specifying logical operation to calculate the final result, using the specified conditions: conjunction (AND operation; DEFAULT value) or disjunction (OR operation).

N.B.: each CompositeActionEvaluator may include other CompositeActionEvaluator conditions!

Constructor Summary

Constructors

Constructor and Description
CompositeActionEvaluator(boolean defaultAllowing, ServiceRegistry serviceRegistry, CMISAllowedActionEnum action) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
CompositeActionEvaluator	addAspectCondition(boolean expected, org.alfresco.service.namespace.QName[] aspects) Adds AspectActionEvaluator condition to the list.
CompositeActionEvaluator	addCondition(AbstractActionEvaluator condition) Adds any condition to the list, if it is not a null
CompositeActionEvaluator	addLockCondition(LockType lockType) Adds ObjectLockedActionEvaluator condition to the list.
CompositeActionEvaluator	addParentTypeCondition(ParentTypeActionEvaluator.ParentTypeEnum parentType) Adds ParentTypeActionEvaluator condition to the list.
CompositeActionEvaluator	addPermissionCondition(java.lang.String[] permissions) Adds PermissionActionEvaluator condition to the list
CompositeActionEvaluator	addPropertyCondition(PropertyActionEvaluator.PropertyDescriptor[] propertyIdsAndExpectedValues) Add PropertyActionEvaluator condition to the list.
CompositeActionEvaluator	addPwcCondition(boolean pwcExpected) Adds AspectActionEvaluator condition to the list.
CompositeActionEvaluator	addTypeAttributeCondition(TypeAttributeActionEvaluator.TypeDefinitionAttributeEnum attribute, java.lang.Comparable comparator) Adds TypeAttributeActionEvaluator condition to the list.
boolean	isAllowed(java.lang.Object object) Determines if an action is allowed on an object

Methods inherited from class org.alfresco.cmis.mapping.AbstractActionEvaluator

getAction, getServiceRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeActionEvaluator

public CompositeActionEvaluator(boolean defaultAllowing,
                        ServiceRegistry serviceRegistry,
                        CMISAllowedActionEnum action)

Constructor

Parameters:

defaultAllowing - - Boolean value, which determines availability of action for several special cases (invalid object id, empty collection of the aspects etc.)

serviceRegistry - - ServiceRegistry instance

action - - CMISAllowableActions enumeration value, which determines the action to check

Method Detail

isAllowed

public boolean isAllowed(java.lang.Object object)

Description copied from interface: CMISActionEvaluator

Determines if an action is allowed on an object

Returns:

addPermissionCondition

public CompositeActionEvaluator addPermissionCondition(java.lang.String[] permissions)

Adds PermissionActionEvaluator condition to the list

Parameters:

permissions - - String... collection, which specifies all the permissions, which should be checked

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addPropertyCondition

public CompositeActionEvaluator addPropertyCondition(PropertyActionEvaluator.PropertyDescriptor[] propertyIdsAndExpectedValues)

Add PropertyActionEvaluator condition to the list. This method implies, that each property from the propertyIdsAndExpectedValues collection must satisfy conditions, which are specified in each PropertyActionEvaluator.PropertyDescriptor instance

Parameters:

propertyIdsAndExpectedValues - - PropertyActionEvaluator.PropertyDescriptor collection, which specifies property ids and expected values or if value should not be null

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addTypeAttributeCondition

public CompositeActionEvaluator addTypeAttributeCondition(TypeAttributeActionEvaluator.TypeDefinitionAttributeEnum attribute,
                                                 java.lang.Comparable comparator)

Adds TypeAttributeActionEvaluator condition to the list. This method implies, that attribute value may be null and it is not Map or Collection

Parameters:

attribute - - TypeAttributeActionEvaluator.TypeDefinitionAttributeEnum enumeration value, which determines attribute of object type definition, which should be validated

comparator - - Comparable instance, which encapsulates the logic of checking a value, received from the object type definition in accordance with attribute parameter

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addLockCondition

public CompositeActionEvaluator addLockCondition(LockType lockType)

Adds ObjectLockedActionEvaluator condition to the list. This method implies, that object should not have lockType lock

Parameters:

lockType - - LockType enumeration value, which determines lock, required to check

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addPwcCondition

public CompositeActionEvaluator addPwcCondition(boolean pwcExpected)

Adds AspectActionEvaluator condition to the list. This method sets only 1 ContentModel.ASPECT_WORKING_COPY aspect id and it implies

Parameters:

pwcExpected - - Boolean value, which determines: true - object should be PWC, false - object should not be PWC

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addAspectCondition

public CompositeActionEvaluator addAspectCondition(boolean expected,
                                          org.alfresco.service.namespace.QName[] aspects)

Adds AspectActionEvaluator condition to the list. This method implies, that all aspects should satisfy to the expected condition

Parameters:

expected - - Boolean value, which determines: true - aspects appliance is expected, false - aspects absence is expected

aspects - - QName... collection, which specifies all the aspects, which should be validated

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addParentTypeCondition

public CompositeActionEvaluator addParentTypeCondition(ParentTypeActionEvaluator.ParentTypeEnum parentType)

Adds ParentTypeActionEvaluator condition to the list. This method implies, that parent of the parentType type is expected

Parameters:

parentType - - ParentTypeActionEvaluator.ParentTypeEnum enumeration value, which determines, validation for which parent is required: for ParentTypeActionEvaluator.ParentTypeEnum.MULTI_FILED, for ParentTypeActionEvaluator.ParentTypeEnum.REPOSITORY_ROOT or for ParentTypeActionEvaluator.ParentTypeEnum.PRIMARY_REPOSITORY_ROOT

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions

addCondition

public CompositeActionEvaluator addCondition(AbstractActionEvaluator condition)

Adds any condition to the list, if it is not a null

Parameters:

condition - - AbstractActionEvaluator instance, which determines some condition

Returns:

CompositeActionEvaluator - self-instance, which allows making chain of conditions