KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tanukisoftware > wrapper > WrapperUser


1 package org.tanukisoftware.wrapper;
2
3 /*
4  * Copyright (c) 1999, 2006 Tanuki Software Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of the Java Service Wrapper and associated
8  * documentation files (the "Software"), to deal in the Software
9  * without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sub-license,
11  * and/or sell copies of the Software, and to permit persons to
12  * whom the Software is furnished to do so, subject to the
13  * following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21  * NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  */
27
28 import java.util.Vector JavaDoc;
29
30 /**
31  * A WrapperUser contains information about a user account on the platform
32  * running the Wrapper. A WrapperUser is obtained by calling
33  * WrapperManager.getUser() or WrapperManager.getInteractiveUser().
34  *
35  * @author Leif Mortenson <leif@tanukisoftware.com>
36  */
37 public abstract class WrapperUser
38 {
39     /* The name of the user. */
40     private String JavaDoc m_user;
41     
42     /** A list of the groups that this user is registered with.
43      * This uses a Vector to be compatable with 1.2.x JVMs. */
44     private Vector JavaDoc m_groups = new Vector JavaDoc();
45     
46     /*---------------------------------------------------------------
47      * Constructors
48      *-------------------------------------------------------------*/
49     WrapperUser( byte[] user )
50     {
51         // Decode the parameters using the default system encoding.
52 m_user = new String JavaDoc( user );
53     }
54     
55     /*---------------------------------------------------------------
56      * Methods
57      *-------------------------------------------------------------*/
58     /**
59      * Returns the name of the user.
60      *
61      * @return The name of the user.
62      */
63     public String JavaDoc getUser()
64     {
65         return m_user;
66     }
67     
68     /**
69      * Adds a group to the user.
70      *
71      * @param group WrapperGroup to be added.
72      */
73     void addGroup( WrapperGroup group )
74     {
75         m_groups.addElement( group );
76     }
77     
78     /**
79      * Returns an array of WrapperGroup instances which define the groups that
80      * the user belongs to.
81      *
82      * @return An array of WrapperGroups.
83      */
84     public WrapperGroup[] getGroups()
85     {
86         WrapperGroup[] groups = new WrapperGroup[m_groups.size()];
87         m_groups.toArray( groups );
88         
89         return groups;
90     }
91 }
92
93
Popular Tags