1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/org/sonews/acl/User.java	Sun Oct 30 22:15:03 2011 +0100
     1.3 @@ -0,0 +1,75 @@
     1.4 +/*
     1.5 + *   SONEWS News Server
     1.6 + *   see AUTHORS for the list of contributors
     1.7 + *
     1.8 + *   This program is free software: you can redistribute it and/or modify
     1.9 + *   it under the terms of the GNU General Public License as published by
    1.10 + *   the Free Software Foundation, either version 3 of the License, or
    1.11 + *   (at your option) any later version.
    1.12 + *
    1.13 + *   This program is distributed in the hope that it will be useful,
    1.14 + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.16 + *   GNU General Public License for more details.
    1.17 + *
    1.18 + *   You should have received a copy of the GNU General Public License
    1.19 + *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    1.20 + */
    1.21 +package org.sonews.acl;
    1.22 +
    1.23 +/**
    1.24 + * Represents users (clients) accessing our service through NNTP protocol.
    1.25 + * 
    1.26 + * This class can be extended by your plugin 
    1.27 + * to describe additional information, that was gained during login process.
    1.28 + * 
    1.29 + * When User object is created, default authentication status is false.
    1.30 + * 
    1.31 + * @author František Kučera (frantovo.cz)
    1.32 + */
    1.33 +public class User {
    1.34 +
    1.35 +	private String userName;
    1.36 +	private boolean authenticated = false;
    1.37 +
    1.38 +	public String getUserName() {
    1.39 +		return userName;
    1.40 +	}
    1.41 +
    1.42 +	public void setUserName(String userName) {
    1.43 +		this.userName = userName;
    1.44 +	}
    1.45 +
    1.46 +	/**
    1.47 +	 * In some configurations users don't have to use their password – 
    1.48 +	 * they can just tell us their name and we will trust them – 
    1.49 +	 * in this case User object will exist end user name will be filled, but this method will return false.
    1.50 +	 * 
    1.51 +	 * @return true if user was succesfully authenticated (has provided correct password).
    1.52 +	 */
    1.53 +	public boolean isAuthenticated() {
    1.54 +		return authenticated;
    1.55 +	}
    1.56 +
    1.57 +	/**
    1.58 +	 * This method is to be called from AUTHINFO PASS Command implementation.
    1.59 +	 * 
    1.60 +	 * @param authenticated true if user has provided right password in AUTHINFO PASS password.
    1.61 +	 * @see #isAuthenticated() 
    1.62 +	 */
    1.63 +	public void setAuthenticated(boolean authenticated) {
    1.64 +		this.authenticated = authenticated;
    1.65 +	}
    1.66 +
    1.67 +	public User() {
    1.68 +	}
    1.69 +
    1.70 +	public User(String userName) {
    1.71 +		this.userName = userName;
    1.72 +	}
    1.73 +
    1.74 +	public User(String userName, boolean authenticated) {
    1.75 +		this.userName = userName;
    1.76 +		this.authenticated = authenticated;
    1.77 +	}
    1.78 +}