com.sanctionco.thunder.models.User Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
There is a newer version: 3.1.0
package com.sanctionco.thunder.models;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.StringJoiner;

/**
 * Represents a user, providing access to the user's email, password, and additional properties.
 */
public class User {
  private final Email email;
  private final String password;

  @JsonPropertyOrder(alphabetic = true)
  private final Map properties;

  /**
   * Constructs a new user with the given email, password, and additional properties.
   *
   * @param email the user's email. This is the user's primary key.
   * @param password the user's hashed (not plaintext) password
   * @param properties the map of additional user properties. If null, an empty map will be used.
   */
  @JsonCreator
  public User(@JsonProperty("email") Email email,
              @JsonProperty("password") String password,
              @JsonProperty("properties") Map properties) {
    this.email = email;
    this.password = password;
    this.properties = Optional.ofNullable(properties).orElse(new HashMap<>());
  }

  public Email getEmail() {
    return email;
  }

  public String getPassword() {
    return password;
  }

  @JsonAnyGetter
  public Map getProperties() {
    return properties;
  }

  @JsonAnySetter
  public void setProperty(String name, Object value) {
    properties.put(name, value);
  }

  /**
   * Creates a new User instance with the same properties as the current one,
   * adding additional creationTime and lastUpdatedTime properties.
   *
   * @param creationTime the creation time of the user
   * @param lastUpdateTime the last updated time of the user
   * @return a new {@code User} instance with the two properties added
   */
  public User withTime(long creationTime, long lastUpdateTime) {
    var copy = new User(email, password, new HashMap<>(properties));

    copy.setProperty("creationTime", creationTime);
    copy.setProperty("lastUpdateTime", lastUpdateTime);

    return copy;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }

    if (!(obj instanceof User)) {
      return false;
    }

    User other = (User) obj;
    return Objects.equals(this.email, other.email)
        && Objects.equals(this.password, other.password)
        && Objects.equals(this.properties, other.properties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(email, password, properties);
  }

  @Override
  public String toString() {
    return new StringJoiner(", ", "User [", "]")
        .add(String.format("email=%s", email))
        .add(String.format("password=%s", password))
        .add(String.format("properties=%s", properties))
        .toString();
  }
}