Package org.nuxeo.ecm.core.api.impl

Class PermissionFilter

java.lang.Object

org.nuxeo.ecm.core.api.impl.PermissionFilter

All Implemented Interfaces:

Filter

public class PermissionFilter
extends Object
implements Filter

A filter based on permissions.

If one of the permission check throws an Exception, the accept(org.nuxeo.ecm.core.api.DocumentModel) method returns false.

Since:

5.7.2

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	excluded
protected Set<String>	required

Constructor Summary

Constructors

Constructor	Description
PermissionFilter(String permission, boolean isRequired)
PermissionFilter(List<String> required, List<String> excluded)

Method Summary

Modifier and Type	Method	Description
boolean	accept(DocumentModel docModel)	Filters data models objects.
protected boolean	hasPermission(CoreSession session, DocumentModel doc, Set<String> permissions, boolean required)

Methods inherited from class java.lang.Object

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

Field Detail

required

protected final Set<String> required

excluded

protected final Set<String> excluded

Constructor Detail

PermissionFilter

public PermissionFilter(List<String> required,
                        List<String> excluded)

PermissionFilter

public PermissionFilter(String permission,
                        boolean isRequired)

Method Detail

accept

public boolean accept(DocumentModel docModel)

Description copied from interface: Filter

Filters data models objects.

Specified by:

accept in interface Filter

Returns:

true if accepting the object false otherwise

hasPermission

protected boolean hasPermission(CoreSession session,
                                DocumentModel doc,
                                Set<String> permissions,
                                boolean required)