java/src/main/com/google/appengine/api/users/User.java

   1 // Copyright 2007 Google Inc. All rights reserved.
   2
   3 package com.google.appengine.api.users;
   4
   5 import java.io.Serializable;
   6
   7 /**
   8  * {@code User} represents a specific user, represented by the
   9  * combination of an email address and a specific Google Apps domain
  10  * (which we call an {@code authDomain}).  For normal Google login,
  11  * {@code authDomain} will be set to "gmail.com".
  12  *
  13  */
  14 public final class User implements Serializable, Comparable<User> {
  15   static final long serialVersionUID = 8691571286358652288L;
  16
  17   private String email;
  18
  19   private String authDomain;
  20
  21   private String userId;
  22
  23   private String federatedIdentity;
  24
  25   /**
  26    * This constructor exists for frameworks (e.g. Google Web Toolkit)
  27    * that require it for serialization purposes.  It should not be
  28    * called explicitly.
  29    */
  30   @SuppressWarnings("unused")
  31   private User() {
  32   }
  33
  34   /**
  35    * Creates a new User.
  36    *
  37    * @param email a not {@code null} email address.
  38    * @param authDomain a not {@code null} domain name into which this
  39    * user has authenticated, or "gmail.com" for normal Google
  40    * authentication.
  41    */
  42   public User(String email, String authDomain) {
  43     this(email, authDomain, null);
  44   }
  45
  46   /**
  47    * Creates a new User.
  48    *
  49    * @param email a not {@code null} email address.
  50    * @param authDomain a not {@code null} domain name into which this
  51    * user has authenticated, or "gmail.com" for normal Google
  52    * authentication.
  53    * @param userId a possibly-null string uniquely identifying the specified user.
  54    */
  55   public User(String email, String authDomain, String userId) {
  56     if (email == null) {
  57       throw new NullPointerException("email must be specified");
  58     }
  59     if (authDomain == null) {
  60       throw new NullPointerException("authDomain must be specified");
  61     }
  62     this.email = email;
  63     this.authDomain = authDomain;
  64     this.userId = userId;
  65   }
  66
  67   /**
  68    * Creates a new User with a federated identity.
  69    *
  70    * @param email an optional field holding the user's email.
  71    * @param authDomain the URL of the identity provider. Could be null.
  72    * @param userId a unique id for this user. Could be null.
  73    * @param federatedIdentity a not {@code null} asserted federated identity.
  74    */
  75   public User(String email, String authDomain, String userId, String federatedIdentity) {
  76     if (federatedIdentity == null) {
  77       throw new NullPointerException("Identity must be specified");
  78     }
  79     if (authDomain == null) {
  80       this.authDomain = "";
  81     } else {
  82       this.authDomain = authDomain;
  83     }
  84     if (userId == null) {
  85       this.userId = "";
  86     } else {
  87       this.userId = userId;
  88     }
  89     this.email = email;
  90     this.federatedIdentity = federatedIdentity;
  91   }
  92   /**
  93    * Return this user's nickname.
  94    *
  95    * The nickname will be a unique, human readable identifier for this user
  96    * with respect to this application. It will be an email address for some
  97    * users, but not all.
  98    */
  99   public String getNickname() {
 100     int indexOfDomain = email.indexOf("@" + authDomain);
 101     if (indexOfDomain == -1) {
 102       return email;
 103     }
 104     return email.substring(0, indexOfDomain);
 105   }
 106
 107   public String getAuthDomain() {
 108     return authDomain;
 109   }
 110
 111   public String getEmail() {
 112     return email;
 113   }
 114
 115   /**
 116    * Returns an opaque string that uniquely identifies the user
 117    * represented by this {@code User} object.
 118    *
 119    * <p>May be null if this {@code User} object was created explicitly
 120    * and no user ID was supplied.
 121    */
 122   public String getUserId() {
 123     return userId;
 124   }
 125
 126   public String getFederatedIdentity() {
 127     return federatedIdentity;
 128   }
 129
 130   @Override
 131   public String toString() {
 132     return email;
 133   }
 134
 135   @Override
 136   public boolean equals(Object object) {
 137     if (!(object instanceof User)) {
 138       return false;
 139     }
 140
 141     User user = (User) object;
 142     if ((federatedIdentity != null) && (!federatedIdentity.isEmpty())) {
 143       return user.federatedIdentity.equals(federatedIdentity);
 144     }
 145     return user.email.equals(email) && user.authDomain.equals(authDomain);
 146   }
 147
 148   @Override
 149   public int hashCode() {
 150     return 17 * email.hashCode() + authDomain.hashCode();
 151   }
 152
 153   public int compareTo(User user) {
 154     return email.compareTo(user.email);
 155   }
 156 }