software.coolstuff.springframework.owncloud.model.OwncloudUserDetails Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owncloud-spring-boot-starter Show documentation
Spring Boot Owncloud Service and Authentication Provider
There is a newer version: 1.5.0
Show newest version
/*-
 * #%L
 * owncloud-spring-boot-starter
 * %%
 * Copyright (C) 2016 - 2017 by the original Authors
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
package software.coolstuff.springframework.owncloud.model;

import lombok.*;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;

import javax.validation.constraints.NotNull;
import java.util.Collection;

/**
 * Implementation of the {@link UserDetails} Specification of Spring Security.
 * 
 * An Instance of this Class will be returned by OwncloudUserDetailsService#loadUserByUsername(String).
 *
 * @author mufasa1976
 * @see UserDetails
 * @since 1.0.0
 */
@NoArgsConstructor
@Data
@EqualsAndHashCode(of = "username")
@ToString(exclude = "password")
public class OwncloudUserDetails implements UserDetails {

  private static final long serialVersionUID = 7384295040126418671L;

  /**
   * Username of the authenticated User.
   * @param username Username of the authenticated User
   * @return Username of the authenticated User
   */
  @NotNull
  private String username;

  /**
   * Password of the authenticated User.
   * 
   * Note: The Password will be hidden when calling {@link #toString()}
   */
  @Getter(AccessLevel.NONE)
  private char[] password;

  /**
   * State of the authenticated User (enabled/disabled)
   * @param enabled enable or disable the authenticated User
   * @return is the authenticated User enabled (true) or disabled (false)
   */
  private boolean enabled = true;

  /**
   * Granted Authorities of the authenticated User.
   * @param authorities granted Authorities of the authenticated User
   * @return granted Authorities of the authenticated User
   */
  private Collection authorities;

  /**
   * Display Name of the authenticated User.
   * @param displayname Display Name of the authenticated User
   * @return Display Name of the authenticated User
   */
  private String displayname;

  /**
   * Email of the authenticated User.
   * @param email Email of the authenticated User
   * @return Email of the authenticated User
   */
  private String email;

  /**
   * Quota of the User (in Bytes).
   * @since 1.2.0
   * @param quota Quota of the User (in Bytes)
   * @return Quota of the User (in Bytes)
   */
  private Long quota;

  @Builder
  public OwncloudUserDetails(
      String username,
      String password,
      boolean enabled,
      Collection authorities,
      String displayname,
      String email,
      Long quota) {
    this.username = username;
    setPassword(password);
    this.enabled = enabled;
    this.authorities = authorities;
    this.displayname = displayname;
    this.email = email;
    this.quota = quota;
  }

  @Override
  public String getPassword() {
    if (ArrayUtils.isEmpty(password)) {
      return null;
    }
    return new String(password);
  }

  public void setPassword(String password) {
    if (StringUtils.isBlank(password)) {
      this.password = null;
      return;
    }
    this.password = password.toCharArray();
  }

  @Override
  public boolean isAccountNonExpired() {
    return true;
  }

  @Override
  public boolean isAccountNonLocked() {
    return true;
  }

  @Override
  public boolean isCredentialsNonExpired() {
    return true;
  }
}