1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.security.authorization

File SecurityRule.java

 

Code metrics

0
0
0
1
60
10
0
-
-
0
-

Classes

Class Line # Actions
SecurityRule 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.security.authorization;
21   
22    import org.xwiki.security.GroupSecurityReference;
23    import org.xwiki.security.UserSecurityReference;
24   
25    /**
26    * A security rule, representing a declarative access right for some users, groups, and rights.
27    *
28    * @version $Id: b59c054baf0ecd6847ce4436e89d1d427d11ed4e $
29    * @since 4.0M2
30    */
 
31    public interface SecurityRule
32    {
33    /**
34    * Check if this rule match the given right.
35    * @param right The right to match.
36    * @return {@code true} if the state should be applied for the right.
37    */
38    boolean match(Right right);
39   
40    /**
41    * Check if this rule match the given group.
42    *
43    * @param group The group to match.
44    * @return {@code true} if the state should be applied for group.
45    */
46    boolean match(GroupSecurityReference group);
47   
48    /**
49    * Check if this rule match the given user.
50    *
51    * @param user The user to match.
52    * @return {@code true} if the state should be applied for user.
53    */
54    boolean match(UserSecurityReference user);
55   
56    /**
57    * @return The {@code RuleState} of this rule.
58    */
59    RuleState getState();
60    }