ihardtokensessionremote.java

一套JAVA的CA证书签发系统.

/*************************************************************************
 *                                                                       *
 *  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 se.anatom.ejbca.hardtoken;
import java.rmi.RemoteException;
import java.security.cert.X509Certificate;
import java.util.Collection;
import java.util.HashMap;
import java.util.TreeMap;

import se.anatom.ejbca.hardtoken.hardtokenprofiles.HardTokenProfile;
import se.anatom.ejbca.hardtoken.hardtokentypes.HardToken;
import se.anatom.ejbca.log.Admin;
import se.anatom.ejbca.ra.UserAdminData;

/**
 *
 * @version $Id: IRaAdminSessionRemote.java,v 1.10 2003/01/19 09:40:14 herrvendil Exp $
 */
public interface IHardTokenSessionRemote extends javax.ejb.EJBObject {
    
    public final static int NO_ISSUER = 0;

	/**
	 * Adds a hard token profile to the database.
	 *
	 * @throws HardTokenExistsException if hard token profile already exists.
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void addHardTokenProfile(Admin admin, String name, HardTokenProfile profile) throws HardTokenProfileExistsException, RemoteException;


	/**
	 * Adds a hard token profile to the database with a given id.
	 * Should only be used when importing and exporting profiles to xml-files. 
	 *
	 * @throws HardTokenExistsException if hard token profile already exists.
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void addHardTokenProfile(Admin admin, int profileid, String name, HardTokenProfile profile) throws HardTokenProfileExistsException, RemoteException;
	
	/**
	 * Updates hard token profile data
	 *
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void changeHardTokenProfile(Admin admin, String name, HardTokenProfile profile) throws RemoteException;

	 /**
	 * Adds a hard token profile with the same content as the original profile,
	 *
     * @throws HardTokenExistsException if hard token profile already exists.
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void cloneHardTokenProfile(Admin admin, String oldname, String newname) throws HardTokenProfileExistsException, RemoteException;
	 /**
	 * Removes a hard token profile from the database.
	 *
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void removeHardTokenProfile(Admin admin, String name) throws RemoteException;
	 /**
	 * Renames a hard token profile
	 *
	 * @throws HardTokenExistsException if hard token profile already exists.
	 * @throws EJBException if a communication or other error occurs.
	 */
	public void renameHardTokenProfile(Admin admin, String oldname, String newname) throws HardTokenProfileExistsException, RemoteException;
	
	/**
	 * Retrives a Collection of id:s (Integer) to authorized profiles.
	 *
	 * @return Collection of id:s (Integer)
	 */
	public Collection getAuthorizedHardTokenProfileIds(Admin admin) throws RemoteException;
	
	/**
	 * Method creating a hashmap mapping profile id (Integer) to profile name (String).
	 */    
	public HashMap getHardTokenProfileIdToNameMap(Admin admin) throws RemoteException;

	/**
	 * Retrives a named hard token profile.
	 */
	public HardTokenProfile getHardTokenProfile(Admin admin, String name) throws RemoteException;
	
	 /**
	  * Finds a hard token profile by id.
	  *
	  *
	  */
	public HardTokenProfile getHardTokenProfile(Admin admin, int id) throws RemoteException;
	
	/**
	 * Help method used by hard token profile proxys to indicate if it is time to
	 * update it's profile data.
	 *	 
	 */
	
	public int getHardTokenProfileUpdateCount(Admin admin, int hardtokenprofileid) throws RemoteException;

	 /**
	 * Returns a hard token profile id, given it's hard token profile name
	 *	 
	 *
	 * @return the id or 0 if hardtokenprofile cannot be found.
	 */
	public int getHardTokenProfileId(Admin admin, String name) throws RemoteException;
	
	 /**
	  * Returns a hard token profile name given its id.
	  *
	  * @return the name or null if id noesnt exists
	  * @throws EJBException if a communication or other error occurs.
	  */
	public String getHardTokenProfileName(Admin admin, int id) throws RemoteException;

	/**
	* Method to check if a certificate profile exists in any of the hard token profiles. 
	* Used to avoid desyncronization of certificate profile data.
	*
	* @param certificateprofileid the certificateprofileid to search for.
	* @return true if certificateprofileid exists in any of the hard token profiles.
	*/
   public boolean existsCertificateProfileInHardTokenProfiles(Admin admin, int id) throws RemoteException;
           
    /**
     * Adds a hard token issuer to the database.
     *
     * @return false if hard token issuer already exists. 
     * @throws EJBException if a communication or other error occurs.
     */        
    
    public boolean addHardTokenIssuer(Admin admin, String alias, int admingroupid, HardTokenIssuer issuerdata) throws RemoteException;   
    
    /**
     * Updates hard token issuer data
     *
     * @return false if  alias doesn't exists
     * @throws EJBException if a communication or other error occurs.
     */     
    
    public boolean changeHardTokenIssuer(Admin admin, String alias, HardTokenIssuer issuerdata) throws RemoteException;    
    
     /**
     * Adds a hard token issuer with the same content as the original issuer, 
     *  
     * @return false if the new alias or certificatesn already exists.
     * @throws EJBException if a communication or other error occurs.     
     */ 
    public boolean cloneHardTokenIssuer(Admin admin, String oldalias, String newalias, 
	                                    int admingroupid) throws RemoteException;
    
     /**
     * Removes a hard token issuer from the database. 
     * 
     * @throws EJBException if a communication or other error occurs.   
     */ 
    public void removeHardTokenIssuer(Admin admin, String alias) throws RemoteException;
    
     /**
     * Renames a hard token issuer
     *
     * @return false if new alias or certificatesn already exists
     * @throws EJBException if a communication or other error occurs.           
     */ 
    public boolean renameHardTokenIssuer(Admin admin, String oldalias, String newalias, 
	                                     int newadmingroupid) throws RemoteException;   
    
	/**
	 * Method to check if an administrator is authorized to issue hard tokens for
	 * the given alias.
	 * 
	 * @param admin administrator to check
	 * @param alias alias of hardtoken issuer. 
	 * @return true if administrator is authorized to issue hardtoken with given alias.
	 */
	public boolean getAuthorizedToHardTokenIssuer(Admin admin, String alias) throws RemoteException;
    
    
      /**
       * Returns the available hard token issuers.
       *
       * @return A collection of available HardTokenIssuerData.
       * @throws EJBException if a communication or other error occurs.
       */      
    public Collection getHardTokenIssuerDatas(Admin admin) throws RemoteException;
    
      /**
       * Returns the available hard token issuer alliases.
       *
       * @return A collection of available hard token issuer aliases.
       * @throws EJBException if a communication or other error occurs.
       */      
    public Collection getHardTokenIssuerAliases(Admin admin) throws RemoteException;    
    
      /**