Package com.day.cq.search.eval

Class PermissionPredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.PermissionPredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class PermissionPredicateEvaluator
extends AbstractPredicateEvaluator

Restricts the result to items where the current session has the specified JCR privileges.

This is a filtering-only predicate and cannot leverage a search index. Does not support facet extraction.

Name:

hasPermission

Properties:

hasPermission

comma-separated JCR privileges that the current user session must ALL have for the node in question; for example jcr:write,jcr:modifyAccessControl

Since:

6.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HAS_PERMISSION_PREDICATE

Constructor Summary

Constructors

Constructor	Description
PermissionPredicateEvaluator()

Method Summary

Modifier and Type	Method	Description
boolean	canFilter(Predicate predicate, EvaluationContext context)	Returns the same as the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
boolean	canXpath(Predicate predicate, EvaluationContext context)	Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
boolean	includes(Predicate p, Row row, EvaluationContext context)	Default implementation that always returns true, ie.

Methods inherited from class com.day.cq.search.eval.AbstractPredicateEvaluator

getFacetExtractor, getOrderByComparator, getOrderByProperties, getXPathExpression, isFiltering

Methods inherited from class java.lang.Object

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

Field Details

HAS_PERMISSION_PREDICATE

public static final String HAS_PERMISSION_PREDICATE

See Also:

• Constant Field Values

Constructor Details

PermissionPredicateEvaluator

public PermissionPredicateEvaluator()

Method Details

includes

public boolean includes(Predicate p,
 Row row,
 EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns true, ie. it does not "touch" the result set at all.

Specified by:

includes in interface PredicateEvaluator

Overrides:

includes in class AbstractPredicateEvaluator

Parameters:

p - predicate (for this evaluator type) which is evaluated

row - current row of the result set returned through the xpath query

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this row should be part of the final result set, false if it should be dropped

canXpath

public boolean canXpath(Predicate predicate,
 EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie. if not overridden, true).

Specified by:

canXpath in interface PredicateEvaluator

Overrides:

canXpath in class AbstractPredicateEvaluator

Parameters:

predicate - predicate (for this evaluator type) which is evaluated

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this evaluator can express itself via xpath, ie. PredicateEvaluator.getXPathExpression(Predicate, EvaluationContext)

canFilter

public boolean canFilter(Predicate predicate,
 EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Returns the same as the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie. if not overridden, false).

Specified by:

canFilter in interface PredicateEvaluator

Overrides:

canFilter in class AbstractPredicateEvaluator

Parameters:

predicate - predicate (for this evaluator type) which is evaluated

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this evaluator can be express itself via filtering, ie. PredicateEvaluator.includes(Predicate, Row, EvaluationContext)