icaadminsessionremote.java

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

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

/**
 * Remote interface for CAAdminSession.
 */
public interface ICAAdminSessionRemote
   extends javax.ejb.EJBObject
{
   /**
    * Method used to create a new CA. The cainfo parameter should at least contain the following information. SubjectDN Name (if null then is subjectDN used). Validity a CATokenInfo Description (optional) Status (SecConst.CA_ACTIVE or SecConst.CA_WAITING_CERTIFICATE_RESPONSE) SignedBy (CAInfo.SELFSIGNED, CAInfo.SIGNEDBYEXTERNALCA or CAId of internal CA) For other optional values see:
    * @see org.ejbca.core.model.ca.caadmin.CAInfo
    * @see org.ejbca.core.model.ca.caadmin.X509CAInfo
    */
   public void createCA( org.ejbca.core.model.log.Admin admin,org.ejbca.core.model.ca.caadmin.CAInfo cainfo )
      throws org.ejbca.core.model.ca.caadmin.CAExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ca.catoken.CATokenOfflineException, org.ejbca.core.model.ca.catoken.CATokenAuthenticationFailedException, java.rmi.RemoteException;

   /**
    * Method used to edit the data of a CA. Not all of the CAs data can be edited after the creation, therefore will only the values from CAInfo that is possible be uppdated. For values see:
    * @see org.ejbca.core.model.ca.caadmin.CAInfo
    * @see org.ejbca.core.model.ca.caadmin.X509CAInfo
    */
   public void editCA( org.ejbca.core.model.log.Admin admin,org.ejbca.core.model.ca.caadmin.CAInfo cainfo )
      throws org.ejbca.core.model.authorization.AuthorizationDeniedException, java.rmi.RemoteException;

   /**
    * Method used to remove a CA from the system. First there is a check that the CA isn't used by any EndEntity, Profile or AccessRule before it is removed. Should be used with care. If any certificate has been created with the CA use revokeCA instead and don't remove it.
    */
   public void removeCA( org.ejbca.core.model.log.Admin admin,int caid )
      throws org.ejbca.core.model.authorization.AuthorizationDeniedException, java.rmi.RemoteException;

   /**
    * Renames the name of CA used in administrators web interface. This name doesn't have to be the same as SubjectDN and is only used for reference.
    */
   public void renameCA( org.ejbca.core.model.log.Admin admin,java.lang.String oldname,java.lang.String newname )
      throws org.ejbca.core.model.ca.caadmin.CAExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, java.rmi.RemoteException;

   /**
    * Returns a value object containing nonsensitive information about a CA give it's name.
    * @param admin administrator calling the method
    * @param name human readable name of CA
    * @return value object or null if CA does not exist
    */
   public org.ejbca.core.model.ca.caadmin.CAInfo getCAInfo( org.ejbca.core.model.log.Admin admin,java.lang.String name )
      throws java.rmi.RemoteException;

   /**
    * Returns a value object containing nonsensitive information about a CA give it's CAId.
    * @param admin administrator calling the method
    * @param caid numerical id of CA (subjectDN.hashCode())
    * @return value object or null if CA does not exist
    */
   public org.ejbca.core.model.ca.caadmin.CAInfo getCAInfo( org.ejbca.core.model.log.Admin admin,int caid )
      throws java.rmi.RemoteException;

   /**
    * Returns a HashMap containing mappings of caid (Integer) to CA name (String) of all CAs in the system.
    * @return HashMap with Integer->String mappings
    */
   public java.util.HashMap getCAIdToNameMap( org.ejbca.core.model.log.Admin admin )
      throws java.rmi.RemoteException;

   /**
    * Method returning id's of all CA's avaible to the system. i.e. not have status "external" or "waiting for certificate response"
    * @return a Collection (Integer) of available CA id's
    */
   public java.util.Collection getAvailableCAs( org.ejbca.core.model.log.Admin admin )
      throws java.rmi.RemoteException;

   /**
    * Creates a certificate request that should be sent to External Root CA for process before activation of CA.
    * @param rootcertificates A Collection of rootcertificates.
    * @param setstatustowaiting should be set true when creating new CAs and false for renewing old CAs
    * @return PKCS10RequestMessage
    */
   public org.ejbca.core.protocol.IRequestMessage makeRequest( org.ejbca.core.model.log.Admin admin,int caid,java.util.Collection cachain,boolean setstatustowaiting )
      throws org.ejbca.core.model.ca.caadmin.CADoesntExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, java.security.cert.CertPathValidatorException, org.ejbca.core.model.ca.catoken.CATokenOfflineException, java.rmi.RemoteException;

   /**
    * Receives a certificate response from an external CA and sets the newly created CAs status to active.
    * @throws EjbcaException
    */
   public void receiveResponse( org.ejbca.core.model.log.Admin admin,int caid,org.ejbca.core.protocol.IResponseMessage responsemessage )
      throws org.ejbca.core.model.authorization.AuthorizationDeniedException, java.security.cert.CertPathValidatorException, org.ejbca.core.EjbcaException, java.rmi.RemoteException;

   /**
    * Processes a Certificate Request from an external CA.
    */
   public org.ejbca.core.protocol.IResponseMessage processRequest( org.ejbca.core.model.log.Admin admin,org.ejbca.core.model.ca.caadmin.CAInfo cainfo,org.ejbca.core.protocol.IRequestMessage requestmessage )
      throws org.ejbca.core.model.ca.caadmin.CAExistsException, org.ejbca.core.model.ca.caadmin.CADoesntExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ca.catoken.CATokenOfflineException, java.rmi.RemoteException;

   /**
    * Renews a existing CA certificate using the same keys as before. Data about new CA is taken from database.
    * @param certificateresponce should be set with new certificatechain if CA is signed by external RootCA, otherwise use the null value.
    * @param regenerateKeys, if true and the CA have a softCAToken the keys are regenerated before the certrequest.
    */
   public void renewCA( org.ejbca.core.model.log.Admin admin,int caid,org.ejbca.core.protocol.IResponseMessage responsemessage,boolean regenerateKeys )
      throws org.ejbca.core.model.ca.caadmin.CADoesntExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, java.security.cert.CertPathValidatorException, org.ejbca.core.model.ca.catoken.CATokenOfflineException, java.rmi.RemoteException;

   /**
    * Method that revokes the CA. After this is all certificates created by this CA revoked and a final CRL is created.
    * @param reason one of RevokedCertInfo.REVOKATION_REASON values.
    */
   public void revokeCA( org.ejbca.core.model.log.Admin admin,int caid,int reason )
      throws org.ejbca.core.model.ca.caadmin.CADoesntExistsException, org.ejbca.core.model.authorization.AuthorizationDeniedException, java.rmi.RemoteException;

   /**
    * Method that should be used when upgrading from EJBCA 3.1 to EJBCA 3.2, changes class name of nCipher HardToken HSMs after code re-structure.
    * @param admin Administrator probably Admin.TYPE_CACOMMANDLINE_USER
    * @param caid id of CA to upgrade
    */
   public void upgradeFromOldCAHSMKeyStore( org.ejbca.core.model.log.Admin admin,int caid )
      throws java.rmi.RemoteException;

   /**
    * Method that is used to create a new CA from an imported keystore from another type of CA, for example OpenSSL.
    * @param admin Administrator
    * @param caname the CA-name (human readable) the newly created CA will get
    * @param p12file a byte array of old server p12 file.
    * @param keystorepass used to unlock the keystore.
    * @param privkeypass used to unlock the private key.
    * @param privateSignatureKeyAlias the alias for the private key in the keystore.
    * @param privateEncryptionKeyAlias the alias for the private encryption key in the keystore
    */
   public void importCAFromKeyStore( org.ejbca.core.model.log.Admin admin,java.lang.String caname,byte[] p12file,char[] keystorepass,char[] privkeypass,java.lang.String privateSignatureKeyAlias,java.lang.String privateEncryptionKeyAlias )
      throws java.lang.Exception, java.rmi.RemoteException;

   /**
    * Exports a CA to file. The method only works for soft tokens.
    * @param admin Administrator
    * @param caname the CA-name (human readable) the CA
    * @param keystorepass used to lock the keystore.
    * @param privkeypass used to lock the private key.
    * @param privateSignatureKeyAlias the alias for the private signature key in the keystore.
    * @param privateEncryptionKeyAlias the alias for the private encryption key in teh keystore
    * @return A byte array of the CAs p12.
    */
   public byte[] exportCAKeyStore( org.ejbca.core.model.log.Admin admin,java.lang.String caname,char[] keystorepass,char[] privkeypass,java.lang.String privateSignatureKeyAlias,java.lang.String privateEncryptionKeyAlias )
      throws java.lang.Exception, java.rmi.RemoteException;

   /**
    * Method returning a Collection of Certificate of all CA certificates known to the system. Certificates for External CAs or CAs that are awaiting certificate response are not returned, because we don't have certificates for them. Uses getAvailableCAs to list CAs.
    */
   public java.util.Collection getAllCACertificates( org.ejbca.core.model.log.Admin admin )
      throws java.rmi.RemoteException;

   /**
    * Check if password is a the rigth keystore password
    * @param admin Administrator
    * @param capassword used to unlock the keystore.
    */
   public boolean isKeyStorePassword( org.ejbca.core.model.log.Admin admin,java.lang.String capassword )
      throws java.rmi.RemoteException;

   /**
    * Retrieve fingerprint for all keys as a String. Used for testing.
    * @param admin Administrator
    * @param capassword used to unlock the keystore.
    * @throws Exception
    */
   public java.lang.String getKeyFingerPrint( org.ejbca.core.model.log.Admin admin,java.lang.String caname )
      throws java.lang.Exception, java.rmi.RemoteException;

   /**
    * Activates an 'Offline' CA Token and sets the CA status to acitve and ready for use again. The admin must be authorized to "/ca_functionality/basic_functions/activate_ca" inorder to activate/deactivate.
    * @param admin the adomistrator calling the method
    * @param caid the is of the ca to activate
    * @param the authorizationcode used to unlock the CA tokens private keys.
    * @throws AuthorizationDeniedException it the administrator isn't authorized to activate the CA.
    * @throws CATokenAuthenticationFailedException if the current status of the ca or authenticationcode is wrong.
    * @throws CATokenOfflineException if the CA token is still offline when calling the method.
    */
   public void activateCAToken( org.ejbca.core.model.log.Admin admin,int caid,java.lang.String authorizationcode )
      throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.model.ca.catoken.CATokenAuthenticationFailedException, org.ejbca.core.model.ca.catoken.CATokenOfflineException, java.rmi.RemoteException;

   /**
    * Deactivates an 'active' CA token and sets the CA status to offline. The admin must be authorized to "/ca_functionality/basic_functions/activate_ca" inorder to activate/deactivate.
    * @param admin the adomistrator calling the method
    * @param caid the is of the ca to activate.
    * @throws AuthorizationDeniedException it the administrator isn't authorized to activate the CA.
    * @throws EjbcaException if the given caid couldn't be found or its status is wrong.
    */
   public void deactivateCAToken( org.ejbca.core.model.log.Admin admin,int caid )
      throws org.ejbca.core.model.authorization.AuthorizationDeniedException, org.ejbca.core.EjbcaException, java.rmi.RemoteException;

   /**
    * Method used to check if certificate profile id exists in any CA.
    */
   public boolean exitsCertificateProfileInCAs( org.ejbca.core.model.log.Admin admin,int certificateprofileid )
      throws java.rmi.RemoteException;

   /**
    * Method used to check if publishers id exists in any CAs CRLPublishers Collection.
    */
   public boolean exitsPublisherInCAs( org.ejbca.core.model.log.Admin admin,int publisherid )
      throws java.rmi.RemoteException;

}