001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Portal/Sources/es/udc/mypersonalizer/portal/model/permissions/PermissionCheckerSingleton.java,v 1.1.1.1 2004/03/25 12:08:41 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:41 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruna
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruna nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.portal.model.permissions;
042:
043: import java.util.Collection;
044:
045: import es.udc.mypersonalizer.kernel.log.Log;
046: import es.udc.mypersonalizer.kernel.log.LogManager;
047: import es.udc.mypersonalizer.kernel.log.LogNamingConventions;
048: import es.udc.mypersonalizer.portal.config.PermissionCheckerConfig;
049: import es.udc.mypersonalizer.portal.config.PortalConfig;
050: import es.udc.mypersonalizer.portal.config.PortalConfigManager;
051:
052: /**
053: * This abstract class specifies the interface of the permissions engine
054: * providing methods to check if a user has permissions over a protected portal
055: * resource (like services or workspaces) to do a specific action.
056: *
057: * @author Abel Iago Toral Quiroga.
058: * @author Daniel Fernandez
059: * @since 1.0
060: */
061: public abstract class PermissionCheckerSingleton {
062:
063: /** Stores the unique concrete instance of this class */
064: private static PermissionCheckerSingleton instance;
065:
066: static {
067:
068: try {
069: PortalConfig portalConfig = PortalConfigManager.getConfig();
070:
071: PermissionCheckerConfig permissionCheckerConfig = portalConfig
072: .getPortalModelConfig()
073: .getPermissionCheckerConfig();
074:
075: String className = permissionCheckerConfig.getClassName();
076:
077: Class singletonClass = Class.forName(className);
078: instance = (PermissionCheckerSingleton) singletonClass
079: .newInstance();
080:
081: } catch (Exception e) {
082:
083: Log mypersonalizerLog = LogManager
084: .getLog(LogNamingConventions.MYPERSONALIZER);
085: mypersonalizerLog.write(
086: "Could not initialize configuration for "
087: + "PermissionCheckerSingleton", e,
088: PermissionCheckerSingleton.class);
089:
090: }
091:
092: }
093:
094: /**
095: * Get the unique instance of this class
096: * @return the unique instance of this class.
097: */
098: public static PermissionCheckerSingleton getInstance() {
099: return instance;
100: }
101:
102: /**
103: * Validate if a user can add a service to a workspace.
104: * @param userCredentials the user credentials, this is, the information
105: * about the user that the permissions engine needs to find out if
106: * has permissions over a portal resource (in this case a service).
107: * @param serviceIdentifier the service identifier.
108: * @param workspaceType identifies the workspace definition. All the
109: * user workspaces are instances of a workspace model (the workspace
110: * definitions), this definitions, store information about
111: * service availability, for example, the same service could be
112: * added to a workspace but not to another of the same user because
113: * these workspaces can be instances of different workspace
114: * definitions, one of which has this service in its service
115: * availability list and the other not. If the service is available
116: * on the workspace definition, the specific permissions of that
117: * service will be checked to find out if the user can add it to
118: * the workspace.
119: * @return <code>true</code> if the user can add the service to the
120: * workspace, this is, if the workspace definition associated to
121: * the the user workspace has the service available on it and the
122: * user has permissions on that service, otherwise returns
123: * <code>false</code>.
124: */
125: public abstract boolean isAllowedToAddService(
126: UserCredentials userCredentials, String serviceIdentifier,
127: String workspaceType);
128:
129: /**
130: * Validate if a user can create (add) a workspace that is an instance
131: * of a specific workspace definition.
132: * @param userCredentials the user credentials, this is, the information
133: * about the user that the permissions engine needs to find out if
134: * has permissions over a portal resource (in this case a workspace).
135: * @param workspaceType identifies the workspace definition associated to
136: * of the workspace that the user want to create. All user
137: * workspaces are instances of a workspace model (the workspace
138: * definitions), this definitions, store information about
139: * service availability and have their own permissions so a user
140: * can be allowed or not to create instances (workspaces) of them.
141: * @return <code>true</code> if the user us allowed to add the workspace,
142: * otherwise returns <code>false</code>
143: */
144: public abstract boolean isAllowedToAddWorkspace(
145: UserCredentials userCredentials, String workspaceType);
146:
147: /**
148: * Validate if a user can remove a workspace that is an instance
149: * of a specific workspace definition.
150: * @param userCredentials the user credentials, this is, the information
151: * about the user that the permissions engine needs to find out if
152: * has permissions over a portal resource (in this case a workspace).
153: * @param workspaceType Identifies the worklspace definition. All the
154: * user workspaces are instances of a workspace model (the workspace
155: * definitions), this definitions, store information about
156: * service availability and have their own permissions so a user
157: * can be allowed or not to remove instances (workspaces) of them.
158: * @return <code>true</code> if the user us allowed to remove the workspace,
159: * otherwise returns <code>false</code>
160: */
161: public abstract boolean isAllowedToRemoveWorkspace(
162: UserCredentials userCredentials, String workspaceType);
163:
164: /**
165: * Validate if a user can see and interact with a specific button related
166: * to a service.
167: * @param userCredentials the user credentials, this is, the information
168: * about the user that the permissions engine needs to find out if
169: * has permissions over a portal resource (in this case a workspace).
170: * @param serviceIdentifier the identifier for the service we're dealing
171: * with.
172: * @param serviceButtonType the type of the button
173: */
174: public abstract boolean isServiceButtonAllowed(
175: UserCredentials userCredentials, String serviceIdentifier,
176: String serviceButtonType);
177:
178: /**
179: * Get all the services (its service identifiers) that a user can have
180: * in a concrete workspace.
181: * @param userCredentials the user credentials, this is, the information
182: * about the user that the permissions engine needs to find out if
183: * has permissions over a portal resource (in this case a workspace).
184: * @param workspaceType The type of the workspace of which we want to
185: * get the information.
186: * @return a Collection of serviceIdentifiers (<code>String</code>s).
187: */
188: public abstract Collection getAllowedServiceIdentifiersInWorkspace(
189: UserCredentials userCredentials, String workspaceType);
190: }
|