KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > User


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 import java.util.Enumeration JavaDoc;
58
59 /**
60  ** The <CODE>User</CODE> interface is an abstract view on the
61  ** user-specific data. Apart from a set of pre-defined, fixed set
62  ** of attributes, the interface gives access to dynamic data
63  ** as well.
64  **
65  ** <P>
66  ** To enable a portlet to access dynamic data, the naming conventions
67  ** of the portlet container have to be propagated to the portlet. It
68  ** is recommended to do so through the portlet configuration. For
69  ** example, if the portlet wants to access an "address" attribute, it
70  ** should query its configuration for the dynamic data name of the
71  ** "address" attribute for this particular installation. If no such
72
73  **
74  ** <P>
75  ** <I>
76  ** This interface has to be properly thought through. What are the
77  ** the essential attributes? Should some be fixed (ie. the essentials)
78  ** or all be dynamic?
79  ** </I>
80  **
81  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
82  **/
83
84 public interface User
85 {
86     /**
87      ** Returns the user id.
88      **
89      ** @return the user id
90      **/
91
92     public String JavaDoc getID ();
93
94     /**
95      ** Returns the given (aka first) name of the user.
96      **
97      ** @return the given name
98      **/
99
100     public String JavaDoc getGivenName ();
101
102     /**
103      ** Returns the middle names of the user.
104      **
105      ** @return the middle names
106      **/
107
108     public String JavaDoc getMiddleNames ();
109
110     /**
111      ** Returns the family (aka last) name of the user.
112      **
113      ** @return the family name
114      **/
115
116     public String JavaDoc getFamilyName ();
117
118     /**
119      ** Returns the nick name of the user.
120      **
121      ** @return the nick name
122      **/
123
124     public String JavaDoc getNickName ();
125
126     /**
127      ** Returns the point of time that this was last logged in,
128      ** or <CODE>null</CODE> if this information is not available.
129      ** The time is returned in number of milliseconds since
130      ** January 1, 1970 GMT.
131      **
132      ** @return the last login time
133      **/
134
135     public long getLastLoginTime ();
136
137     /**
138      * Returns whether the user is logged in or not.
139      *
140      * @return True if the user is logged in.
141      */
142     public boolean isLoggedIn();
143
144 }
145
Popular Tags