You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by dr...@apache.org on 2016/01/16 10:49:10 UTC

[12/36] directory-kerby git commit: o Added some Javadoc o Fixed some Javadoc

o Added some Javadoc
o Fixed some Javadoc

Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/00ae0620
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/00ae0620
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/00ae0620

Branch: refs/heads/kadmin-remote
Commit: 00ae0620701b560ea1499ea2b7b4da8eedb36b07
Parents: 93c52c3
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Fri Jan 8 19:48:49 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Fri Jan 8 19:48:49 2016 +0100

----------------------------------------------------------------------
 .../kerberos/kerb/type/KerberosStrings.java     |  1 +
 .../kerby/kerberos/kerb/type/pa/PaData.java     | 12 ++---
 .../kerberos/kerb/type/pa/PaDataEntry.java      | 54 +++++++++++++++++---
 3 files changed, 54 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/00ae0620/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/KerberosStrings.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/KerberosStrings.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/KerberosStrings.java
index 3103b7a..395a7f2 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/KerberosStrings.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/KerberosStrings.java
@@ -34,6 +34,7 @@ public class KerberosStrings extends KrbSequenceOfType<KerberosString> {
 
     public void setValues(List<String> values) {
         clear();
+        
         if (values != null) {
             for (String value : values) {
                 addElement(new KerberosString(value));

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/00ae0620/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaData.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaData.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaData.java
index 677489d..b8f6888 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaData.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaData.java
@@ -22,21 +22,19 @@ package org.apache.kerby.kerberos.kerb.type.pa;
 import org.apache.kerby.kerberos.kerb.type.KrbSequenceOfType;
 
 /**
- * The PaData component as defined in RFC 4120 :
+ * The PaData Sequence as defined in RFC 4120, like in :
  * 
  * <pre>
- * PA-DATA         ::= SEQUENCE {
- *         -- NOTE: first tag is [1], not [0]
- *         padata-type     [1] Int32,
- *         padata-value    [2] OCTET STRING -- might be encoded AP-REQ
- * }
+ * ...
+ * padata          [3] SEQUENCE OF PA-DATA
+ * ...
  * </pre>
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class PaData extends KrbSequenceOfType<PaDataEntry> {
     /**
-     * Creates an instance of PaData
+     * Find a PaData from its type
      * 
      * @param paType The {@link PaDataType}
      * @return An instance of {@link PaDataEntry}, or null if not found

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/00ae0620/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaDataEntry.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaDataEntry.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaDataEntry.java
index 9b340c0..bb8078a 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaDataEntry.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/pa/PaDataEntry.java
@@ -27,56 +27,98 @@ import org.apache.kerby.asn1.type.Asn1OctetString;
 import org.apache.kerby.kerberos.kerb.type.KrbSequenceType;
 
 /**
- PA-DATA         ::= SEQUENCE {
-     -- NOTE: first tag is [1], not [0]
-     padata-type     [1] Int32,
-     padata-value    [2] OCTET STRING -- might be encoded AP-REQ
- }
+ * The PaData component as defined in RFC 4120 :
+ * 
+ * <pre>
+ * PA-DATA         ::= SEQUENCE {
+ *         -- NOTE: first tag is [1], not [0]
+ *         padata-type     [1] Int32,
+ *         padata-value    [2] OCTET STRING -- might be encoded AP-REQ
+ * }
+ * </pre>
+ * 
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class PaDataEntry extends KrbSequenceType {
+    /**
+     * The possible fields
+     */
     protected enum PaDataEntryField implements EnumType {
         PADATA_TYPE,
         PADATA_VALUE;
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public int getValue() {
             return ordinal();
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public String getName() {
             return name();
         }
     }
 
+    /** The PaDataEntrey's fields */
     static Asn1FieldInfo[] fieldInfos = new Asn1FieldInfo[] {
             new ExplicitField(PaDataEntryField.PADATA_TYPE, 1, Asn1Integer.class),
             new ExplicitField(PaDataEntryField.PADATA_VALUE, 2, Asn1OctetString.class)
     };
 
+    /**
+     * Creates an empty PaDataEntry instance
+     */
     public PaDataEntry() {
         super(fieldInfos);
     }
 
+    /**
+     * Creates a PaDataEntry instance with a type and a value
+     * 
+     * @param type the {@link PaDataType} to use
+     * @param paData the data to store
+     */
     public PaDataEntry(PaDataType type, byte[] paData) {
-        this();
+        super(fieldInfos);
         setPaDataType(type);
         setPaDataValue(paData);
     }
 
+    /**
+     * @return The {@link PaDataType} for this instance
+     */
     public PaDataType getPaDataType() {
         Integer value = getFieldAsInteger(PaDataEntryField.PADATA_TYPE);
+        
         return PaDataType.fromValue(value);
     }
 
+    /**
+     * Sets a {@link PaDataType} in this instance
+     * 
+     * @param paDataType The {@link PaDataType} type to store
+     */
     public void setPaDataType(PaDataType paDataType) {
         setFieldAsInt(PaDataEntryField.PADATA_TYPE, paDataType.getValue());
     }
 
+    /**
+     * @return The data stored in this instance
+     */
     public byte[] getPaDataValue() {
         return getFieldAsOctets(PaDataEntryField.PADATA_VALUE);
     }
 
+    /**
+     * Sets some data in this instance
+     *  
+     * @param paDataValue The data to store
+     */
     public void setPaDataValue(byte[] paDataValue) {
         setFieldAsOctets(PaDataEntryField.PADATA_VALUE, paDataValue);
     }