KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > security > UserContext


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */
10
11 package org.mmbase.security;
12
13 /**
14  * This User interface defines the storage for the authentication
15  * and authorization, so that information can be shared.
16  * This interface is NOT a container class for client related stuff, altrough
17  * this is possible. Notice that after the login on the cloud it is not
18  * certain that you will receive the same User object back !
19  *
20  * @author Eduard Witteveen
21  * @version $Id: UserContext.java,v 1.17 2006/01/09 12:18:49 johannes Exp $
22  */
23 public interface UserContext extends java.io.Serializable JavaDoc {
24     /**
25      * Get the unique identifier for this user. This should be unique
26      * for every different user inside a cloud.
27      * @return an unique id for the current user
28      */
29     public String JavaDoc getIdentifier();
30
31     /**
32      * Get the rank of this user.
33      * @return the rank of this user
34      */
35     public Rank getRank();
36
37     /**
38      * Is valid
39      * @return <code>true</code> if the user is still valid.
40      * <code>false</code> if the user is expired..
41      */
42     public boolean isValid();
43
44
45     /**
46      * Return the default owner field value for new nodes created by this user.
47      * @return owner field value
48      *
49      * @since MMBase-1.7
50      */
51     public String JavaDoc getOwnerField();
52
53     /**
54      * Returns the original authentication type as specified in getCloud
55      * @return authentication type
56      *
57      * @since MMBase-1.7
58      * @see org.mmbase.bridge.CloudContext#getCloud
59      */
60     public String JavaDoc getAuthenticationType();
61
62 }
63
Popular Tags