AccessControlList.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.acl;

import java.util.Vector;
/**
 * Access Control List Class
 * 
 * <p>Contains a list of access controls for a shared filesystem.
 *
 * @author gkspencer
 */
public class AccessControlList {

	//	Access control list

	private Vector<AccessControl> m_list;

	//	Default access level applied when rules return a default status
	
	private int m_defaultAccess = AccessControl.ReadWrite;
	
	/**
	 * Create an access control list.
	 */
	public AccessControlList() {
		m_list = new Vector<AccessControl>();
	}

	/**
	 * Get the default access level
	 * 
	 * @return int
	 */
	public final int getDefaultAccessLevel() {
		return m_defaultAccess;
	}

	/**
	 * Set the default access level
	 * 
	 * @param level int
	 * @exception InvalidACLTypeException		If the access level is invalid
	 */	
	public final void setDefaultAccessLevel(int level)
		throws InvalidACLTypeException {
		
		//	Check the default access level
		
		if( level < AccessControl.NoAccess || level > AccessControl.MaxLevel)
			throw new InvalidACLTypeException();
			
		//	Set the default access level for the access control list
		
		m_defaultAccess = level;
	}
	
	/**
	 * Add an access control to the list
	 *
	 * @param accCtrl AccessControl
	 */
	public final void addControl(AccessControl accCtrl) {

		//	Add the access control to the list

		m_list.add(accCtrl);
	}

	/**
	 * Return the specified access control
	 * 
	 * @param idx int
	 * @return AccessControl
	 */
	public final AccessControl getControlAt(int idx) {
		if ( idx < 0 || idx >= m_list.size())
			return null;
		return m_list.get(idx);
	}
	
	/**
	 * Return the number of access controls in the list
	 *
	 * @return int
	 */
	public final int numberOfControls() {
		return m_list.size();
	}

	/**
	 * Remove all access controls from the list
	 */
	public final void removeAllControls() {
		m_list.removeAllElements();
	}

	/**
	 * Remove the specified access control from the list.
	 *
	 * @param idx int
	 * @return AccessControl
	 */
	public final AccessControl removeControl(int idx) {
		if ( idx < 0 || idx >= m_list.size())
			return null;
		return m_list.remove(idx);
	}

	/**
	 * Return the access control list as a string.
	 *
	 * @return java.lang.String
	 */
	public String toString() {
		StringBuffer str = new StringBuffer();

		str.append("[");
		str.append(m_list.size());
		str.append(":");
		
		str.append(":");
		str.append(AccessControl.asAccessString(getDefaultAccessLevel()));
		str.append(":");

		for (int i = 0; i < m_list.size(); i++) {
			AccessControl ctrl = m_list.get(i);
			str.append(ctrl.toString());
			str.append(",");
		}
		str.append("]");

		return str.toString();
	}
}