User.java

package fi.insomnia.bortal.model;

import java.util.Calendar;
import java.util.List;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.OrderBy;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;
import javax.validation.constraints.NotNull;

import org.eclipse.persistence.annotations.OptimisticLocking;
import org.eclipse.persistence.annotations.OptimisticLockingType;
import org.eclipse.persistence.annotations.PrivateOwned;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fi.insomnia.bortal.enums.Gender;
import fi.insomnia.bortal.utilities.PasswordFunctions;

/**
 * 
 */
@Entity
@Table(name = "users")
@OptimisticLocking(type = OptimisticLockingType.CHANGED_COLUMNS)
public class User extends GenericEntity implements IUser {
    public static final String ANONYMOUS_LOGINNAME = "anonymous";
    private static final long serialVersionUID = -1632200627103418206L;

    @Column(name = "created", nullable = false)
    @Temporal(TemporalType.TIMESTAMP)
    private Calendar created = Calendar.getInstance();

    @NotNull
    @Column(name = "login", unique = true, nullable = false)
    private String login = "";

    @Column(name = "active", nullable = false, columnDefinition = "boolean default true")
    private boolean active = true;

    @Column(name = "password")
    private String password;

    @Column(name = "lastname")
    private String lastname = "";

    @Column(name = "firstnames")
    private String firstnames = "";

    @Column(name = "birthday")
    @Temporal(TemporalType.TIMESTAMP)
    private Calendar birthday;

    @Column(name = "nick")
    private String nick = "";

    @Column(name = "email")
    private String email = "";

    @Column(name = "address")
    private String address = "";

    @Column(name = "zip")
    private String zip = "";

    @Column(name = "postal_town")
    private String postalTown = "";

    @Column(name = "town")
    private String town = "";

    @Column(name = "phone")
    private String phone = "";

    @OneToOne(cascade = CascadeType.ALL)
    @JoinColumn(name = "current_image_id", referencedColumnName = "id")
    private UserImage currentImage;

    @Enumerated(EnumType.STRING)
    @Column(name = "gender", nullable = false)
    private Gender gender = Gender.UNDEFINED;

    /**
     * hash generated for password reset..
     */
    @Column(name = "confirm_hash")
    private String confirmHash;

    @Column(name = "confirm_time")
    @Temporal(TemporalType.TIMESTAMP)
    private Calendar confirmTime;

    @Column(name = "superadmin")
    private boolean superadmin = false;

    @OneToMany(mappedBy = "user", fetch = FetchType.LAZY, cascade = CascadeType.ALL)
    @OrderBy
    @PrivateOwned
    private List<UserImage> userImageList;

    @Transient
    private static final Logger logger = LoggerFactory.getLogger(User.class);

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getCreated()
     */
    @Override
    public Calendar getCreated() {
        return created;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setCreated(java.util.Calendar)
     */
    @Override
    public void setCreated(Calendar created) {
        this.created = created;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getActive()
     */
    @Override
    public boolean getActive() {
        return active;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setActive(boolean)
     */
    @Override
    public void setActive(boolean active) {
        this.active = active;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getPassword()
     */
    @Override
    public String getPassword() {
        logger.warn("Directly reading raw User password");
        return password;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setPassword(java.lang.String)
     */
    @Override
    public void setPassword(String password) {
        logger.warn("Directly settings raw User password");
        this.password = password;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getWholeName()
     */
    @Override
    public String getWholeName() {
        String ret = new StringBuilder().append(firstnames).append(" ").append(lastname).toString().trim();
        if (ret.isEmpty()) {
            ret = login;
        }
        return ret;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getLastname()
     */
    @Override
    public String getLastname() {
        return lastname;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setLastname(java.lang.String)
     */
    @Override
    public void setLastname(String lastname) {
        this.lastname = lastname;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getFirstnames()
     */
    @Override
    public String getFirstnames() {
        return firstnames;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setFirstnames(java.lang.String)
     */
    @Override
    public void setFirstnames(String firstnames) {
        this.firstnames = firstnames;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getBirthday()
     */
    @Override
    public Calendar getBirthday() {
        return birthday;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setBirthday(java.util.Calendar)
     */
    @Override
    public void setBirthday(Calendar birthday) {
        this.birthday = birthday;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getNick()
     */
    @Override
    public String getNick() {
        return nick;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setNick(java.lang.String)
     */
    @Override
    public void setNick(String nick) {
        this.nick = nick;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getEmail()
     */
    @Override
    public String getEmail() {
        return email;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setEmail(java.lang.String)
     */
    @Override
    public void setEmail(String email) {
        this.email = email;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getAddress()
     */
    @Override
    public String getAddress() {
        return address;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setAddress(java.lang.String)
     */
    @Override
    public void setAddress(String address) {
        this.address = address;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getZip()
     */
    @Override
    public String getZip() {
        return zip;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setZip(java.lang.String)
     */
    @Override
    public void setZip(String zip) {
        this.zip = zip;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getTown()
     */
    @Override
    public String getTown() {
        return town;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setTown(java.lang.String)
     */
    @Override
    public void setTown(String town) {
        this.town = town;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getPhone()
     */
    @Override
    public String getPhone() {
        return phone;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setPhone(java.lang.String)
     */
    @Override
    public void setPhone(String phone) {
        this.phone = phone;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getLogin()
     */
    @Override
    public String getLogin() {
        return login;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setLogin(java.lang.String)
     */
    @Override
    public void setLogin(String login) {
        // Do not allow anonymous userchange
        if (!isAnonymous()) {
            if (login != null) {
                this.login = login.trim().toLowerCase();
            } else {
                login = null;
            }
        }

    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getUserImageList()
     */
    @Override
    public List<UserImage> getUserImageList() {
        return userImageList;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setUserImageList(java.util.List)
     */
    @Override
    public void setUserImageList(List<UserImage> userImageList) {
        this.userImageList = userImageList;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getConfirmHash()
     */
    @Override
    public String getConfirmHash() {
        return confirmHash;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setConfirmHash(java.lang.String)
     */
    @Override
    public void setConfirmHash(String confirmHash) {
        this.confirmHash = confirmHash;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getConfirmTime()
     */
    @Override
    public Calendar getConfirmTime() {
        return confirmTime;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setConfirmTime(java.util.Calendar)
     */
    @Override
    public void setConfirmTime(Calendar confirmTime) {
        this.confirmTime = confirmTime;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#resetPassword(java.lang.String)
     */
    @Override
    public void resetPassword(String password) {
        String newEncryptedPassword = PasswordFunctions.getEncryptedPassword(password);
        this.password = newEncryptedPassword; // Bypass setter
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#checkPassword(java.lang.String)
     */
    @Override
    public boolean checkPassword(String plainPassword) {
        boolean matches = PasswordFunctions.checkPlainPassword(plainPassword, this.password);
        return matches;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setSuperadmin(boolean)
     */
    @Override
    public void setSuperadmin(boolean superadmin) {
        this.superadmin = superadmin;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#isSuperadmin()
     */
    @Override
    public boolean isSuperadmin() {
        return superadmin;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#setPostalTown(java.lang.String)
     */
    @Override
    public void setPostalTown(String postalTown) {
        this.postalTown = postalTown;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getPostalTown()
     */
    @Override
    public String getPostalTown() {
        return postalTown;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * fi.insomnia.bortal.model.IUser#setGender(fi.insomnia.bortal.enums.Gender)
     */
    @Override
    public void setGender(Gender gender) {
        this.gender = gender;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getGender()
     */
    @Override
    public Gender getGender() {
        return gender;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * fi.insomnia.bortal.model.IUser#setCurrentImage(fi.insomnia.bortal.model
     * .UserImage)
     */
    @Override
    public void setCurrentImage(UserImage currentImage) {
        this.currentImage = currentImage;
    }

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#getCurrentImage()
     */
    @Override
    public UserImage getCurrentImage() {
        return currentImage;
    }

    @Transient
    private Boolean isAnon;

    /*
     * (non-Javadoc)
     * 
     * @see fi.insomnia.bortal.model.IUser#isAnonymous()
     */
    @Override
    public boolean isAnonymous() {
        if (isAnon == null) {
            isAnon = ANONYMOUS_LOGINNAME.equals(login);
        }
        return isAnon;
    }

}