KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > ext > dbobj > RestrictedOverrides


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.ext.dbobj;
66
67 import com.jcorporate.expresso.core.db.DBConnection;
68 import com.jcorporate.expresso.core.db.DBException;
69 import com.jcorporate.expresso.core.dbobj.DBObject;
70 import com.jcorporate.expresso.core.dbobj.RequestContext;
71 import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
72 import com.jcorporate.expresso.core.security.User;
73
74 /**
75  * This class allows administrators to override selected registered users
76  * to grant or deny restricted download access.
77  * <p/>
78  * This is needed since reverse lookups often fail. If you know the person
79  * isn't right, you can block them, and if you know they're ok, you can override
80  * to allow them.
81  *
82  * @author Michael Rimov
83  */
84 public class RestrictedOverrides
85         extends SecuredDBObject {
86     static public final String JavaDoc FLD_EXPUID = "ExpUID";
87     static public final String JavaDoc FLD_ALLOWED = "IsAllowed";
88
89     /**
90      * Returned when an override record for a particular user indicates
91      * 'allowed'
92      *
93      * @see #isAllowed
94      */
95     static public final int OVERRIDE_ALLOWED = 1;
96
97     /**
98      * Returned when override record for a particular user is 'denied'
99      *
100      * @see #isAllowed
101      */
102     static public final int OVERRIDE_DENIED = 0;
103
104     /**
105      * Returned when no override record is found for a particular user.
106      *
107      * @see #isAllowed
108      */
109     static public final int OVERRIDE_NOT_FOUND = -1;
110
111     /**
112      * Constructor
113      *
114      * @throws DBException if there's an initialization problem
115      */
116     public RestrictedOverrides()
117             throws DBException {
118         super();
119     } /* User() */
120
121     /**
122      * Constructor
123      *
124      * @param myConnection The database connection
125      * @throws DBException if there's an initialization problem
126      */
127     public RestrictedOverrides(DBConnection myConnection)
128             throws DBException {
129         super(myConnection);
130     } /* User(String) */
131
132     /**
133      * Use over (String) constructor. Initializes the object in the context
134      * of the user who's uid belongs to the parameter.
135      *
136      * @param uid the Uid of the user context
137      * @throws DBException if there's an initialization problem
138      */
139     public RestrictedOverrides(int uid)
140             throws DBException {
141         super(uid);
142     }
143
144     /**
145      * For using DBObjects within Controllers. Initializes based upon the current
146      * user and the requested db. [Of course this can be modified later]
147      *
148      * @param request - The controller request handed to you by the framework.
149      * @throws DBException if there's an initialization problem
150      */
151     public RestrictedOverrides(RequestContext request)
152             throws DBException {
153         super(request);
154     }
155
156     /**
157      * @return new RestrictedOverrides
158      * @throws DBException if there's an initialization problem
159      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#getThisDBObj
160      */
161     public synchronized DBObject getThisDBObj()
162             throws DBException {
163         return new RestrictedOverrides();
164     } /* getThisDBObj() */
165
166
167     /**
168      * Returns whether or not the given user has any overrided values.
169      *
170      * @param aUser a user's record to get the expUID from.
171      * @return either OVERRIDE_ALLOWED, OVERRIDE_DENIED, or OVERRIDE_NOT_FOUND
172      * @throws DBException if there's an initialization problem
173      */
174     public int isAllowed(User aUser)
175             throws DBException {
176         int expUID = aUser.getUid();
177         this.setField(FLD_EXPUID, expUID);
178
179         if (this.find()) {
180             if (getFieldBoolean(FLD_ALLOWED)) {
181                 return OVERRIDE_ALLOWED;
182             } else {
183                 return OVERRIDE_DENIED;
184             }
185         } else {
186             return OVERRIDE_NOT_FOUND;
187         }
188     }
189
190     /**
191      * Sets up the field definitions for the DBObjkec
192      */
193     protected void setupFields()
194             throws DBException {
195         setTargetTable("RESTRICTOVRRIDE");
196         setDescription("Restricted Downloads Overrides");
197         setCharset("ISO-8859-1");
198         addField(FLD_EXPUID, "int", 0, false, "User ID Number");
199         addField(FLD_ALLOWED, "boolean", 0, false, "Is Download Allowed");
200         addKey(FLD_EXPUID);
201         getMetaData().setAttribute(FLD_ALLOWED, "checkbox", "Y");
202     } /* setupFields() */
203
204
205 }
Popular Tags