KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > dataobjects > Securable


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 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 package com.jcorporate.expresso.core.dataobjects;
65
66 /**
67  * Interface to described a database object that is subject to security constraints.
68  * Expresso treats instances of Securable as something that can be checked on a state
69  * by state basis. Expresso uses a global setup value to determine whether non-Securable
70  * DBObjects can be granted user access through items such as DBMaint.
71  * <p>All classed derived from com.jcorporate.expresso.core.dbobj.SecuredDBObject
72  * automatically implement the Securable interface</p>
73  * <p/>
74  * Typical Usage:
75  * <code><pre>
76  * Securable s = new com.jcorporate.expresso.services.dbobj.MimeTypes();
77  * s.setRequestingUid(request.getUid());
78  * try {
79  * s.isAllowed("S");
80  * System.out.println("User " + request.getUid() + " can search MimeTypes table");
81  * } catch (java.lang.SecurityException ex) {
82  * System.out.println("User " + request.getUid() +
83  * " does not have permission to search MimeTypes table";
84  * }
85  * </pre></code>
86  * </p>
87  *
88  * @author Michael Rimov
89  * @since Expresso 5.1
90  */
91 public interface Securable {
92
93
94     /**
95      * ID for system account. System account bypasses all security checking
96      * in the system for the particular dbobject. So often you need to use
97      * it with caution.
98      */
99     public static final int SYSTEM_ACCOUNT = -1;
100
101     /**
102      * Retrieve the uid of the user who's security permissions we're
103      * using.
104      *
105      * @return integer The UID of the user
106      */
107     public int getRequestingUid();
108
109
110     /**
111      * New version of "setUser()" to to speak.
112      *
113      * @param newUid Sets the UID for this DBObject. Used for security checks.
114      * @throws DBException if there's a problem switching UID.
115      * @since Expresso 4.0
116      */
117     public void setRequestingUid(int newUid);
118
119
120     /**
121      * Throws a Security Exception if the user given by the earlier setRequestingUid()
122      * function does not have permission for the given function.. However, if a non-dataobject
123      * type class implements this interface, isAllowed() may vary depending on use.
124      *
125      * @param requestedFunction the Requested function String, either A,U,S,D for
126      * Add,Update,Search,Delete
127      * @throws SecurityException if the user is not allowed
128      */
129     public void isAllowed(String JavaDoc requestedFunction)
130             throws SecurityException JavaDoc, com.jcorporate.expresso.core.db.DBException;
131
132 }
Popular Tags