001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.ext.dbobj;
066:
067: import com.jcorporate.expresso.core.db.DBConnection;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.dbobj.DBObject;
070: import com.jcorporate.expresso.core.dbobj.RequestContext;
071: import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
072: import com.jcorporate.expresso.core.security.User;
073:
074: /**
075: * This class allows administrators to override selected registered users
076: * to grant or deny restricted download access.
077: * <p/>
078: * This is needed since reverse lookups often fail. If you know the person
079: * isn't right, you can block them, and if you know they're ok, you can override
080: * to allow them.
081: *
082: * @author Michael Rimov
083: */
084: public class RestrictedOverrides extends SecuredDBObject {
085: static public final String FLD_EXPUID = "ExpUID";
086: static public final String FLD_ALLOWED = "IsAllowed";
087:
088: /**
089: * Returned when an override record for a particular user indicates
090: * 'allowed'
091: *
092: * @see #isAllowed
093: */
094: static public final int OVERRIDE_ALLOWED = 1;
095:
096: /**
097: * Returned when override record for a particular user is 'denied'
098: *
099: * @see #isAllowed
100: */
101: static public final int OVERRIDE_DENIED = 0;
102:
103: /**
104: * Returned when no override record is found for a particular user.
105: *
106: * @see #isAllowed
107: */
108: static public final int OVERRIDE_NOT_FOUND = -1;
109:
110: /**
111: * Constructor
112: *
113: * @throws DBException if there's an initialization problem
114: */
115: public RestrictedOverrides() throws DBException {
116: super ();
117: } /* User() */
118:
119: /**
120: * Constructor
121: *
122: * @param myConnection The database connection
123: * @throws DBException if there's an initialization problem
124: */
125: public RestrictedOverrides(DBConnection myConnection)
126: throws DBException {
127: super (myConnection);
128: } /* User(String) */
129:
130: /**
131: * Use over (String) constructor. Initializes the object in the context
132: * of the user who's uid belongs to the parameter.
133: *
134: * @param uid the Uid of the user context
135: * @throws DBException if there's an initialization problem
136: */
137: public RestrictedOverrides(int uid) throws DBException {
138: super (uid);
139: }
140:
141: /**
142: * For using DBObjects within Controllers. Initializes based upon the current
143: * user and the requested db. [Of course this can be modified later]
144: *
145: * @param request - The controller request handed to you by the framework.
146: * @throws DBException if there's an initialization problem
147: */
148: public RestrictedOverrides(RequestContext request)
149: throws DBException {
150: super (request);
151: }
152:
153: /**
154: * @return new RestrictedOverrides
155: * @throws DBException if there's an initialization problem
156: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#getThisDBObj
157: */
158: public synchronized DBObject getThisDBObj() throws DBException {
159: return new RestrictedOverrides();
160: } /* getThisDBObj() */
161:
162: /**
163: * Returns whether or not the given user has any overrided values.
164: *
165: * @param aUser a user's record to get the expUID from.
166: * @return either OVERRIDE_ALLOWED, OVERRIDE_DENIED, or OVERRIDE_NOT_FOUND
167: * @throws DBException if there's an initialization problem
168: */
169: public int isAllowed(User aUser) throws DBException {
170: int expUID = aUser.getUid();
171: this .setField(FLD_EXPUID, expUID);
172:
173: if (this .find()) {
174: if (getFieldBoolean(FLD_ALLOWED)) {
175: return OVERRIDE_ALLOWED;
176: } else {
177: return OVERRIDE_DENIED;
178: }
179: } else {
180: return OVERRIDE_NOT_FOUND;
181: }
182: }
183:
184: /**
185: * Sets up the field definitions for the DBObjkec
186: */
187: protected void setupFields() throws DBException {
188: setTargetTable("RESTRICTOVRRIDE");
189: setDescription("Restricted Downloads Overrides");
190: setCharset("ISO-8859-1");
191: addField(FLD_EXPUID, "int", 0, false, "User ID Number");
192: addField(FLD_ALLOWED, "boolean", 0, false,
193: "Is Download Allowed");
194: addKey(FLD_EXPUID);
195: getMetaData().setAttribute(FLD_ALLOWED, "checkbox", "Y");
196: } /* setupFields() */
197:
198: }
|