View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security;
35  
36  import java.io.Serializable;
37  import java.util.List;
38  
39  
40  /**
41   * Handles ACL checks and knows the users permissions.
42   */
43  public interface AccessManager extends Serializable {
44  
45      /**
46       * Determines wether the specified permissions are granted to the given path.
47       *
48       * @param path path for which permissions are checked
49       * @param permissions permission mask
50       * @return true if this accessmanager has permissions to the specified path
51       */
52      boolean isGranted(String path, long permissions);
53  
54      /**
55       * Sets the list of permissions this manager will use to determine access, implementation is free to define the
56       * structure of this list.
57       */
58      void setPermissionList(List<Permission> permissions);
59  
60      /**
61       * Get permission list assigned to this access manager.
62       */
63      List<Permission> getPermissionList();
64  
65      /**
66       * Get permissions assigned to the given path.
67       *
68       * @param path for which permissions are requested
69       * @return permission mask
70       * @see Permission all possible permissions
71       */
72      long getPermissions(String path);
73  }