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.services.dbobj;
066:
067: import com.jcorporate.expresso.core.controller.Controller;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.dbobj.RequestContext;
070: import com.jcorporate.expresso.core.servlet.StdServlet;
071:
072: /**
073: * Controller Security indicates which of the controllers contained in a schema
074: * can be accessed by which groups of users. This table is populated
075: * by the initialize process (DBCreate servlet) with all of the
076: * appropriate data for a given schema
077: *
078: * @author Michael Nash
079: */
080: public class ControllerSecurity extends SecurityDBObject {
081:
082: /**
083: * field names
084: */
085: public static final String CONTROLLER_CLASS = "ControllerClass";
086: public static final String GROUP_NAME = "GroupName";
087: public static final String STATES = "States";
088:
089: /**
090: * wildcard used to indicate any state
091: */
092: public static final String ANY_STATE_WILDCARD = "*";
093:
094: /**
095: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject
096: */
097: public ControllerSecurity() throws DBException {
098: super ();
099: } /* ControllerSecurity() */
100:
101: /**
102: * Constructor initializes the user context for this object too
103: *
104: * @param uid the user id of the owner object
105: */
106: public ControllerSecurity(int uid) 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 ControllerSecurity(RequestContext request)
117: throws DBException {
118: super (request);
119: }
120:
121: /**
122: * Extend add to provide default values for the States field if it
123: * is left empty
124: */
125: public void add() throws DBException {
126: if (getField(STATES).equals("")) {
127: setField(STATES, ANY_STATE_WILDCARD);
128: }
129:
130: super .add();
131: } /* add() */
132:
133: /**
134: * Extend the getField object to return the virtual fields
135: *
136: * @param fieldName the field name to retrieve
137: * @return java.lang.String the name of the value
138: */
139: public String getField(String fieldName) throws DBException {
140: if (fieldName.equals("ControllerDescrip")) {
141: StdServlet serv;
142: Controller con;
143:
144: try {
145: Class c = Class.forName(getField(CONTROLLER_CLASS));
146: Object o = c.newInstance();
147:
148: if (o instanceof Controller) {
149: con = (Controller) o;
150:
151: return con.getTitle();
152: } else if (o instanceof StdServlet) {
153: serv = (StdServlet) o;
154:
155: return serv.getTitle();
156: } else {
157: return ("Unknown");
158: }
159: } catch (ClassNotFoundException cn) {
160: return ("Controller/Servlet object "
161: + getField(CONTROLLER_CLASS) + " not found");
162: } catch (InstantiationException ie) {
163: return ("Controller object "
164: + getField(CONTROLLER_CLASS) + " cannot be instantiated");
165: } catch (IllegalAccessException iae) {
166: return ("Illegal access loading Controller object");
167: }
168: } /* descrip field */
169:
170: return super .getField(fieldName);
171: } /* getField(String) */
172:
173: /**
174: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
175: */
176: public void setupFields() throws DBException {
177: setTargetTable("CONTROLLERSECURITY");
178: setDescription("DBcontrollerSecurity");
179: setCharset("ISO-8859-1");
180: addField(CONTROLLER_CLASS, "char", 128, false,
181: "controllerClass");
182: addVirtualField("ControllerDescrip", "varchar", 80,
183: "controllerDescription");
184: addField(GROUP_NAME, "char", 10, false, "group");
185: addField(STATES, "text", 0, false, "allowedStates");
186: setStringFilter(CONTROLLER_CLASS, "stripFilter");
187: setStringFilter(GROUP_NAME, "stripFilter");
188: setStringFilter(STATES, "rawFilter");
189: addKey(CONTROLLER_CLASS);
190: addKey(GROUP_NAME);
191: setMultiValued(GROUP_NAME);
192: setLookupObject(GROUP_NAME, UserGroup.class.getName());
193: } /* setupFields() */
194:
195: /**
196: * Extend setField to trim all field values
197: *
198: * @param fieldName The name of the field to set
199: * @param fieldValue The new value for the field
200: */
201: public void setField(String fieldName, String fieldValue)
202: throws DBException {
203: if (fieldValue != null) {
204: super .setField(fieldName, fieldValue.trim());
205: } else {
206: super .setField(fieldName, (String) null);
207: }
208: } /* setField(String, String) */
209:
210: } /* ControllerSecurity */
|