com.foreach.across.modules.user.business.User Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of user-module Show documentation
User Module
The newest version!
/*
 * Copyright 2014 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 com.foreach.across.modules.user.business;

import com.foreach.across.modules.hibernate.repositories.Undeletable;
import com.foreach.across.modules.user.config.UserSchemaConfiguration;
import com.foreach.across.modules.user.converters.HibernateUserRestriction;
import org.apache.commons.lang3.StringUtils;
import org.hibernate.annotations.Type;
import org.springframework.beans.BeanUtils;

import javax.annotation.concurrent.NotThreadSafe;
import javax.persistence.Column;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
import java.util.Collection;
import java.util.EnumSet;
import java.util.Set;

@NotThreadSafe
@Entity
@DiscriminatorValue("user")
@Table(name = UserSchemaConfiguration.TABLE_USER)
public class User extends GroupedPrincipal implements Undeletable
{
	// todo: cant just use validation for controller since current version only sets username after
	// validation in case email as username is set
	@NotBlank
	@Size(max = 255)
	@Column(nullable = false, name = "username")
	private String username;

	@Size(max = 255)
	@Column(name = "first_name")
	private String firstName;

	@Size(max = 255)
	@Column(name = "last_name")
	private String lastName;

	@Size(max = 255)
	@Column(name = "display_name")
	private String displayName;

	@Email
	@Size(max = 255)
	@Column(name = "email")
	private String email;

	@Size(max = 255)
	@Column(name = "user_pwd")
	private String password;

	@Column(name = "email_confirmed", nullable = false)
	private boolean emailConfirmed;

	@Column(name = "deleted", nullable = false)
	private boolean deleted;

	@Column(name = "restrictions", nullable = true)
	@Type(type = HibernateUserRestriction.CLASS_NAME)
	private Set restrictions = EnumSet.noneOf( UserRestriction.class );

	public String getUsername() {
		return StringUtils.lowerCase( username );
	}

	public void setUsername( String username ) {
		this.username = StringUtils.lowerCase( username );
		setPrincipalName( this.username );
	}

	public String getFirstName() {
		return firstName;
	}

	public void setFirstName( String firstName ) {
		this.firstName = firstName;
	}

	public String getLastName() {
		return lastName;
	}

	public void setLastName( String lastName ) {
		this.lastName = lastName;
	}

	public String getDisplayName() {
		return displayName;
	}

	public void setDisplayName( String displayName ) {
		this.displayName = displayName;
	}

	public String getEmail() {
		return StringUtils.lowerCase( email );
	}

	public void setEmail( String email ) {
		this.email = StringUtils.lowerCase( email );
	}

	/**
	 * Returns a display label for this user.  Uses the display name if set, else first and last name and falls back
	 * to username if none of them are set.
	 *
	 * @return label
	 */
	public String getLabel() {
		String label = StringUtils.defaultString( displayName );

		if ( label.length() == 0 ) {
			label = StringUtils.join( firstName, " ", lastName ).trim();
		}

		return label.length() > 0 ? label : StringUtils.defaultString( username );
	}

	public String getPassword() {
		return password;
	}

	public void setPassword( String password ) {
		this.password = password;
	}

	public boolean getEmailConfirmed() {
		return emailConfirmed;
	}

	public void setEmailConfirmed( boolean emailConfirmed ) {
		this.emailConfirmed = emailConfirmed;
	}

	public boolean isDeleted() {
		return deleted;
	}

	public void setDeleted( boolean deleted ) {
		this.deleted = deleted;
	}

	public Set getRestrictions() {
		return restrictions;
	}

	public void setRestrictions( Collection restrictions ) {
		getRestrictions().clear();
		if ( restrictions != null ) {
			getRestrictions().addAll( restrictions );
		}
	}

	public boolean hasRestriction( UserRestriction restriction ) {
		return getRestrictions().contains( restriction );
	}

	public boolean hasRestrictions() {
		return !getRestrictions().isEmpty();
	}

	public boolean isAccountNonExpired() {
		return !getRestrictions().contains( UserRestriction.EXPIRED );
	}

	public boolean isAccountNonLocked() {
		return !getRestrictions().contains( UserRestriction.LOCKED );
	}

	public boolean isCredentialsNonExpired() {
		return !getRestrictions().contains( UserRestriction.CREDENTIALS_EXPIRED );
	}

	public boolean isEnabled() {
		return !getRestrictions().contains( UserRestriction.DISABLED )
				&& !getRestrictions().contains( UserRestriction.REQUIRES_CONFIRMATION );
	}

	@Override
	public User toDto() {
		User user = new User();
		BeanUtils.copyProperties( this, user, "password" );

		return user;
	}

}