1 package org.apache.fulcrum.security.model.basic;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.Serializable;
23
24 import org.apache.fulcrum.security.acl.AccessControlList;
25 import org.apache.fulcrum.security.entity.Group;
26 import org.apache.fulcrum.security.util.GroupSet;
27
28 /**
29 * This interface describes a control class that makes it easy to find out if a
30 * particular User has a given Permission. It also determines if a User has a a
31 * particular Role.
32 *
33 * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a>
34 * @version $Id$
35 */
36 public interface BasicAccessControlList extends Serializable, AccessControlList
37 {
38 /**
39 * Retrieves all groups for a user
40 *
41 * @return the set of Groups this user has
42 */
43 GroupSet getGroups();
44
45 /**
46 * Checks if the user is assigned a specific Group
47 *
48 * @param group
49 * the Group
50 * @return <code>true</code> if the user is assigned to the Group
51 */
52 boolean hasGroup(Group group);
53
54 /**
55 * Checks if the user is assigned a specific Group
56 *
57 * @param group
58 * the group name
59 * @return <code>true</code>if the user is assigned the Group.
60 */
61 boolean hasGroup(String group);
62
63 }