Document PreferredKeyServer

Author: vanitasvitae

pg/src/main/java/org/bouncycastle/bcpg/sig/PreferredKeyServer.java

@@ -5,6 +5,18 @@
 import org.bouncycastle.util.Arrays;
 import org.bouncycastle.util.Strings;
 
+/**
+ * Signature Subpacket containing the URI of the users preferred key server.
+ * This is a URI of a key server that the key holder prefers be used for updates.
+ * Note that keys with multiple User IDs can have a preferred key server for each User ID.
+ * Note also that since this is a URI, the key server can actually be a copy of the key
+ * retrieved by ftp, http, finger, etc.
+ *
+ * @see <a href="https://datatracker.ietf.org/doc/html/rfc4880#section-5.2.3.18">
+ *     RFC4880 - Preferred Key Server</a>
+ * @see <a href="https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-13.html#name-preferred-key-server">
+ *     C-R - Preferred Key Server</a>
+ */
 public class PreferredKeyServer
         extends SignatureSubpacket
 {
@@ -18,6 +30,10 @@ public PreferredKeyServer(boolean critical, String uri)
         this(critical, false, Strings.toUTF8ByteArray(uri));
     }
 
+    /**
+     * Return the URI of the users preferred key server.
+     * @return key server uri
+     */
     public String getURI()
     {
         return Strings.fromUTF8ByteArray(data);