src/authentication/Credential.java

   1 package authentication;
   2
   3 import java.io.Serializable;
   4
   5 /** Authentication credential field.
   6  *
   7  * This class corresponds to one credential value that should be
   8  * exchanged between the client and server in order to authenticate the
   9  * client. Credentials containing secret values, such as passwords, can
  10  * be marked hidden.
  11  */
  12 public class Credential implements Serializable{
  13
  14         private static final long serialVersionUID = -1425162133341080154L;
  15         private String label, value;
  16         private boolean hidden;
  17
  18         /** Create field with given label and hidden attribute.
  19          *
  20          * @param label         The field label.
  21          * @param hidden        Whether the field should be hidden.
  22          */
  23         public Credential(String label, boolean hidden)
  24         {
  25                 super();
  26                 this.label = label;
  27                 this.value = null;
  28                 this.hidden = hidden;
  29         }
  30
  31         /** Dummy constructor to silence compiler. */
  32         public Credential()
  33         {
  34                 this(null, false);
  35         }
  36
  37         /** Is field value hidden?
  38          *
  39          * @return Whether the field is hidden.
  40          */
  41         public boolean isHideValue()
  42         {
  43                 return hidden;
  44         }
  45
  46         /** Change hidden attribute of a field value.
  47          *
  48          * @param hidden        The new state of the hidden attribute.
  49          */
  50         public void setHideValue(boolean hidden)
  51         {
  52                 this.hidden = hidden;
  53         }
  54
  55         /** Get field label.
  56          *
  57          * @return The field label.
  58          */
  59         public String getLabel()
  60         {
  61                 return label;
  62         }
  63
  64         /** Set field label.
  65          *
  66          * @param label         The field label.
  67          */
  68         public void setLabel(String label)
  69         {
  70                 this.label = label;
  71         }
  72
  73         /** Get field value.
  74          *
  75          * @return The field value.
  76          */
  77         public String getValue()
  78         {
  79                 return value;
  80         }
  81
  82         /** Set field value.
  83          *
  84          * @param value The new field value.
  85          */
  86         public void setValue(String value)
  87         {
  88                 this.value = value;
  89         }
  90
  91 }