KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > tools > accounts > CmsAccountsToolHandler


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/accounts/CmsAccountsToolHandler.java,v $
3  * Date : $Date: 2006/07/20 10:14:23 $
4  * Version: $Revision: 1.9 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.tools.accounts;
33
34 import org.opencms.file.CmsObject;
35 import org.opencms.main.OpenCms;
36 import org.opencms.module.CmsModule;
37 import org.opencms.security.CmsRole;
38 import org.opencms.workplace.tools.A_CmsToolHandler;
39
40 /**
41  * Users management tool handler that hides the tool if the current user
42  * has not the needed privileges.<p>
43  *
44  * @author Michael Moossen
45  *
46  * @version $Revision: 1.9 $
47  *
48  * @since 6.0.0
49  */
50 public class CmsAccountsToolHandler extends A_CmsToolHandler {
51
52     /** Visibility flag module parameter name. */
53     private static final String JavaDoc PARAM_VISIBILITY_FLAG = "visibility";
54
55     /** Visibility parameter value constant. */
56     private static final String JavaDoc VISIBILITY_ALL = "all";
57
58     /** Visibility parameter value constant. */
59     private static final String JavaDoc VISIBILITY_NONE = "none";
60
61     /** Visibility parameter value constant. */
62     private static final String JavaDoc VISIBILITY_WEBUSERSONLY = "webusersonly";
63
64     /**
65      * @see org.opencms.workplace.tools.I_CmsToolHandler#isEnabled(org.opencms.file.CmsObject)
66      */
67     public boolean isEnabled(CmsObject cms) {
68
69         return cms.hasRole(CmsRole.ACCOUNT_MANAGER);
70     }
71
72     /**
73      * @see org.opencms.workplace.tools.A_CmsToolHandler#isVisible(org.opencms.file.CmsObject)
74      */
75     public boolean isVisible(CmsObject cms) {
76
77         if (getVisibilityFlag().equals(VISIBILITY_NONE)) {
78             return false;
79         }
80         if (getVisibilityFlag().equals(VISIBILITY_ALL)) {
81             return cms.hasRole(CmsRole.ACCOUNT_MANAGER);
82         }
83         if (getVisibilityFlag().equals(VISIBILITY_WEBUSERSONLY)) {
84             boolean visible = cms.hasRole(CmsRole.ACCOUNT_MANAGER);
85             visible = visible
86                 && (getPath().equals("/accounts") || getPath().indexOf("/webusers") > 0 || getPath().indexOf("/groups") > 0);
87             return visible;
88         }
89         return true;
90     }
91
92     /**
93      * Returns the visibility flag module parameter value.<p>
94      *
95      * @return the visibility flag module parameter value
96      */
97     private String JavaDoc getVisibilityFlag() {
98
99         CmsModule module = OpenCms.getModuleManager().getModule(this.getClass().getPackage().getName());
100         if (module == null) {
101             return VISIBILITY_ALL;
102         }
103         return module.getParameter(PARAM_VISIBILITY_FLAG, VISIBILITY_ALL);
104     }
105 }
106
Popular Tags