diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java | 70 |
1 files changed, 39 insertions, 31 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java b/pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java index de48dac17..093bea255 100644 --- a/pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java +++ b/pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java @@ -17,6 +17,7 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.dbs.keydb; + import java.math.BigInteger; import java.security.PublicKey; import java.util.Enumeration; @@ -27,11 +28,12 @@ import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.dbs.ModificationSet; import com.netscape.certsrv.dbs.repository.IRepository; + /** - * An interface represents a Key repository. This is the container of archived - * keys. + * An interface represents a Key repository. This is the + * container of archived keys. * <P> - * + * * @version $Revision$, $Date$ */ public interface IKeyRepository extends IRepository { @@ -39,7 +41,7 @@ public interface IKeyRepository extends IRepository { /** * Archives a key to the repository. * <P> - * + * * @param record key record * @exception EBaseException failed to archive key */ @@ -48,56 +50,61 @@ public interface IKeyRepository extends IRepository { /** * Reads an archived key by serial number. * <P> - * + * * @param serialNo serial number * @return key record * @exception EBaseException failed to recover key */ - public IKeyRecord readKeyRecord(BigInteger serialNo) throws EBaseException; + public IKeyRecord readKeyRecord(BigInteger serialNo) + throws EBaseException; /** * Reads an archived key by b64 encoded cert. * <P> - * + * * @param cert b64 encoded cert * @return key record * @exception EBaseException failed to recover key */ - public IKeyRecord readKeyRecord(String cert) throws EBaseException; + public IKeyRecord readKeyRecord(String cert) + throws EBaseException; /** * Reads an archived key by owner name. * <P> - * + * * @param ownerName owner name * @return key record * @exception EBaseException failed to recover key */ - public IKeyRecord readKeyRecord(X500Name ownerName) throws EBaseException; + public IKeyRecord readKeyRecord(X500Name ownerName) + throws EBaseException; /** * Reads archived key using public key. - * - * @param publicKey public key that is corresponding to the private key + * + * @param publicKey public key that is corresponding + * to the private key * @return key record * @exception EBaseException failed to read key */ - public IKeyRecord readKeyRecord(PublicKey publicKey) throws EBaseException; + public IKeyRecord readKeyRecord(PublicKey publicKey) + throws EBaseException; /** * Searches for private keys. - * + * * @param filter LDAP filter for the search * @param maxSize maximium number of entries to be returned * @return a list of private key records * @exception EBaseException failed to search keys */ public Enumeration searchKeys(String filter, int maxSize) - throws EBaseException; + throws EBaseException; /** * Searches for private keys. - * + * * @param filter LDAP filter for the search * @param maxSize maximium number of entries to be returned * @param timeLimt timeout value @@ -105,30 +112,30 @@ public interface IKeyRepository extends IRepository { * @exception EBaseException failed to search keys */ public Enumeration searchKeys(String filter, int maxSize, int timeLimt) - throws EBaseException; + throws EBaseException; /** * Deletes a key record. - * + * * @param serialno key identifier * @exception EBaseException failed to delete key record */ - public void deleteKeyRecord(BigInteger serialno) throws EBaseException; + public void deleteKeyRecord(BigInteger serialno) + throws EBaseException; /** * Modifies key record in this repository. - * + * * @param serialNo key identifier * @param mods modification of key records * @exception EBaseException failed to modify key record */ - public void modifyKeyRecord(BigInteger serialNo, ModificationSet mods) - throws EBaseException; + public void modifyKeyRecord(BigInteger serialNo, + ModificationSet mods) throws EBaseException; /** - * Searchs for a list of key records. Here is a list of supported filter - * attributes: - * + * Searchs for a list of key records. + * Here is a list of supported filter attributes: * <pre> * keySerialNumber * keyState @@ -142,19 +149,19 @@ public interface IKeyRepository extends IRepository { * keyModifyTime * keyMetaInfo * </pre> - * + * * @param filter search filter * @param attrs list of attributes to be returned * @param pageSize virtual list page size * @return list of key records * @exception EBaseException failed to search key records */ - public IKeyRecordList findKeyRecordsInList(String filter, String attrs[], - int pageSize) throws EBaseException; + public IKeyRecordList findKeyRecordsInList(String filter, + String attrs[], int pageSize) throws EBaseException; /** * Searchs for a list of key records. - * + * * @param filter search filter * @param attrs list of attributes to be returned * @param sortKey name of attribute that the list should be sorted by @@ -162,6 +169,7 @@ public interface IKeyRepository extends IRepository { * @return list of key records * @exception EBaseException failed to search key records */ - public IKeyRecordList findKeyRecordsInList(String filter, String attrs[], - String sortKey, int pageSize) throws EBaseException; + public IKeyRecordList findKeyRecordsInList(String filter, + String attrs[], String sortKey, int pageSize) + throws EBaseException; } |