From 3f0a032899a65eac08ee7452805d937aa988b78e Mon Sep 17 00:00:00 2001
From: lutoff <lutoff@localhost>
Date: Thu, 21 Jun 2007 13:16:59 +0000
Subject: [PATCH] replace  {@inheritDoc} by actual javadoc as implemented interface is not part of opends

---
 opends/src/ads/org/opends/admin/ads/util/ApplicationKeyManager.java |   73 +++++++++++++++++++++++++++++++++---
 1 files changed, 67 insertions(+), 6 deletions(-)

diff --git a/opends/src/ads/org/opends/admin/ads/util/ApplicationKeyManager.java b/opends/src/ads/org/opends/admin/ads/util/ApplicationKeyManager.java
index 99f86c2..2aa924f 100644
--- a/opends/src/ads/org/opends/admin/ads/util/ApplicationKeyManager.java
+++ b/opends/src/ads/org/opends/admin/ads/util/ApplicationKeyManager.java
@@ -123,8 +123,24 @@
     }
   }
 
+
   /**
-   * {@inheritDoc}
+   * Choose an alias to authenticate the client side of a secure
+   * socket given the public key type and the list of certificate
+   * issuer authorities recognized by the peer (if any).
+   *
+   * @param keyType
+   *          the key algorithm type name(s), ordered with the
+   *          most-preferred key type first.
+   * @param issuers
+   *          the list of acceptable CA issuer subject names or null
+   *          if it does not matter which issuers are used.
+   * @param socket
+   *          the socket to be used for this connection. This
+   *          parameter can be null, in which case this method will
+   *          return the most generic alias to use.
+   * @return the alias name for the desired key, or null if there are
+   *         no matches.
    */
   public String chooseClientAlias(String[] keyType, Principal[] issuers,
       Socket socket)
@@ -140,7 +156,22 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Choose an alias to authenticate the client side of a secure
+   * socket given the public key type and the list of certificate
+   * issuer authorities recognized by the peer (if any).
+   *
+   * @param keyType
+   *          the key algorithm type name(s), ordered with the
+   *          most-preferred key type first.
+   * @param issuers
+   *          the list of acceptable CA issuer subject names or null
+   *          if it does not matter which issuers are used.
+   * @param socket
+   *          the socket to be used for this connection. This
+   *          parameter can be null, in which case this method will
+   *          return the most generic alias to use.
+   * @return the alias name for the desired key, or null if there are
+   *         no matches.
    */
   public String chooseServerAlias(String keyType, Principal[] issuers,
       Socket socket)
@@ -156,7 +187,13 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Returns the certificate chain associated with the given alias.
+   *
+   * @param alias
+   *          the alias name
+   * @return the certificate chain (ordered with the user's
+   *         certificate first and the root certificate authority
+   *         last), or null if the alias can't be found.
    */
   public X509Certificate[] getCertificateChain(String alias)
   {
@@ -171,7 +208,17 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Get the matching aliases for authenticating the server side of a
+   * secure socket given the public key type and the list of
+   * certificate issuer authorities recognized by the peer (if any).
+   *
+   * @param keyType
+   *          the key algorithm type name
+   * @param issuers
+   *          the list of acceptable CA issuer subject names or null
+   *          if it does not matter which issuers are used.
+   * @return an array of the matching alias names, or null if there
+   *         were no matches.
    */
   public String[] getClientAliases(String keyType, Principal[] issuers)
   {
@@ -186,7 +233,11 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Returns the key associated with the given alias.
+   *
+   * @param alias
+   *          the alias name
+   * @return the requested key, or null if the alias can't be found.
    */
   public PrivateKey getPrivateKey(String alias)
   {
@@ -201,7 +252,17 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Get the matching aliases for authenticating the server side of a
+   * secure socket given the public key type and the list of
+   * certificate issuer authorities recognized by the peer (if any).
+   *
+   * @param keyType
+   *          the key algorithm type name
+   * @param issuers
+   *          the list of acceptable CA issuer subject names or null
+   *          if it does not matter which issuers are used.
+   * @return an array of the matching alias names, or null if there
+   *         were no matches.
    */
   public String[] getServerAliases(String keyType, Principal[] issuers)
   {

--
Gitblit v1.10.0