org.xwiki.security.authorization
Interface AuthorizationSettler

@Role
public interface AuthorizationSettler

An AuthorizationSettler compute the resulting access for a given user, a list of groups, and a hierarchy of rights objects defining rights on a given entity.

Since:

4.0M2

Version:

$Id$

Method Summary

SecurityAccessEntry

settle(UserSecurityReference user, Collection<GroupSecurityReference> groups, Deque<SecurityRuleEntry> securityRuleEntries) Compute the current access for the user that is a member of the given groups and on an entity which is protected by the given hierarchy of rights objects.

Method Detail

settle

SecurityAccessEntry settle(UserSecurityReference user,
                           Collection<GroupSecurityReference> groups,
                           Deque<SecurityRuleEntry> securityRuleEntries)

Compute the current access for the user that is a member of the given groups and on an entity which is protected by the given hierarchy of rights objects.

Parameters:

user - a user identifier.

groups - a collection of groups.

securityRuleEntries - a hierarchy of security rules. The list is arranged such that the rules belonging to the main wiki is put in the last collection, preceded by subwiki if any, preceded by space and subspaces if any, preceded by the document rules. The levels of this hierarchy match the structure of the entity reference reported by the first SecurityRuleEntry.

Returns:

the computed access for the given user.