ihardtokensessionremote.java

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

       * Returns the available hard token issuers.
       *
       * @return A treemap of available hard token issuers.
       * @throws EJBException if a communication or other error occurs.
       */        
    public TreeMap getHardTokenIssuers(Admin admin) throws RemoteException;
    
      /**
       * Returns the specified hard token issuer.
       *
       * @return the hard token issuer data or null if hard token issuer doesn't exists.
       * @throws EJBException if a communication or other error occurs.
       */      
    public HardTokenIssuerData getHardTokenIssuerData(Admin admin, String alias) throws RemoteException;
    
       /**
       * Returns the specified  hard token issuer.
       *
       * @return the  hard token issuer data or null if  hard token issuer doesn't exists.
       * @throws EJBException if a communication or other error occurs.
       */         
    public HardTokenIssuerData getHardTokenIssuerData(Admin admin, int id) throws RemoteException;

      /**
       * Returns the number of available hard token issuer.
       *
       * @return the number of available hard token issuer.
       * @throws EJBException if a communication or other error occurs.
       */             
    public int getNumberOfHardTokenIssuers(Admin admin) throws RemoteException;
    
      /**
       * Returns a hard token issuer id given its alias.
       *
       * @return id number of hard token issuer.
       * @throws EJBException if a communication or other error occurs.
       */    
    public int getHardTokenIssuerId(Admin admin, String alias) throws RemoteException;
    
    
       /**
       * Returns a hard token issuer alias given its id.
       *
       * @return the alias or null if id noesnt exists
       * @throws EJBException if a communication or other error occurs.
       */    
    public String getHardTokenIssuerAlias(Admin admin, int id) throws RemoteException;  
    
      /**
       * Checks if a hardtoken profile is among a hard tokens issuers available token types.
       *
       * @param admin, the administrator calling the function
       * @param isserid, the id of the issuer to check.
       * @param userdata, the data of user about to be generated
       *
       * @throws UnavalableTokenException if users tokentype isn't among hard token issuers available tokentypes.
       * @throws EJBException if a communication or other error occurs.
       */    
    
    public void getIsHardTokenProfileAvailableToIssuer(Admin admin, int issuerid, UserAdminData userdata) throws UnavailableTokenException, RemoteException;
       
    /**
     * Adds a hard token to the database
     *
     * @param admin, the administrator calling the function
     * @param tokensn, The serialnumber of token.
     * @param username, the user owning the token.
     * @param significantissuerdn, indicates which CA the hard token should belong to.
     * @param hardtoken, the hard token data
     * @param certificates,  a collection of certificates places in the hard token
     * @param copyof indicates if the newly created token is a copy of an existing token. Use null if token is an original
     *
     * @throws EJBException if a communication or other error occurs.
     * @throws HardTokenExistsException if tokensn already exists in databas.
     */
    public void addHardToken(Admin admin, String tokensn, String username, String significantissuerdn, int tokentype, HardToken hardtokendata, Collection certificates, String copyof) throws HardTokenExistsException, RemoteException;      
  
       /**
       * changes a hard token data in the database
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * @param hardtoken, the hard token data
       * 
       * @throws EJBException if a communication or other error occurs.
       * @throws HardTokenDoesntExistsException if tokensn doesn't exists in databas.
       */    
    public void changeHardToken(Admin admin, String tokensn, int tokentype, HardToken hardtokendata) throws HardTokenDoesntExistsException, RemoteException;  
    
       /**
       * removes a hard token data from the database, observe the certificate to tokensn mappings isn't removed with this function.
       * the certificate mappings have to be removed separately.
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * 
       * @throws EJBException if a communication or other error occurs.
       * @throws HardTokenDoesntExistsException if tokensn doesn't exists in databas.
       */    
    public void removeHardToken(Admin admin, String tokensn) throws HardTokenDoesntExistsException, RemoteException;      
   
      /**
       * returns hard token data for the specified tokensn
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * 
       * @return the hard token data or NULL if tokensn doesnt exists in database.
       * @throws EJBException if a communication or other error occurs.
       */    
    public HardTokenData getHardToken(Admin admin, String tokensn) throws RemoteException;

      /**
       * returns hard token data for the specified user
       *
       * @param admin, the administrator calling the function
       * @param username, The username owning the tokens.
       * 
       * @return a Collection of all hard token user data.
       * @throws EJBException if a communication or other error occurs.
       */        
    public Collection getHardTokens(Admin admin, String username) throws RemoteException;    

    /**
     *  Method that searches the database for a tokensn. The search string can have to forms, 
     *  either the full tokensn (prefix + snnumber + checksum) or just the short serialnumber.
     * 
     *  @param admin the administrator calling the function
     *  @param searchpattern of either the full serialnumber or just the short version
     *  @return a Collection of hardtokens matching the search string
     * 
     */
    
    public Collection findHardTokenByTokenSerialNumber(Admin admin, String searchstring) throws RemoteException;
    	
    
       /**
       * Checks if a hard token serialnumber exists in the database
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * 
       * @return true if it exists or false otherwise.
       * @throws EJBException if a communication or other error occurs.
       */    
    public boolean existsHardToken(Admin admin, String tokensn) throws RemoteException;     
    
       /**
       * Adds a mapping between a hard token and a certificate
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * @param certificate, the certificate to map to.
       * 
       * @return true if addition went successful. False if map already exists.
       * @throws EJBException if a communication or other error occurs.
       */    
    public void addHardTokenCertificateMapping(Admin admin, String tokensn, X509Certificate Certificate) throws RemoteException;      
  
      /**
       * Removes a mapping between a hard token and a certificate
       *
       * @param admin, the administrator calling the function
       * @param certificate, the certificate to map to.
       * 
       * @return true if removal went successful. 
       * @throws EJBException if a communication or other error occurs.
       */    
    public void removeHardTokenCertificateMapping(Admin admin, X509Certificate Certificate) throws RemoteException;     
    
       /**
       * Returns all the X509Certificates places in a hard token.
       *
       * @param admin, the administrator calling the function
       * @param tokensn, The serialnumber of token.
       * 
       * @throws EJBException if a communication or other error occurs.
       */    
    public Collection findCertificatesInHardToken(Admin admin, String tokensn) throws RemoteException;      
    
    
    /** 
     * Method used to signal to the log that token was generated successfully.
     *
     * @param admin, administrator performing action
     * @param tokensn, tokensn of token generated
     * @param username, username of user token was generated for.
     * @param significantissuerdn, indicates which CA the hard token should belong to.
     *
     */
    public void tokenGenerated(Admin admin, String tokensn, String username, String significantissuerdn) throws RemoteException;
    
    /** 
     * Method used to signal to the log that error occured when generating token.
     *
     * @param admin, administrator performing action
     * @param tokensn, tokensn of token 
     * @param username, username of user token was generated for.
     * @param significantissuerdn, indicates which CA the hard token should belong to.
     *
     */
    public void errorWhenGeneratingToken(Admin admin, String tokensn, String username, String significantissuerdn) throws RemoteException;     
     
}