baseuserdatasource.java

一个免费的CA,基于EJB平台的,老师叫我们测试,现把之共享出来让大家参考

/*************************************************************************
 *                                                                       *
 *  EJBCA: The OpenSource Certificate Authority                          *
 *                                                                       *
 *  This software 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 any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
 
package org.ejbca.core.model.ra.userdatasource;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;

import org.ejbca.core.model.UpgradeableDataHashMap;
import org.ejbca.core.model.log.Admin;



/**
 * BaseUserDataSource is a basic class that should be inherited by all types
 * of userdatasources in the system.
 * 
 * Contains data like description, applicable CAs and modifyable fields.
 *  
 *
 * @version $Id: BaseUserDataSource.java,v 1.1 2006/07/20 17:47:26 herrvendil Exp $
 */
public abstract class BaseUserDataSource extends UpgradeableDataHashMap implements Serializable, Cloneable {
    // Default Values
    

    public static final String TRUE  = "true";
    public static final String FALSE = "false";
    
    /** Constant indicating that any CA can be used with this user data source.*/
    public static final int ANYCA = -1;

    // Protected Constants.
	public static final String TYPE                           = "type";
	
    protected static final String DESCRIPTION                 = "DESCRIPTION";
    protected static final String APPLICABLECAS                = "APPLICABLECAS";
    protected static final String MODIFYABLEFIELDS            = "MODIFYABLEFIELDS";
		
    // Public Methods

    /**
     * Creates a new instance of CertificateProfile
     */
    public BaseUserDataSource() {
      setDescription("");	
      
      ArrayList applicablecas = new ArrayList();
      setApplicableCAs(applicablecas);
      
      HashSet modifyableFields = new HashSet();
      for(int i=0; i< UserDataSourceVO.AVAILABLEMODIFYABLEFIELDS.length; i++){
    	  modifyableFields.add(new Integer(UserDataSourceVO.AVAILABLEMODIFYABLEFIELDS[i]));
      }
      setModifiableFields(modifyableFields);
  
    }

    // Public Methods mostly used by PrimeCard
    /**
     * Returns the description of publisher
     */
    public String getDescription() { return (String) data.get(DESCRIPTION);}

	/**
	 * Sets the description. 
	 */
	public void setDescription(String description){ data.put(DESCRIPTION, description); }

    /**
     * Returns a Collections of caids (Integer), indicating which CAs the user data source should
     * be applicable to.
     *
     * If it contains the constant ANYCA then the user data source is applicable to all CAs
     */
    public Collection getApplicableCAs(){
      return (Collection) data.get(APPLICABLECAS);   
    }
    
    /**
     * Saves the  list of CAs the  user data source is applicable to.
     *
     * @param applicablecas a Collection of caids (Integer)
     */
    
    public void setApplicableCAs(Collection applicablecas){
      data.put(APPLICABLECAS, applicablecas);   
    }
    
    /**
     * 
     * @return true if user data source is applicable for all CAs
     */
    public boolean isApplicableToAnyCA(){
    	return ((Collection) data.get(APPLICABLECAS)).contains(new Integer(ANYCA));
    } 
    
    /**
     * Returns a Set of UserDataSourceVO.ISMODIFYABLE_ and DNFIELDExtractor constants (Integer) constants (All definded in the UserDataSourceVO.AVAILABLEMODIFYABLEFIELDS, 
     * indicating if the field should be modifyable by the CA or not.
     *
     */
    public Set getModifiableFields(){
      return (Set) data.get(MODIFYABLEFIELDS);   
    }
    
    /**
     * Saves the set of which fields of the CA that should be modifyable by the RA or not.
     * The set should only contain UserDataSourceVO.ISMODIFYABLE_ and DNFIELDExtractor constants (Integer)
     */
    
    public void setModifiableFields(Set modifiableFields){	
      data.put(MODIFYABLEFIELDS, modifiableFields);   
    }
    
    /**
     * Method that returns the fetched UserDataSourceVOs with the isModifyableset set.
     * This method should be used by external UserDataSource callers
     */    
    public  Collection fetchUserDataSourceVOs(Admin admin, String searchstring) throws UserDataSourceException{
    	Collection result = fetch(admin,searchstring);
    	
    	Set isModifyable = getModifiableFields();
    	Iterator iter = result.iterator();
    	while(iter.hasNext()){
    		UserDataSourceVO next = (UserDataSourceVO) iter.next();
    		next.setIsModifyableSet(isModifyable);
    	}
    	return result;
    }
    
    // Abstact methods.
    
    /**
     * Searches for userdata given the searchstring
     *
     * @param searchstring the string the user data source should use to look for the data.
     *
     * @return a collection of UserDataSourceVO, returns an Empty Collection if no userdata could be found
     *
     * @throws UserDataSourceException if a communication or other error occurs.
     */    
    protected abstract Collection fetch(Admin admin, String searchstring) throws UserDataSourceException;
	

    
    /**
     * Method used to test the connection to a user data source.
     * 
     * @param admin the administrator perfoming the test
     * @throws UserDataSourceConnectionException when a connection couldn't be set up correctly in any way.
     */
    public abstract void testConnection(Admin admin) throws UserDataSourceConnectionException;
    

    public abstract Object clone() throws CloneNotSupportedException;

    
    public abstract float getLatestVersion();

    
    public void upgrade(){
    	// Performing upgrade rutines
    }
    
	

}