ihardtokensessionlocal.java

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

    * 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( org.ejbca.core.model.log.Admin admin ) ;

   /**
    * 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( org.ejbca.core.model.log.Admin admin,java.lang.String alias ) ;

   /**
    * 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 java.lang.String getHardTokenIssuerAlias( org.ejbca.core.model.log.Admin admin,int id ) ;

   /**
    * Checks if a hard token profile is among a hard tokens issuers available token types.
    * @param admin the administrator calling the function
    * @param issuerid the id of the issuer to check.
    * @param userdata the data of user about to be generated
    * @throws UnavailableTokenException if users tokentype isn't among hard token issuers available tokentypes.
    * @throws EJBException if a communication or other error occurs.
    */
   public void getIsHardTokenProfileAvailableToIssuer( org.ejbca.core.model.log.Admin admin,int issuerid,org.ejbca.core.model.ra.UserDataVO userdata ) throws org.ejbca.core.model.hardtoken.UnavailableTokenException;

   /**
    * 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 hardtokendata 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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn,java.lang.String username,java.lang.String significantissuerdn,int tokentype,org.ejbca.core.model.hardtoken.types.HardToken hardtokendata,java.util.Collection certificates,java.lang.String copyof ) throws org.ejbca.core.model.hardtoken.HardTokenExistsException;

   /**
    * changes a hard token data in the database
    * @param admin the administrator calling the function
    * @param tokensn The serialnumber of token.
    * @param hardtokendata 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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn,int tokentype,org.ejbca.core.model.hardtoken.types.HardToken hardtokendata ) throws org.ejbca.core.model.hardtoken.HardTokenDoesntExistsException;

   /**
    * removes a hard token data from the database
    * @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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn ) throws org.ejbca.core.model.hardtoken.HardTokenDoesntExistsException;

   /**
    * 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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn ) ;

   /**
    * 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 org.ejbca.core.model.hardtoken.HardTokenData getHardToken( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn ) ;

   /**
    * 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 java.util.Collection getHardTokens( org.ejbca.core.model.log.Admin admin,java.lang.String username ) ;

   /**
    * Method that searches the database for a tokensn. It returns all hardtokens with a serialnumber that begins with the given searchpattern.
    * @param admin the administrator calling the function
    * @param searchpattern of begining of hard token sn
    * @return a Collection of username(String) matching the search string
    */
   public java.util.Collection findHardTokenByTokenSerialNumber( org.ejbca.core.model.log.Admin admin,java.lang.String searchpattern ) ;

   /**
    * 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.
    * @throws EJBException if a communication or other error occurs.
    */
   public void addHardTokenCertificateMapping( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn,java.security.cert.X509Certificate certificate ) ;

   /**
    * Removes a mapping between a hard token and a certificate
    * @param admin the administrator calling the function
    * @param certificate the certificate to map to.
    * @throws EJBException if a communication or other error occurs.
    */
   public void removeHardTokenCertificateMapping( org.ejbca.core.model.log.Admin admin,java.security.cert.X509Certificate certificate ) ;

   /**
    * Returns all the X509Certificates places in a hard token.
    * @param admin the administrator calling the function
    * @param tokensn The serialnumber of token.
    * @return a collection of X509Certificates
    * @throws EJBException if a communication or other error occurs.
    */
   public java.util.Collection findCertificatesInHardToken( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn ) ;

   /**
    * Returns the tokensn that the have blongs to a given certificatesn and tokensn.
    * @param admin the administrator calling the function
    * @param certificatesn The serialnumber of certificate.
    * @param issuerdn the issuerdn of the certificate.
    * @return the serialnumber or null if no tokensn could be found.
    * @throws EJBException if a communication or other error occurs.
    */
   public java.lang.String findHardTokenByCertificateSNIssuerDN( org.ejbca.core.model.log.Admin admin,java.math.BigInteger certificatesn,java.lang.String issuerdn ) ;

   /**
    * 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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn,java.lang.String username,java.lang.String significantissuerdn ) ;

   /**
    * 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( org.ejbca.core.model.log.Admin admin,java.lang.String tokensn,java.lang.String username,java.lang.String significantissuerdn ) ;

   /**
    * Method to check if a certificate profile exists in any of the hard token profiles. Used to avoid desyncronization of certificate profile data.
    * @param id the certificateprofileid to search for.
    * @return true if certificateprofileid exists in any of the hard token profiles.
    */
   public boolean existsCertificateProfileInHardTokenProfiles( org.ejbca.core.model.log.Admin admin,int id ) ;

   /**
    * Method to check if a hard token profile exists in any of the hard token issuers. Used to avoid desyncronization of hard token profile data.
    * @param id the hard token profileid to search for.
    * @return true if hard token profileid exists in any of the hard token issuers.
    */
   public boolean existsHardTokenProfileInHardTokenIssuer( org.ejbca.core.model.log.Admin admin,int id ) ;

}