summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java
diff options
context:
space:
mode:
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.java55
1 files changed, 27 insertions, 28 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 093bea255..ca1e2c8aa 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,7 +17,6 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.dbs.keydb;
-
import java.math.BigInteger;
import java.security.PublicKey;
import java.util.Enumeration;
@@ -28,12 +27,11 @@ 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
+ * An interface represents a Key repository. This is the
* container of archived keys.
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public interface IKeyRepository extends IRepository {
@@ -41,7 +39,7 @@ public interface IKeyRepository extends IRepository {
/**
* Archives a key to the repository.
* <P>
- *
+ *
* @param record key record
* @exception EBaseException failed to archive key
*/
@@ -50,61 +48,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;
+ 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;
+ 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;
+ 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;
+ 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
@@ -112,30 +110,31 @@ 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;
+ 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;
+ ModificationSet mods) throws EBaseException;
/**
* Searchs for a list of key records.
* Here is a list of supported filter attributes:
+ *
* <pre>
* keySerialNumber
* keyState
@@ -149,7 +148,7 @@ 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
@@ -157,11 +156,11 @@ public interface IKeyRepository extends IRepository {
* @exception EBaseException failed to search key records
*/
public IKeyRecordList findKeyRecordsInList(String filter,
- String attrs[], int pageSize) throws EBaseException;
+ 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
@@ -170,6 +169,6 @@ public interface IKeyRepository extends IRepository {
* @exception EBaseException failed to search key records
*/
public IKeyRecordList findKeyRecordsInList(String filter,
- String attrs[], String sortKey, int pageSize)
- throws EBaseException;
+ String attrs[], String sortKey, int pageSize)
+ throws EBaseException;
}