summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java
diff options
context:
space:
mode:
Diffstat (limited to 'base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java')
-rw-r--r--base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java58
1 files changed, 29 insertions, 29 deletions
diff --git a/base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java b/base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java
index a7cc40507..acc3214bb 100644
--- a/base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java
+++ b/base/common/src/com/netscape/certsrv/kra/IKeyRecoveryAuthority.java
@@ -42,7 +42,7 @@ import com.netscape.certsrv.security.ITransportKeyUnit;
* key recovery authority is responsibile for archiving
* and recovering user encryption private keys.
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public interface IKeyRecoveryAuthority extends ISubsystem {
@@ -69,7 +69,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the name of this subsystem.
* <P>
- *
+ *
* @return KRA name
*/
public X500Name getX500Name();
@@ -77,7 +77,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Retrieves KRA request repository.
* <P>
- *
+ *
* @return request repository
*/
public IRequestQueue getRequestQueue();
@@ -91,7 +91,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Retrieves the Replica ID repository.
- *
+ *
* @return KRA's Replica ID repository
*/
public IReplicaIDRepository getReplicaRepository();
@@ -102,7 +102,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
* providing credentials. This feature is for enabling
* user-based recovery operation.
* <p>
- *
+ *
* @param cs list of agent credentials
* @param on true if auto recovery state is on
* @return current auto recovery state
@@ -111,7 +111,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the current auto recovery state.
- *
+ *
* @return true if auto recvoery state is on
*/
public boolean getAutoRecoveryState();
@@ -121,7 +121,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
* In distributed recovery mode, recovery agent login to the
* agent interface and submit its credential for a particular
* recovery operation.
- *
+ *
* @param id authorization identifier
* @param creds list of credentials
*/
@@ -129,7 +129,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Removes a particular auto recovery operation.
- *
+ *
* @param id authorization identifier
*/
public void removeAutoRecovery(String id);
@@ -138,28 +138,28 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
* Returns the number of required agents. In M-out-of-N
* recovery schema, only M agents are required even there
* are N agents. This method returns M.
- *
+ *
* @return number of required agents
*/
public int getNoOfRequiredAgents() throws EBaseException;
/**
* Sets the number of required recovery agents
- *
+ *
* @param number number of agents
*/
public void setNoOfRequiredAgents(int number) throws EBaseException;
/**
* Returns the current recovery identifier.
- *
+ *
* @return recovery identifier
*/
public String getRecoveryID();
/**
* Returns a list of recovery identifiers.
- *
+ *
* @return list of auto recovery identifiers
*/
public Enumeration<String> getAutoRecoveryIDs();
@@ -167,7 +167,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the storage key unit that manages the
* stoarge key.
- *
+ *
* @return storage key unit
*/
public IStorageKeyUnit getStorageKeyUnit();
@@ -175,14 +175,14 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the transport key unit that manages the
* transport key.
- *
+ *
* @return transport key unit
*/
public ITransportKeyUnit getTransportKeyUnit();
/**
* Returns the token that generates user key pairs for supporting server-side keygen
- *
+ *
* @return keygen token
*/
public CryptoToken getKeygenToken();
@@ -190,7 +190,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Adds entropy to the token used for supporting server-side keygen
* Parameters are set in the config file
- *
+ *
* @param logflag create log messages at info level to report entropy shortage
*/
public void addEntropy(boolean logflag);
@@ -198,7 +198,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the request listener that listens on
* the request completion event.
- *
+ *
* @return request listener
*/
public IRequestListener getRequestInQListener();
@@ -213,35 +213,35 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Returns the nickname of the transport certificate.
- *
+ *
* @return transport certificate nickname.
*/
public String getNickname();
/**
* Sets the nickname of the transport certificate.
- *
+ *
* @param str nickname
*/
public void setNickname(String str);
/**
* Returns the new nickname of the transport certifiate.
- *
+ *
* @return new nickname
*/
public String getNewNickName() throws EBaseException;
/**
* Sets the new nickname of the transport certifiate.
- *
+ *
* @param name new nickname
*/
public void setNewNickName(String name);
/**
* Logs event into key recovery authority logging.
- *
+ *
* @param level log level
* @param msg log message
*/
@@ -253,7 +253,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
* framework will try to serialize all the attribute into
* persistent storage. Things like passwords are not
* desirable to be stored.
- *
+ *
* @param id request id
* @return volatile requests
*/
@@ -261,7 +261,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Retrieves the request object.
- *
+ *
* @param id request id
* @return volatile requests
*/
@@ -269,7 +269,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Destroys the request object.
- *
+ *
* @param id request id
*/
public void destroyVolatileRequest(RequestId id);
@@ -279,7 +279,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Creates error for a specific recovery operation.
- *
+ *
* @param recoveryID recovery id
* @param error error
* @exception EBaseException failed to create error
@@ -289,7 +289,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Retrieves error by recovery identifier.
- *
+ *
* @param recoveryID recovery id
* @return error message
*/
@@ -298,7 +298,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Retrieves PKCS12 package by recovery identifier.
- *
+ *
* @param recoveryID recovery id
* @return pkcs12 package in bytes
*/
@@ -307,7 +307,7 @@ public interface IKeyRecoveryAuthority extends ISubsystem {
/**
* Creates PKCS12 package in memory.
- *
+ *
* @param recoveryID recovery id
* @param pk12 package in bytes
*/