DomainUser.java

/*
 * Copyright 2019-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bremersee.dccon.model;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.media.Schema.AccessMode;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import javax.validation.constraints.NotNull;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import org.springframework.validation.annotation.Validated;

/**
 * Domain user.
 *
 * @author Christian Bremer
 */
@Schema(description = "Domain user.")
@Validated
@JsonIgnoreProperties(ignoreUnknown = true)
@Getter
@Setter
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true, exclude = {"password"})
@NoArgsConstructor
public class DomainUser extends CommonAttributes {

  /**
   * The constant DEFAULT_SORT_ORDER.
   */
  public static final String DEFAULT_SORT_ORDER = "userName";

  private static final long serialVersionUID = 1L;

  @Schema(description = "The windows/samba SID.", accessMode = AccessMode.READ_ONLY)
  @JsonProperty("sid")
  private Sid sid;

  @Schema(description = "The user name of the domain user.", required = true)
  @JsonProperty(value = "userName", required = true)
  @NotNull
  private String userName;

  @Schema(description = "Specifies whether the user is enabled or not.")
  @JsonProperty("enabled")
  private Boolean enabled = Boolean.FALSE;

  @Schema(description = "The first name of the domain user.")
  @JsonProperty("firstName")
  private String firstName;

  @Schema(description = "The last name of the domain user.")
  @JsonProperty("lastName")
  private String lastName;

  @Schema(description = "The display name.")
  @JsonProperty("displayName")
  private String displayName;

  @Schema(description = "The email address of the domain user.")
  @JsonProperty("email")
  private String email;

  @Schema(description = "The telephone number of the domain user.")
  @JsonProperty("telephoneNumber")
  private String telephoneNumber;

  @Schema(description = "The mobile number of the domain user.")
  @JsonProperty("mobile")
  private String mobile;

  @Schema(description = "A description of the domain user.")
  @JsonProperty("description")
  private String description;

  @Schema(description = "The home directory of the domain user.")
  @JsonProperty("homeDirectory")
  private String homeDirectory;

  @Schema(description = "The unix home directory of the domain user.")
  @JsonProperty("unixHomeDirectory")
  private String unixHomeDirectory;

  @Schema(description = "The login shell of the domain user.")
  @JsonProperty("loginShell")
  private String loginShell;

  @Schema(
      description = "The last logon time of the domain user.",
      accessMode = AccessMode.READ_ONLY)
  @JsonProperty("lastLogon")
  private OffsetDateTime lastLogon;

  @Schema(
      description = "The logon count of the domain user.",
      accessMode = AccessMode.READ_ONLY)
  @JsonProperty("logonCount")
  private Integer logonCount;

  @Schema(
      description = "Date of the last password change.",
      accessMode = AccessMode.READ_ONLY)
  @JsonProperty("passwordLastSet")
  private OffsetDateTime passwordLastSet;

  @Schema(description = "The password of the domain user.")
  @JsonProperty("password")
  private String password;

  @Schema(description = "The groups of the domain user.")
  @JsonProperty("groups")
  private List<String> groups;

  /**
   * Instantiates a new domain user.
   *
   * @param distinguishedName the distinguished name
   * @param created the created
   * @param modified the modified
   * @param sid the windows/samba SID
   * @param userName the user name
   * @param enabled the enabled
   * @param firstName the first name
   * @param lastName the last name
   * @param displayName the display name
   * @param email the email
   * @param telephoneNumber the telephone number
   * @param mobile the mobile
   * @param description the description
   * @param homeDirectory the home directory
   * @param unixHomeDirectory the unix home directory
   * @param loginShell the login shell
   * @param lastLogon the last logon
   * @param logonCount the logon count
   * @param passwordLastSet the password last set
   * @param password the password
   * @param groups the groups
   */
  @SuppressWarnings("unused")
  @Builder(toBuilder = true)
  public DomainUser(String distinguishedName, OffsetDateTime created, OffsetDateTime modified,
      Sid sid, String userName, Boolean enabled, String firstName, String lastName,
      String displayName, String email, String telephoneNumber, String mobile, String description,
      String homeDirectory, String unixHomeDirectory, String loginShell, OffsetDateTime lastLogon,
      Integer logonCount, OffsetDateTime passwordLastSet, String password, List<String> groups) {
    super(distinguishedName, created, modified);
    this.sid = sid;
    this.userName = userName;
    this.enabled = enabled;
    this.firstName = firstName;
    this.lastName = lastName;
    this.displayName = displayName;
    this.email = email;
    this.telephoneNumber = telephoneNumber;
    this.mobile = mobile;
    this.description = description;
    this.homeDirectory = homeDirectory;
    this.unixHomeDirectory = unixHomeDirectory;
    this.loginShell = loginShell;
    this.lastLogon = lastLogon;
    this.logonCount = logonCount;
    this.passwordLastSet = passwordLastSet;
    this.password = password;
    this.groups = groups;
  }

  /**
   * Specifies whether the user is enabled or not.
   *
   * @return {@code true} is the user is enabled, otherwise {@code false}
   */
  public Boolean getEnabled() {
    return Boolean.TRUE.equals(enabled);
  }

  /**
   * Sets whether the user is enabled or not.
   *
   * @param enabled {@code true} if the user should be enabled, otherwise {@code false}
   */
  public void setEnabled(Boolean enabled) {
    this.enabled = Boolean.TRUE.equals(enabled);
  }

  /**
   * The groups of the domain user.
   *
   * @return groups groups
   */
  public List<String> getGroups() {
    if (groups == null) {
      groups = new ArrayList<>();
    }
    return groups;
  }

  /**
   * Sets groups.
   *
   * @param groups the groups
   */
  public void setGroups(List<String> groups) {
    this.groups = groups;
  }

}