001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/realm/GenericPrincipal.java,v 1.4 2001/10/27 20:29:03 craigmcc Exp $
003: * $Revision: 1.4 $
004: * $Date: 2001/10/27 20:29:03 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.realm;
065:
066: import java.security.Principal;
067: import java.util.Arrays;
068: import java.util.List;
069: import org.apache.catalina.Realm;
070:
071: /**
072: * Generic implementation of <strong>java.security.Principal</strong> that
073: * is available for use by <code>Realm</code> implementations.
074: *
075: * @author Craig R. McClanahan
076: * @version $Revision: 1.4 $ $Date: 2001/10/27 20:29:03 $
077: */
078:
079: public class GenericPrincipal implements Principal {
080:
081: // ----------------------------------------------------------- Constructors
082:
083: /**
084: * Construct a new Principal, associated with the specified Realm, for the
085: * specified username and password.
086: *
087: * @param realm The Realm that owns this Principal
088: * @param name The username of the user represented by this Principal
089: * @param password Credentials used to authenticate this user
090: */
091: public GenericPrincipal(Realm realm, String name, String password) {
092:
093: this (realm, name, password, null);
094:
095: }
096:
097: /**
098: * Construct a new Principal, associated with the specified Realm, for the
099: * specified username and password, with the specified role names
100: * (as Strings).
101: *
102: * @param realm The Realm that owns this principal
103: * @param name The username of the user represented by this Principal
104: * @param password Credentials used to authenticate this user
105: * @param roles List of roles (must be Strings) possessed by this user
106: */
107: public GenericPrincipal(Realm realm, String name, String password,
108: List roles) {
109:
110: super ();
111: this .realm = realm;
112: this .name = name;
113: this .password = password;
114: if (roles != null) {
115: this .roles = new String[roles.size()];
116: this .roles = (String[]) roles.toArray(this .roles);
117: if (this .roles.length > 0)
118: Arrays.sort(this .roles);
119: }
120:
121: }
122:
123: // ------------------------------------------------------------- Properties
124:
125: /**
126: * The username of the user represented by this Principal.
127: */
128: protected String name = null;
129:
130: public String getName() {
131: return (this .name);
132: }
133:
134: /**
135: * The authentication credentials for the user represented by
136: * this Principal.
137: */
138: protected String password = null;
139:
140: public String getPassword() {
141: return (this .password);
142: }
143:
144: /**
145: * The Realm with which this Principal is associated.
146: */
147: protected Realm realm = null;
148:
149: public Realm getRealm() {
150: return (this .realm);
151: }
152:
153: /**
154: * The set of roles associated with this user.
155: */
156: protected String roles[] = new String[0];
157:
158: public String[] getRoles() {
159: return (this .roles);
160: }
161:
162: // --------------------------------------------------------- Public Methods
163:
164: /**
165: * Does the user represented by this Principal possess the specified role?
166: *
167: * @param role Role to be tested
168: */
169: public boolean hasRole(String role) {
170:
171: if (role == null)
172: return (false);
173: return (Arrays.binarySearch(roles, role) >= 0);
174:
175: }
176:
177: /**
178: * Return a String representation of this object, which exposes only
179: * information that should be public.
180: */
181: public String toString() {
182:
183: StringBuffer sb = new StringBuffer("GenericPrincipal[");
184: sb.append(this .name);
185: sb.append("]");
186: return (sb.toString());
187:
188: }
189:
190: }
|