KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > dbobj > JobSecurity


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.services.dbobj;
66
67 import com.jcorporate.expresso.core.controller.ControllerRequest;
68 import com.jcorporate.expresso.core.db.DBException;
69 import com.jcorporate.expresso.core.dbobj.Schema;
70 import com.jcorporate.expresso.core.dbobj.SchemaFactory;
71 import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
72 import com.jcorporate.expresso.core.dbobj.ValidValue;
73 import com.jcorporate.expresso.core.job.Job;
74
75 import java.util.Enumeration JavaDoc;
76 import java.util.Iterator JavaDoc;
77 import java.util.Vector JavaDoc;
78
79
80 /**
81  * <p>JobSecurity.java</p>
82  * Copyright 1999-2002 Jcorporate Ltd.
83  * Application Security definitions:
84  * Defines which users can run which application modules.
85  *
86  * @author Michael Nash
87  * @version $Revision: 1.13 $ $Date: 2004/11/18 02:03:30 $
88  */
89 public class JobSecurity
90         extends SecurityDBObject {
91     private static Vector JavaDoc jobList = null;
92
93     /**
94      * Constructor
95      */
96     public JobSecurity()
97             throws DBException {
98         super();
99     } /* JobSecurity() */
100
101
102     /**
103      * @param uid the owning user's uid
104      */
105     public JobSecurity(int uid)
106             throws DBException {
107         super(uid);
108     }
109
110     /**
111      * For using DBObjects within Controllers. Initializes based upon the current
112      * user and the requested db. [Of course this can be modified later]
113      *
114      * @param request - The controller request handed to you by the framework.
115      */
116     public JobSecurity(ControllerRequest request)
117             throws DBException {
118         super(request);
119     }
120
121     /**
122      * @throws DBException
123      */
124     public void add()
125             throws DBException {
126
127         //Assume that because we're adding, we need to rebuild the job list.
128 jobList = null;
129
130         if (getField("Functions").equals("")) {
131             setField("Functions", "*");
132         }
133
134         super.add();
135     } /* add() */
136
137
138     /**
139      * Extends the checkAllRefs method to check for valid UserGroup
140      * or if referential integrity is violated
141      *
142      * @throws DBException If there is a problem checking the integrity
143      */
144     protected void checkAllRefs()
145             throws DBException {
146         checkRef("GroupName", new UserGroup(SecuredDBObject.SYSTEM_ACCOUNT),
147                 "Invalid " + getString(getMetaData().getDescription("GroupName")));
148     } /* checkAllRefs() */
149
150
151     /**
152      * Set up the database fields of this object
153      *
154      * @throws DBException If there is a problem setting up the fields
155      */
156     protected synchronized void setupFields()
157             throws DBException {
158         setTargetTable("JOBSECURITY");
159         setDescription("DBjobSecurity");
160         setCharset("ISO-8859-1");
161         addField("JobClass", "varchar", 130, false, "jobObjectName");
162         addField("GroupName", "char", 10, false, "groupName");
163         addField("Functions", "text", 0, false, "allowedFunctions");
164         setStringFilter("JobClass", "stripFilter");
165         setStringFilter("GroupName", "stripFilter");
166         setStringFilter("Functions", "rawFilter");
167         addKey("JobClass");
168         addKey("GroupName");
169         setMultiValued("GroupName");
170         setMultiValued("JobClass");
171         setLookupObject("GroupName",
172                 "com.jcorporate.expresso.services.dbobj.UserGroup");
173     } /* setupFields() */
174
175
176     /**
177      * Override the method getValues to provide specific values for our
178      * multi-valued fields
179      *
180      * @param fieldName Fielname to retrieve values for
181      * @return Vector of ValidValue Value/description pairs for this field
182      * @throws DBException If the values cannot be retrieved
183      */
184     public synchronized Vector JavaDoc getValidValues(String JavaDoc fieldName)
185             throws DBException {
186         if (fieldName.equals("JobClass")) {
187             if (jobList == null) {
188                 SchemaList myList = new SchemaList(SecuredDBObject.SYSTEM_ACCOUNT);
189                 myList.setDataContext(getDataContext());
190
191                 SchemaList oneList = null;
192                 jobList = new Vector JavaDoc(10);
193                 doSchema("com.jcorporate.expresso.core.ExpressoSchema",
194                         "Expresso");
195
196                 /* Now get all of the schemas listed in the database as well */
197                 for (Iterator JavaDoc sl = myList.searchAndRetrieveList().iterator();
198                      sl.hasNext();) {
199                     oneList = (SchemaList) sl.next();
200                     doSchema(oneList.getField("SchemaClass"),
201                             oneList.getField("Descrip"));
202                 } /* for each schema list */
203
204             }
205
206             return jobList;
207         }
208
209         return super.getValidValues(fieldName);
210     } /* getValidValues(String) */
211
212
213     /**
214      * @param schemaName Classname of the schema to process
215      * @param schemaDescrip The descriptive name of the schema
216      */
217     private void doSchema(String JavaDoc schemaName, String JavaDoc schemaDescrip)
218             throws DBException {
219         Schema oneSchema = SchemaFactory.getInstance().getSchema(schemaName);
220         if (oneSchema == null) {
221             throw new DBException("Error instantiating class '" + schemaName);
222
223         }
224
225         Job oneJob = null;
226         ValidValue oneVal = null;
227
228         /* Now add all of the objects in this schema to our list */
229         for (Enumeration JavaDoc e = oneSchema.getJobs(); e.hasMoreElements();) {
230             oneJob = (Job) e.nextElement();
231             oneVal = new ValidValue(oneJob.getClass().getName(),
232                     schemaDescrip + ": " + oneJob.getTitle());
233             jobList.addElement(oneVal);
234         }
235     } /* doSchema(String, String, Vector) */
236
237
238 } /* JobSecurity */
239
240 /* JobSecurity */
Popular Tags