org.zaproxy.zap.extension.users.ContextUserAuthManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zap Show documentation

The Zed Attack Proxy (ZAP) is an easy to use integrated penetration testing tool for finding vulnerabilities in web applications. It is designed to be used by people with a wide range of security experience and as such is ideal for developers and functional testers who are new to penetration testing. ZAP provides automated scanners as well as a set of tools that allow you to find security vulnerabilities manually.

There is a newer version: 2.15.0

Show newest version

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 * 
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 * 
 * Copyright 2013 The ZAP Development Team
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0 
 *   
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */
package org.zaproxy.zap.extension.users;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.zaproxy.zap.model.Context;
import org.zaproxy.zap.users.Role;
import org.zaproxy.zap.users.User;

/**
 * The Manager that handles all the information related to {@link User Users}, {@link Role Roles}
 * and authentications corresponding to a particular {@link Context}.
 */
public class ContextUserAuthManager {

	/** The context id. */
	private int contextId;

	/** The model. */
	private List users;

	public ContextUserAuthManager(int contextId) {
		this.contextId = contextId;
		this.users = new ArrayList<>();
	}

	/**
	 * Builds a table model for the users.
	 * 
	 * @return the model
	 */
	public UsersTableModel getUsersModel() {
		return new UsersTableModel(this.users);
	}

	/**
	 * Gets the context id to which this object corresponds.
	 * 
	 * @return the context id
	 */
	public int getContextId() {
		return contextId;
	}

	/**
	 * Gets an unmodifiable view of the list of users.
	 * 
	 * @return the users
	 */
	public List getUsers() {
		return Collections.unmodifiableList(users);
	}

	/**
	 * Sets a new list of users for this context. An internal copy of the provided list is stored.
	 * 
	 * @param users the users
	 */
	public void setUsers(List users) {
		this.users = new ArrayList<>(users);
	}

	/**
	 * Adds an user.
	 * 
	 * @param user the user
	 */
	public void addUser(User user) {
		users.add(user);
	}

	/**
	 * Removes an user.
	 * 
	 * @param user the user
	 */
	public void removeUser(User user) {
		users.remove(user);
	}

	/**
	 * Gets the user with a given id.
	 * 
	 * @param id the id
	 * @return the user by id
	 */
	public User getUserById(int id) {
		for (User u : users)
			if (u.getId() == id)
				return u;
		return null;
	}

	/**
	 * Removes the user with a given id.
	 * 
	 * @param id the id
	 * @return true, if successful
	 */
	public boolean removeUserById(int id) {
		Iterator it = users.iterator();
		while (it.hasNext())
			if (it.next().getId() == id) {
				it.remove();
				return true;
			}
		return false;
	}
	
	/**
	 * Removes all the users.
	 */
	public void removeAllUsers(){
		this.users.clear();
	}
}