001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.web.tomcat.security;
023:
024: import java.security.Principal;
025: import java.util.List;
026: import java.util.Set;
027: import javax.security.auth.Subject;
028:
029: import org.apache.catalina.Realm;
030: import org.apache.catalina.realm.GenericPrincipal;
031:
032: /**
033: * An implementation of the catalina GenericPrincipal to allow caching of
034: * security manager invocation results.
035: *
036: * @author remm@jboss.org
037: * @author Scott.Stark@jboss.org
038: * @version $Revision: 57206 $
039: */
040: class JBossGenericPrincipal extends GenericPrincipal {
041: /** The authenticated user name as a Principal */
042: private Principal authPrincipal = null;
043: /** The caller principal name mapping if any */
044: private Principal callerPrincipal = null;
045: /** The authenticated user credentials */
046: private Object credentials = null;
047: /** The authenticated user Subject */
048: private Subject subject = null;
049: /** Set<Principal> of the roles assigned to the subject */
050: private Set userRoles = null;
051:
052: /**
053: * Create an encapsulation of the authenticated caller information.
054: *
055: * @param realm - the Relam implementation creating the principal
056: * @param subject - the authenticated JAAS subject
057: * @param authPrincipal - the principal used for authentication and stored in
058: * the security manager cache
059: * @param callerPrincipal - the possibly different caller principal
060: * representation of the authenticated principal
061: * @param credentials - the opaque credentials used for authentication
062: * @param roles - the List<String> of the role names assigned to the subject
063: * @param userRoles - the Set<Principal> of the roles assigned to the subject
064: */
065: JBossGenericPrincipal(Realm realm, Subject subject,
066: Principal authPrincipal, Principal callerPrincipal,
067: Object credentials, List roles, Set userRoles) {
068: super (realm, callerPrincipal.getName(), null, roles,
069: callerPrincipal);
070: this .credentials = credentials;
071: this .authPrincipal = authPrincipal;
072: this .callerPrincipal = callerPrincipal;
073: this .subject = subject;
074: this .userRoles = userRoles;
075: }
076:
077: Principal getAuthPrincipal() {
078: return this .authPrincipal;
079: }
080:
081: /**
082: * Gets the value of principal
083: *
084: * @return the value of principal
085: */
086: Principal getCallerPrincipal() {
087: return this .callerPrincipal;
088: }
089:
090: /**
091: * Gets the value of credentials
092: *
093: * @return the value of credentials
094: */
095: Object getCredentials() {
096: return this .credentials;
097: }
098:
099: Subject getSubject() {
100: return subject;
101: }
102:
103: /**
104: * Get the original set of role Principals
105: * @return Set<Princpals> for the roles assigned to the user
106: */
107: Set getUserRoles() {
108: return userRoles;
109: }
110: }
|