KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > om > ScarabUserManager


1 package org.tigris.scarab.om;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. 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 are
8  * 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 the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import java.util.List JavaDoc;
50
51 import org.apache.torque.TorqueException;
52 import org.apache.torque.util.Criteria;
53
54 import org.tigris.scarab.tools.localization.L10NKeySet;
55 import org.tigris.scarab.util.AnonymousUserUtil;
56 import org.tigris.scarab.util.ScarabException;
57
58 import org.apache.fulcrum.security.TurbineSecurity;
59 import org.apache.fulcrum.security.util.DataBackendException;
60 import org.apache.fulcrum.security.util.UnknownEntityException;
61
62 /**
63  * This class manages ScarabUser objects.
64  *
65  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
66  * @author <a HREF="mailto:jon@collab.net">Jon S. Stevens</a>
67  * @version $Id: ScarabUserManager.java 9360 2005-01-04 01:31:06Z dabbous $
68  */
69 public class ScarabUserManager
70     extends BaseScarabUserManager
71 {
72     /**
73      * Creates a new <code>ScarabUserManager</code> instance.
74      *
75      * @exception TorqueException if an error occurs
76      */
77     public ScarabUserManager()
78         throws TorqueException
79     {
80         super();
81         setRegion(getClassName().replace('.', '_'));
82     }
83
84     /**
85      * @return null if there is an UnknownEntityException
86      */
87     protected ScarabUser getInstanceImpl()
88     {
89         ScarabUser user = null;
90         try
91         {
92             user = (ScarabUser) AnonymousUserUtil.getAnonymousUser();
93         }
94         catch (UnknownEntityException uee)
95         {
96         }
97         catch (DataBackendException e)
98         {
99         }
100         return user;
101     }
102
103     /**
104      * Return an instance of User based on username. Domain is currently
105      * unused.
106      */
107     public static ScarabUser getInstance(String JavaDoc username, String JavaDoc domainName)
108         throws Exception JavaDoc
109     {
110         return getManager().getInstanceImpl(username, domainName);
111     }
112
113     /**
114      * Gets a list of ScarabUsers based on usernames. Domain is currently
115      * unused.
116      *
117      * @param usernames a <code>String[]</code> value
118      * @return a <code>List</code> value
119      * @exception Exception if an error occurs
120      */
121     public static List JavaDoc getUsers(String JavaDoc[] usernames, String JavaDoc domainName)
122         throws Exception JavaDoc
123     {
124         return getManager().getUsers(usernames, domainName);
125     }
126
127     /**
128      * Return an instance of User based on username. Domain is currently
129      * unused.
130      */
131     protected ScarabUser getInstanceImpl(String JavaDoc username, String JavaDoc domainName)
132         throws Exception JavaDoc
133     {
134         ScarabUser user = null;
135         if (username != null)
136         {
137             Criteria crit = new Criteria();
138             crit.add(ScarabUserImplPeer.USERNAME, username);
139             List JavaDoc users = ScarabUserImplPeer.doSelect(crit);
140             if (users.size() == 1)
141             {
142                 user = (ScarabUser)users.get(0);
143             }
144             else if (users.size() > 1)
145             {
146                 throw new ScarabException(L10NKeySet.ExceptionDuplicateUsername);
147             }
148         }
149         return user;
150     }
151    
152 }
153
154
155
156
157
158
Popular Tags