iuseradminsessionlocal.java

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

/*
 * Generated by XDoclet - Do not edit!
 */
package org.ejbca.core.ejb.ra;

/**
 * Local interface for UserAdminSession.
 */
public interface IUserAdminSessionLocal
   extends javax.ejb.EJBLocalObject
{
   /**
    * Implements IUserAdminSession::addUser. Implements a mechanism that uses UserDataEntity Bean. Important, this method is old and shouldn't be used, user addUser(..UserDataVO...) instead.
    * @param admin the administrator pwrforming the action
    * @param username the unique username.
    * @param password the password used for authentication.
    * @param subjectdn the DN the subject is given in his certificate.
    * @param subjectaltname the Subject Alternative Name to be used.
    * @param email the email of the subject or null.
    * @param clearpwd true if the password will be stored in clear form in the db, otherwise it is hashed.
    * @param endentityprofileid the id number of the end entity profile bound to this user.
    * @param certificateprofileid the id number of the certificate profile that should be generated for the user.
    * @param type of user i.e administrator, keyrecoverable and/or sendnotification, from SecConst.USER_XX.
    * @param tokentype the type of token to be generated, one of SecConst.TOKEN constants
    * @param hardwaretokenissuerid , if token should be hard, the id of the hard token issuer, else 0.
    * @param caid the CA the user should be issued from.
    * @throws WaitingForApprovalException
    * @throws ApprovalException
    */
   public void addUser( org.ejbca.core.model.log.Admin admin,java.lang.String username,java.lang.String password,java.lang.String subjectdn,java.lang.String subjectaltname,java.lang.String email,boolean clearpwd,int endentityprofileid,int certificateprofileid,int type,int tokentype,int hardwaretokenissuerid,int caid ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, javax.ejb.DuplicateKeyException, org.ejbca.core.model.approval.ApprovalException, org.ejbca.core.model.approval.WaitingForApprovalException;

   /**
    * Implements IUserAdminSession::addUser. Implements a mechanism that uses UserDataEntity Bean.
    * @param admin the administrator pwrforming the action
    * @param userdata a UserDataVO object, the fields status, timecreated and timemodified will not be used.
    * @param clearpwd true if the password will be stored in clear form in the db, otherwise it is hashed.
    * @throws AuthorizationDeniedException if administrator isn't authorized to add user
    * @throws UserDoesntFullfillEndEntityProfile if data doesn't fullfil requirements of end entity profile
    * @throws DuplicateKeyException if user already exists
    * @throws ApprovalException if an approval already is waiting for specified action
    * @throws WaitingForApprovalException if approval is required and the action have been added in the approval queue.
    */
   public void addUser( org.ejbca.core.model.log.Admin admin,org.ejbca.core.model.ra.UserDataVO userdata,boolean clearpwd ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, javax.ejb.DuplicateKeyException, org.ejbca.core.model.approval.ApprovalException, org.ejbca.core.model.approval.WaitingForApprovalException;

   /**
    * Changes data for a user in the database speciefied by username. Important, this method is old and shouldn't be used, user changeUser(..UserDataVO...) instead.
    * @param username the unique username.
    * @param password the password used for authentication.*
    * @param subjectdn the DN the subject is given in his certificate.
    * @param subjectaltname the Subject Alternative Name to be used.
    * @param email the email of the subject or null.
    * @param endentityprofileid the id number of the end entity profile bound to this user.
    * @param certificateprofileid the id number of the certificate profile that should be generated for the user.
    * @param type of user i.e administrator, keyrecoverable and/or sendnotification
    * @param tokentype the type of token to be generated, one of SecConst.TOKEN constants
    * @param hardwaretokenissuerid if token should be hard, the id of the hard token issuer, else 0.
    * @param status the status of the user, from UserDataConstants.STATUS_X
    * @param caid the id of the CA that should be used to issue the users certificate
    * @throws AuthorizationDeniedException if administrator isn't authorized to add user
    * @throws UserDoesntFullfillEndEntityProfile if data doesn't fullfil requirements of end entity profile
    * @throws ApprovalException if an approval already is waiting for specified action
    * @throws WaitingForApprovalException if approval is required and the action have been added in the approval queue.
    * @throws EJBException if a communication or other error occurs.
    */
   public void changeUser( org.ejbca.core.model.log.Admin admin,java.lang.String username,java.lang.String password,java.lang.String subjectdn,java.lang.String subjectaltname,java.lang.String email,boolean clearpwd,int endentityprofileid,int certificateprofileid,int type,int tokentype,int hardwaretokenissuerid,int status,int caid ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, org.ejbca.core.model.approval.ApprovalException, org.ejbca.core.model.approval.WaitingForApprovalException;

   /**
    * Implements IUserAdminSession::changeUser..
    * @param admin the administrator performing the action
    * @param userdata a UserDataVO object, timecreated and timemodified will not be used.
    * @param clearpwd true if the password will be stored in clear form in the db, otherwise it is hashed.
    * @throws AuthorizationDeniedException if administrator isn't authorized to add user
    * @throws UserDoesntFullfillEndEntityProfile if data doesn't fullfil requirements of end entity profile
    * @throws ApprovalException if an approval already is waiting for specified action
    * @throws WaitingForApprovalException if approval is required and the action have been added in the approval queue.
    */
   public void changeUser( org.ejbca.core.model.log.Admin admin,org.ejbca.core.model.ra.UserDataVO userdata,boolean clearpwd ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, org.ejbca.core.model.approval.ApprovalException, org.ejbca.core.model.approval.WaitingForApprovalException;

   /**
    * Deletes a user from the database. The users certificates must be revoked BEFORE this method is called.
    * @param username the unique username.
    * @throws NotFoundException if the user does not exist
    * @throws RemoveException if the user could not be removed
    */
   public void deleteUser( org.ejbca.core.model.log.Admin admin,java.lang.String username ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ra.NotFoundException, javax.ejb.RemoveException;

   /**
    * Changes status of a user.
    * @param username the unique username.
    * @param status the new status, from 'UserData'.
    * @param approvalflag approvalflag that indicates if approvals should be used or not
    * @throws ApprovalException if an approval already is waiting for specified action
    * @throws WaitingForApprovalException if approval is required and the action have been added in the approval queue.
    */
   public void setUserStatus( org.ejbca.core.model.log.Admin admin,java.lang.String username,int status ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, javax.ejb.FinderException, org.ejbca.core.model.approval.ApprovalException, org.ejbca.core.model.approval.WaitingForApprovalException;

   /**
    * Sets a new password for a user.
    * @param admin the administrator pwrforming the action
    * @param username the unique username.
    * @param password the new password for the user, NOT null.
    */
   public void setPassword( org.ejbca.core.model.log.Admin admin,java.lang.String username,java.lang.String password ) throws org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, org.ejbca.core.model.authorization.AuthorizationDeniedException, javax.ejb.FinderException;

   /**
    * Sets a clear text password for a user.
    * @param admin the administrator pwrforming the action
    * @param username the unique username.
    * @param password the new password to be stored in clear text. Setting password to 'null' effectively deletes any previous clear text password.
    */
   public void setClearTextPassword( org.ejbca.core.model.log.Admin admin,java.lang.String username,java.lang.String password ) throws org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, org.ejbca.core.model.authorization.AuthorizationDeniedException, javax.ejb.FinderException;

   /**
    * Verifies a password for a user.
    * @param admin the administrator pwrforming the action
    * @param username the unique username.
    * @param password the password to be verified.
    */
   public boolean verifyPassword( org.ejbca.core.model.log.Admin admin,java.lang.String username,java.lang.String password ) throws org.ejbca.core.model.ra.raadmin.UserDoesntFullfillEndEntityProfile, org.ejbca.core.model.authorization.AuthorizationDeniedException, javax.ejb.FinderException;

   /**
    * Method that revokes a user.
    * @param username the username to revoke.
    */
   public void revokeUser( org.ejbca.core.model.log.Admin admin,java.lang.String username,int reason ) throws org.ejbca.core.model.authorization.AuthorizationDeniedException, javax.ejb.FinderException;

   /**
    * Method that revokes a certificate.