UserAccountList.java

/*
 * Copyright (C) 2006-2008 Alfresco Software Limited.
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */

package org.alfresco.jlan.server.auth;

import java.util.Vector;

/**
 * User Account List Class
 *
 * @author gkspencer
 */
public class UserAccountList {

  //	User account list

  private Vector<UserAccount> m_users;

  /**
   * Create a user account list.
   */
  public UserAccountList() {
    m_users = new Vector<UserAccount>();
  }

  /**
   * Add a user to the list of accounts.
   *
   * @param user UserAccount
   */
  public final void addUser(UserAccount user) {

    //	Check if the user exists on the list

    removeUser(user);
    m_users.add(user);
  }

  /**
   * Find the required user account details.
   *
   * @param user String
   * @return UserAccount
   */
  public final UserAccount findUser(String user) {

    //	Search for the specified user account

    for (int i = 0; i < m_users.size(); i++) {
      UserAccount acc = m_users.get(i);
      if (acc.getUserName().equalsIgnoreCase(user))
        return acc;
    }

    //	User not found

    return null;
  }

  /**
   * Determine if the specified user account exists in the list.
   *
   * @return boolean
   * @param user String
   */
  public final boolean hasUser(String user) {

    //	Search for the specified user account

    for (int i = 0; i < m_users.size(); i++) {
      UserAccount acc = m_users.get(i);
      if (acc.getUserName().compareTo(user) == 0)
        return true;
    }

    //	User not found

    return false;
  }

	/**
	 * Return the specified user account details
	 * 
	 * @param idx int
	 * @return UserAccount
	 */
	public final UserAccount getUserAt(int idx) {
	  if ( idx >= m_users.size())
	  	return null;
	  return m_users.get(idx);
	}
	
  /**
   * Return the number of defined user accounts.
   *
   * @return int
   */
  public final int numberOfUsers() {
    return m_users.size();
  }

  /**
   * Remove all user accounts from the list.
   */
  public final void removeAllUsers() {
    m_users.removeAllElements();
  }

  /**
   * Remvoe the specified user account from the list.
   *
   * @param userAcc UserAccount
   */
  public final void removeUser(UserAccount userAcc) {

    //	Search for the specified user account

    for (int i = 0; i < m_users.size(); i++) {
      UserAccount acc = m_users.get(i);
      if (acc.getUserName().compareTo(userAcc.getUserName()) == 0) {
        m_users.removeElementAt(i);
        return;
      }
    }
  }

  /**
   * Remvoe the specified user account from the list.
   *
   * @param user String
   */
  public final void removeUser(String user) {

    //	Search for the specified user account

    for (int i = 0; i < m_users.size(); i++) {
      UserAccount acc = m_users.get(i);
      if (acc.getUserName().compareTo(user) == 0) {
        m_users.removeElementAt(i);
        return;
      }
    }
  }

  /**
   * Return the user account list as a string.
   *
   * @return String
   */
  public String toString() {
    StringBuffer str = new StringBuffer();

    str.append("[");
    str.append(m_users.size());
    str.append(":");

    for (int i = 0; i < m_users.size(); i++) {
      UserAccount acc = m_users.get(i);
      str.append(acc.getUserName());
      str.append(",");
    }
    str.append("]");

    return str.toString();
  }
}