edu.vt.middleware.password.PasswordData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vt-password Show documentation
Library for checking that a password complies with a custom set of rules
The newest version!
/*
  $Id$

  Copyright (C) 2003-2013 Virginia Tech.
  All rights reserved.

  SEE LICENSE FOR MORE INFORMATION

  Author:  Middleware Services
  Email:   [email protected]
  Version: $Revision$
  Updated: $Date$
*/
package edu.vt.middleware.password;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Contains password related information used by rules to perform password
 * validation.
 *
 * @author  Middleware Services
 * @version  $Revision: 1643 $ $Date: 2010-10-07 13:14:08 -0400 (Thu, 07 Oct 2010) $
 */
public class PasswordData
{

  /** Stores the password. */
  private Password password;

  /** Stores the username. */
  private String username;

  /** Password history. */
  private List passwordHistory = new ArrayList();

  /** Password sources. */
  private Map passwordSources = new HashMap();


  /** Default constructor. */
  public PasswordData() {}


  /**
   * Creates a new password data.
   *
   * @param  p  password
   */
  public PasswordData(final Password p)
  {
    setPassword(p);
  }


  /**
   * Sets the password.
   *
   * @param  p  password
   */
  public void setPassword(final Password p)
  {
    if (p == null) {
      throw new NullPointerException("Password cannot be null");
    }
    password = p;
  }


  /**
   * Returns the password.
   *
   * @return  password
   */
  public Password getPassword()
  {
    return password;
  }


  /**
   * Sets the username.
   *
   * @param  s  username
   */
  public void setUsername(final String s)
  {
    if (s == null) {
      throw new NullPointerException("Username cannot be null");
    }
    username = s;
  }


  /**
   * Returns the username.
   *
   * @return  username
   */
  public String getUsername()
  {
    return username;
  }


  /**
   * Returns the password history.
   *
   * @return  password history
   */
  public List getPasswordHistory()
  {
    return passwordHistory;
  }


  /**
   * Sets the password history.
   *
   * @param  l  password history
   */
  public void setPasswordHistory(final List l)
  {
    passwordHistory = l;
  }


  /**
   * Returns the password sources.
   *
   * @return  password sources
   */
  public Map getPasswordSources()
  {
    return passwordSources;
  }


  /**
   * Sets the password sources.
   *
   * @param  m  password sources
   */
  public void setPasswordSources(final Map m)
  {
    passwordSources = m;
  }


  /**
   * Convenience method for creating a password data with all of it's
   * properties. Properties are ignored if they are null or if collections are
   * empty.
   *
   * @param  p  password
   * @param  u  username
   * @param  h  history
   * @param  s  sources
   *
   * @return  password data
   */
  public static PasswordData newInstance(
    final Password p,
    final String u,
    final List h,
    final Map s)
  {
    final PasswordData pd = new PasswordData();
    if (p != null) {
      pd.setPassword(p);
    }
    if (u != null) {
      pd.setUsername(u);
    }
    if (h != null && !h.isEmpty()) {
      pd.setPasswordHistory(h);
    }
    if (s != null && !s.isEmpty()) {
      pd.setPasswordSources(s);
    }
    return pd;
  }


  /** {@inheritDoc} */
  @Override
  public String toString()
  {
    return
      String.format(
        "%s@%h::username=%s,password=%s,passwordHistory=%s,passwordSources=%s",
        getClass().getName(),
        hashCode(),
        username,
        password,
        passwordHistory,
        passwordSources);
  }
}