001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Group.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 group of {@link User}s in a
070: * {@link UserDatabase}. Each user that is a member of this group
071: * inherits the {@link Role}s assigned to the group.</p>
072: *
073: * @author Craig R. McClanahan
074: * @version $Revision: 1.5 $ $Date: 2002/02/10 08:06:19 $
075: * @since 4.1
076: */
077:
078: public interface Group extends Principal {
079:
080: // ------------------------------------------------------------- Properties
081:
082: /**
083: * Return the description of this group.
084: */
085: public String getDescription();
086:
087: /**
088: * Set the description of this group.
089: *
090: * @param description The new description
091: */
092: public void setDescription(String description);
093:
094: /**
095: * Return the group name of this group, which must be unique
096: * within the scope of a {@link UserDatabase}.
097: */
098: public String getGroupname();
099:
100: /**
101: * Set the group name of this group, which must be unique
102: * within the scope of a {@link UserDatabase}.
103: *
104: * @param groupname The new group name
105: */
106: public void setGroupname(String groupname);
107:
108: /**
109: * Return the set of {@link Role}s assigned specifically to this group.
110: */
111: public Iterator getRoles();
112:
113: /**
114: * Return the {@link UserDatabase} within which this Group is defined.
115: */
116: public UserDatabase getUserDatabase();
117:
118: /**
119: * Return the set of {@link User}s that are members of this group.
120: */
121: public Iterator getUsers();
122:
123: // --------------------------------------------------------- Public Methods
124:
125: /**
126: * Add a new {@link Role} to those assigned specifically to this group.
127: *
128: * @param role The new role
129: */
130: public void addRole(Role role);
131:
132: /**
133: * Is this group specifically assigned the specified {@link Role}?
134: *
135: * @param role The role to check
136: */
137: public boolean isInRole(Role role);
138:
139: /**
140: * Remove a {@link Role} from those assigned to this group.
141: *
142: * @param role The old role
143: */
144: public void removeRole(Role role);
145:
146: /**
147: * Remove all {@link Role}s from those assigned to this group.
148: */
149: public void removeRoles();
150:
151: }
|