org.xwiki.security.authorization

Interface SecurityRule

public interface SecurityRule

A security rule, representing a declarative access right for some users, groups, and rights.

Since:

4.0M2

Version:

$Id: b59c054baf0ecd6847ce4436e89d1d427d11ed4e $

Method Summary

Methods

Modifier and Type	Method and Description
RuleState	getState()
boolean	match(GroupSecurityReference group) Check if this rule match the given group.
boolean	match(Right right) Check if this rule match the given right.
boolean	match(UserSecurityReference user) Check if this rule match the given user.

Method Detail

match

boolean match(Right right)

Check if this rule match the given right.

Parameters:

right - The right to match.

Returns:

true if the state should be applied for the right.

match

boolean match(GroupSecurityReference group)

Check if this rule match the given group.

Parameters:

group - The group to match.

Returns:

true if the state should be applied for group.

match

boolean match(UserSecurityReference user)

Check if this rule match the given user.

Parameters:

user - The user to match.

Returns:

true if the state should be applied for user.

getState

RuleState getState()

Returns:

The RuleState of this rule.