org.jboss.security.SubjectInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picketbox
PicketBox is a security framework for Java Applications
There is a newer version: 5.1.0.Final
/*
  * JBoss, Home of Professional Open Source
  * Copyright 2006, JBoss Inc., and individual contributors as indicated
  * by the @authors tag. See the copyright.txt in the distribution for a
  * full listing of individual contributors.
  *
  * This is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as
  * published by the Free Software Foundation; either version 2.1 of
  * the License, or (at your option) any later version.
  *
  * This software is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this software; if not, write to the Free
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
package org.jboss.security;

import org.jboss.security.identity.Identity;
import org.jboss.security.identity.IdentityFactory;
import org.jboss.security.identity.RoleGroup;
import org.jboss.security.identity.extensions.CredentialIdentityFactory;

import javax.security.auth.Subject;
import java.io.Serializable;
import java.security.Principal;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;


/**
 *  Holds information - principal, credential and subject
 *  This class is handled by the Util class associated with the security context
 *  @see SecurityContextUtil
 *  @author Anil Saldhana
 *  @since  Dec 26, 2006 
 *  @version $Revision$
 */
public class SubjectInfo implements Serializable
{ 
   private static final long serialVersionUID = 1L; 
   private Subject authenticatedSubject;
   
   private RoleGroup roles;
   
   private Set identities;
   
   SubjectInfo(Principal principal, Object credential,Subject subject)
   { 
      this.addIdentity( IdentityFactory.getIdentity(principal, credential ) );
      this.authenticatedSubject = subject;
   }  
   
   /**
    * Create a SubjectInfo
    * @param identity
    * @param theSubject
    */
   SubjectInfo(Identity identity, Subject theSubject)
   {
      this.addIdentity(identity);
      this.authenticatedSubject = theSubject;
   }
   
   public Subject getAuthenticatedSubject()
   {
      return authenticatedSubject;
   }
   
   public void setAuthenticatedSubject(Subject authenticatedSubject)
   {
      this.authenticatedSubject = authenticatedSubject;
   }

   public RoleGroup getRoles()
   {
      return roles;
   }

   public void setRoles(RoleGroup roles)
   {
      this.roles = roles;
   } 
   
   public synchronized void addIdentity(Identity id)
   {
      if(identities == null)
         identities = new HashSet();
      if( id != null )
      {
         Identity identity = getIdentity( id.getClass() );
         if( identity == CredentialIdentityFactory.NULL_IDENTITY )
            removeIdentity( identity );  
      }
      
      identities.add(id);   
   }
   
   @SuppressWarnings("unchecked")
   public synchronized  T getIdentity(Class clazz)
   {
      if( clazz == null )
         throw PicketBoxMessages.MESSAGES.invalidNullArgument("clazz");
      if(this.identities != null)
      {
         for(Identity id:identities)
         {
            if( id == null )
               break;
            Class idClass = id.getClass();
            if(clazz.isAssignableFrom( idClass ))
               return (T) id; 
         }
      }
      return null;
   }
   
   public Set getIdentities()
   {
      return Collections.unmodifiableSet(identities);
   }

   public synchronized void setIdentities(Set ids)
   {
      if(identities == null)
         identities = new HashSet();
      identities.addAll(ids);
   }
   
   /**
    * Remove an identity
    * @param id
    */
   public synchronized void removeIdentity( Identity id )
   {
      identities.remove( id );
   }

   @Override
   public synchronized String toString()
   {
      StringBuilder builder = new StringBuilder(); 
      builder.append("Identities=" + this.identities);
      builder.append(" Subject=" + this.authenticatedSubject);
      builder.append(" Roles=" +  this.roles);
      return builder.toString();
   } 
}