com.samskivert.servlet.user.User Maven / Gradle / Ivy

Go to download
//
// samskivert library - useful routines for java programs
// Copyright (C) 2001-2011 Michael Bayne, et al.
// http://github.com/samskivert/samskivert/blob/master/COPYING

package com.samskivert.servlet.user;

import java.sql.Date;

import com.samskivert.jdbc.jora.FieldMask;
import com.samskivert.util.StringUtil;

/**
 * A user object contains information about a registered user in our web application environment.
 * Users are stored in the user repository (a database table) and loaded during a request based on
 * authentication information provided with the request headers.
 *
 * Note: Do not modify any of the fields of this object directly. Use the
 * set methods to make updates. If no set methods exist, you shouldn't be modifying
 * that field.
 */
public class User
{
    /** The user's assigned integer userid. */
    public int userId;

    /** The user's chosen username. */
    public String username;

    /** The date this record was created. */
    public Date created;

    /** The user's real name (first, last and whatever else they opt to provide). */
    public String realname;

    /** The user's chosen password (encrypted). */
    public String password;

    /** The user's email address. */
    public String email;

    /** The site identifier of the site through which the user created their account. (Their
     * affiliation, if you will.) */
    public int siteId;

    /**
     * Updates the user's username.
     */
    public void setUsername (Username username)
    {
        this.username = username.getUsername();
        setModified("username");
    }

    /**
     * Updates the user's real name.
     */
    public void setRealName (String realname)
    {
        this.realname = realname;
        setModified("realname");
    }

    /**
     * Updates the user's password.
     *
     * @param password The user's new (unencrypted) password.
     */
    public void setPassword (String password)
    {
        setPassword(Password.makeFromClear(password));
    }

    /**
     * Updates the user's password.
     *
     * @param password The user's new password.
     */
    public void setPassword (Password password)
    {
        this.password = password.getEncrypted();
        setModified("password");
    }

    /**
     * Updates the user's email address.
     */
    public void setEmail (String email)
    {
        this.email = email;
        setModified("email");
    }

    /**
     * Updates the user's site id.
     */
    public void setSiteId (int siteId)
    {
        this.siteId = siteId;
        setModified("siteId");
    }

    /**
     * Compares the supplied password with the password associated with this user record.
     *
     * @return true if the passwords match, false if they do not.
     */
    public boolean passwordsMatch (Password password)
    {
        return this.password.equals(password.getEncrypted());
    }

    /**
     * @return true if this User has been "deleted".
     */
    public boolean isDeleted ()
    {
        // a deleted account has an "=" in the username
        return (-1 != username.indexOf('='));
    }

    /**
     * Returns true if this user is an admin, false otherwise. The default implementation does not
     * track admin status and always returns false.
     */
    public boolean isAdmin ()
    {
        return false;
    }

    @Override // from Object
    public String toString ()
    {
        return StringUtil.fieldsToString(this);
    }

    /**
     * Called by the repository to find out which fields have been modified since the object was
     * loaded.
     */
    protected FieldMask getDirtyMask ()
    {
        return _dirty;
    }

    /**
     * Called by the repository to configure this user record with a field mask that it can use to
     * track modified fields.
     */
    protected void setDirtyMask (FieldMask dirty)
    {
        _dirty = dirty;
    }

    /**
     * Marks the supplied field as dirty.
     */
    protected void setModified (String field)
    {
        _dirty.setModified(field);
    }

    /** Our dirty field mask. */
    protected transient FieldMask _dirty;
}