001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/User.java,v 1.5 2002/02/10 08:06:19 craigmcc Exp $
003: * $Revision: 1.5 $
004: * $Date: 2002/02/10 08:06:19 $
005: *
006: * ====================================================================
007: * The Apache Software License, Version 1.1
008: *
009: * Copyright (c) 2002 The Apache Software Foundation. All rights
010: * reserved.
011: *
012: * Redistribution and use in source and binary forms, with or without
013: * modification, are permitted provided that the following conditions
014: * are met:
015: *
016: * 1. Redistributions of source code must retain the above copyright
017: * notice, this list of conditions and the following disclaimer.
018: *
019: * 2. Redistributions in binary form must reproduce the above copyright
020: * notice, this list of conditions and the following disclaimer in
021: * the documentation and/or other materials provided with the
022: * distribution.
023: *
024: * 3. The end-user documentation included with the redistribution, if
025: * any, must include the following acknowlegement:
026: * "This product includes software developed by the
027: * Apache Software Foundation (http://www.apache.org/)."
028: * Alternately, this acknowlegement may appear in the software itself,
029: * if and wherever such third-party acknowlegements normally appear.
030: *
031: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
032: * Foundation" must not be used to endorse or promote products derived
033: * from this software without prior written permission. For written
034: * permission, please contact apache@apache.org.
035: *
036: * 5. Products derived from this software may not be called "Apache"
037: * nor may "Apache" appear in their names without prior written
038: * permission of the Apache Group.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
044: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
045: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
046: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Apache Software Foundation. For more
056: * information on the Apache Software Foundation, please see
057: * <http://www.apache.org/>.
058: *
059: * [Additional notices, if required by prior licensing conditions]
060: *
061: */
062:
063: package org.apache.catalina;
064:
065: import java.security.Principal;
066: import java.util.Iterator;
067:
068: /**
069: * <p>Abstract representation of a user in a {@link UserDatabase}. Each user
070: * is optionally associated with a set of {@link Group}s through which he or
071: * she inherits additional security roles, and is optionally assigned a set
072: * of specific {@link Role}s.</p>
073: *
074: * @author Craig R. McClanahan
075: * @version $Revision: 1.5 $ $Date: 2002/02/10 08:06:19 $
076: * @since 4.1
077: */
078:
079: public interface User extends Principal {
080:
081: // ------------------------------------------------------------- Properties
082:
083: /**
084: * Return the full name of this user.
085: */
086: public String getFullName();
087:
088: /**
089: * Set the full name of this user.
090: *
091: * @param fullName The new full name
092: */
093: public void setFullName(String fullName);
094:
095: /**
096: * Return the set of {@link Group}s to which this user belongs.
097: */
098: public Iterator getGroups();
099:
100: /**
101: * Return the logon password of this user, optionally prefixed with the
102: * identifier of an encoding scheme surrounded by curly braces, such as
103: * <code>{md5}xxxxx</code>.
104: */
105: public String getPassword();
106:
107: /**
108: * Set the logon password of this user, optionally prefixed with the
109: * identifier of an encoding scheme surrounded by curly braces, such as
110: * <code>{md5}xxxxx</code>.
111: *
112: * @param password The new logon password
113: */
114: public void setPassword(String password);
115:
116: /**
117: * Return the set of {@link Role}s assigned specifically to this user.
118: */
119: public Iterator getRoles();
120:
121: /**
122: * Return the {@link UserDatabase} within which this User is defined.
123: */
124: public UserDatabase getUserDatabase();
125:
126: /**
127: * Return the logon username of this user, which must be unique
128: * within the scope of a {@link UserDatabase}.
129: */
130: public String getUsername();
131:
132: /**
133: * Set the logon username of this user, which must be unique within
134: * the scope of a {@link UserDatabase}.
135: *
136: * @param username The new logon username
137: */
138: public void setUsername(String username);
139:
140: // --------------------------------------------------------- Public Methods
141:
142: /**
143: * Add a new {@link Group} to those this user belongs to.
144: *
145: * @param group The new group
146: */
147: public void addGroup(Group group);
148:
149: /**
150: * Add a {@link Role} to those assigned specifically to this user.
151: *
152: * @param role The new role
153: */
154: public void addRole(Role role);
155:
156: /**
157: * Is this user in the specified {@link Group}?
158: *
159: * @param group The group to check
160: */
161: public boolean isInGroup(Group group);
162:
163: /**
164: * Is this user specifically assigned the specified {@link Role}? This
165: * method does <strong>NOT</strong> check for roles inherited based on
166: * {@link Group} membership.
167: *
168: * @param role The role to check
169: */
170: public boolean isInRole(Role role);
171:
172: /**
173: * Remove a {@link Group} from those this user belongs to.
174: *
175: * @param group The old group
176: */
177: public void removeGroup(Group group);
178:
179: /**
180: * Remove all {@link Group}s from those this user belongs to.
181: */
182: public void removeGroups();
183:
184: /**
185: * Remove a {@link Role} from those assigned to this user.
186: *
187: * @param role The old role
188: */
189: public void removeRole(Role role);
190:
191: /**
192: * Remove all {@link Role}s from those assigned to this user.
193: */
194: public void removeRoles();
195:
196: }
|