View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 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 info.magnolia.cms.util.UrlPattern;
37  
38  import java.io.Serializable;
39  import java.util.Hashtable;
40  import java.util.Map;
41  
42  
43  /**
44   * Concrete implementation of {@link Permission} using {@link UrlPattern} to match pathes.
45   * @author Sameer Charles
46   */
47  public class PermissionImpl implements Permission, Serializable {
48  
49      /**
50       * Stable serialVersionUID.
51       */
52      private static final long serialVersionUID = 222L;
53  
54      private static Map<Long, String> nameStrings = new Hashtable<Long, String>();
55  
56      static {
57          nameStrings.put(Long.valueOf(0), "none");
58          nameStrings.put(Long.valueOf(Permission.ADD), Permission.PERMISSION_NAME_ADD);
59          nameStrings.put(Long.valueOf(Permission.SET), Permission.PERMISSION_NAME_SET);
60          nameStrings.put(Long.valueOf(Permission.REMOVE), Permission.PERMISSION_NAME_REMOVE);
61          nameStrings.put(Long.valueOf(Permission.READ), Permission.PERMISSION_NAME_READ);
62          nameStrings.put(Long.valueOf(Permission.EXECUTE), Permission.PERMISSION_NAME_EXECUTE);
63          nameStrings.put(Long.valueOf(Permission.SYNDICATE), Permission.PERMISSION_NAME_SYNDICATE);
64          nameStrings.put(Long.valueOf(Permission.ALL), Permission.PERMISSION_NAME_ALL);
65          nameStrings.put(Long.valueOf(Permission.WRITE), Permission.PERMISSION_NAME_WRITE);
66      }
67  
68      private UrlPattern pattern;
69  
70      private long permissions;
71  
72      @Override
73      public void setPattern(UrlPattern value) {
74          this.pattern = value;
75      }
76  
77      @Override
78      public UrlPattern getPattern() {
79          return this.pattern;
80      }
81  
82      @Override
83      public void setPermissions(long value) {
84          this.permissions = value;
85      }
86  
87      @Override
88      public long getPermissions() {
89          return this.permissions;
90      }
91  
92      @Override
93      public boolean match(String path) {
94          return this.pattern.match(path);
95      }
96  
97      @Override
98      public String toString() {
99          return getPermissionAsName(permissions) + " " + pattern;
100     }
101 
102     public static String getPermissionAsName(long permission) {
103         final String name = nameStrings.get(Long.valueOf(permission));
104         if (name == null) {
105             return "[unknown permission]";
106         }
107         return name;
108     }
109 }