View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.auth;
35  
36  import info.magnolia.cms.security.Permission;
37  
38  import java.io.Serializable;
39  import java.security.Principal;
40  import java.util.List;
41  
42  
43  /**
44   * @author Sameer Charles $Id: ACL.java 32667 2010-03-13 00:37:06Z gjoseph $
45   */
46  public interface ACL extends Principal, Serializable {
47  
48      /**
49       * Get name given to this principal
50       * @return name
51       */
52      public String getName();
53  
54      /**
55       * Set this principal name
56       */
57      public void setName(String name);
58  
59      /**
60       * Get repository ID for which this ACL has been constructed
61       * @return repository ID
62       */
63      public String getRepository();
64  
65      /**
66       * Set repository ID for which this ACL will be constructed
67       * @param repository
68       */
69      public void setRepository(String repository);
70  
71      /**
72       * Get workspace ID for which this ACL has been contructed
73       * @return workspace ID
74       */
75      public String getWorkspace();
76  
77      /**
78       * Set workspace ID for which this ACL will be constructed
79       * @param workspace
80       */
81      public void setWorkspace(String workspace);
82  
83      /**
84       * add permission in to an existing list
85       * @param permission
86       */
87      public void addPermission(Object permission);
88  
89      /**
90       * Initialize access control list with provided permissions it will overwrite any existing permissions set before.
91       * @param list
92       */
93      public void setList(List<Permission> list);
94  
95      /**
96       * Returns list of permissions for this principal
97       */
98      public List<Permission> getList();
99  
100 }