View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.jaas.principal;
35  
36  import info.magnolia.cms.security.auth.ACL;
37  
38  import java.util.ArrayList;
39  import java.util.List;
40  
41  import org.apache.commons.lang.StringUtils;
42  import org.apache.commons.lang.builder.ToStringBuilder;
43  import org.apache.commons.lang.builder.ToStringStyle;
44  
45  
46  /**
47   * This class represents access control list as a principal.
48   * @author Sameer Charles $Id: ACLImpl.java 50229 2011-10-20 16:10:16Z tmattsson $
49   * @deprecated since 4.5 use {@link info.magnolia.cms.security.ACLImpl} instead
50   */
51  @Deprecated
52  public class ACLImpl implements ACL {
53  
54      /**
55       * Stable serialVersionUID.
56       */
57      private static final long serialVersionUID = 222L;
58  
59      private static final String NAME = "acl";
60  
61      private String name;
62  
63      private final List list;
64  
65      public ACLImpl() {
66          this.list = new ArrayList();
67      }
68  
69      /**
70       * Get name given to this principal.
71       * @return name
72       */
73      @Override
74      public String getName() {
75          if (StringUtils.isEmpty(this.name)) {
76              return NAME;
77          }
78          return this.name;
79      }
80  
81      /**
82       * Set this principal name.
83       */
84      public void setName(String name) {
85          this.name = name;
86      }
87  
88      /**
89       * Adds permission in to the list of permissions for this principal.
90       * @param permission
91       */
92      public void addPermission(Object permission) {
93          this.list.add(permission);
94      }
95  
96      /**
97       * Initialize access control list with provided permissions it will overwrite any existing permissions set before.
98       * @param list
99       */
100     public void setList(List list) {
101         this.list.clear();
102         this.list.addAll(list);
103     }
104 
105     /**
106      * Returns list of permissions for this principal. Returned list is not a copy and should be treated as read only!
107      */
108     @Override
109     public List getList() {
110         return this.list;
111     }
112 
113     /**
114      * @see java.lang.Object#toString()
115      */
116     @Override
117     public String toString() {
118         return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
119                 .append("name", this.name)
120                 .append("list", this.list)
121                 .toString();
122     }
123 
124 }