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.cms.core;
35  
36  import info.magnolia.cms.security.AccessDeniedException;
37  import info.magnolia.cms.security.AccessManager;
38  import info.magnolia.cms.security.PermissionImpl;
39  
40  import java.text.MessageFormat;
41  
42  
43  
44  /**
45   * Simply utility class for AccessManager.
46   *
47   * @version $Id: Access.java 50440 2011-10-27 06:17:34Z had $
48   */
49  public final class Access {
50  
51      /**
52       * Utility class, don't instantiate.
53       */
54      private Access() {
55          // unused
56      }
57  
58      /**
59       * Checks if the given AccessManager allows specified permission on the given path.
60       * If no AccessManager is passed, the permission is assumed granted, no exception is thrown.
61       *
62       * @throws AccessDeniedException if the permission isn't granted.
63       * @deprecated AccessManager is no longer supported and used. Use JCR Session based security instead.
64       */
65      @Deprecated
66      public static void isGranted(AccessManager manager, String path, long permissions) throws AccessDeniedException {
67          if (manager != null && !manager.isGranted(path, permissions)) {
68              throw new AccessDeniedException(MessageFormat.format("User not allowed to {0} path [{1}]", PermissionImpl.getPermissionAsName(permissions), path));
69          }
70      }
71  }