org.filesys.server.auth.UserAccount Maven / Gradle / Ivy
Show all versions of jfileserver Show documentation
/*
* Copyright (C) 2006-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see Holds the details of a user account on the server.
*
* @author gkspencer
*/
public class UserAccount {
// User name and plaintext password
private String m_userName;
private String m_password;
// MD4 hashed password
private byte[] m_md4Password;
// Real user name and comment
private String m_realName;
private String m_comment;
// List of shares this user is allowed to use
private StringList m_shares;
// Administrator and guest flags
private boolean m_admin;
private boolean m_guest;
// Home directory
private String m_homeDir;
// Mapped name, may be different to the user name
private String m_mappedName;
/**
* Default constructor
*/
public UserAccount() {
super();
}
/**
* Create a user with the specified name and password.
*
* @param user String
* @param pwd String
*/
public UserAccount(String user, String pwd) {
setUserName(user);
setPassword(pwd);
}
/**
* Add the specified share to the list of allowed shares for this user.
*
* @param shr String
*/
public final void addShare(String shr) {
if (m_shares == null)
m_shares = new StringList();
m_shares.addString(shr);
}
/**
* Determine if this user is allowed to access the specified share.
*
* @param shr String
* @return boolean
*/
public final boolean allowsShare(String shr) {
if (m_shares == null)
return true;
else if (m_shares.containsString(shr))
return true;
return false;
}
/**
* Check if the user has a home direectory configured
*
* @return boolean
*/
public final boolean hasHomeDirectory() {
return m_homeDir != null ? true : false;
}
/**
* Return the home directory for this user
*
* @return String
*/
public final String getHomeDirectory() {
return m_homeDir;
}
/**
* Return the password
*
* @return String
*/
public final String getPassword() {
return m_password;
}
/**
* Check if the MD4 hashed password is available
*
* @return boolean
*/
public final boolean hasMD4Password() {
return m_md4Password != null ? true : false;
}
/**
* Return the MD4 hashed password
*
* @return byte[]
*/
public final byte[] getMD4Password() {
return m_md4Password;
}
/**
* Return the user name.
*
* @return String
*/
public final String getUserName() {
return m_userName;
}
/**
* Return the real user name
*
* @return String
*/
public final String getRealName() {
return m_realName;
}
/**
* Return the user comment
*
* @return String
*/
public final String getComment() {
return m_comment;
}
/**
* Check if the user has a mapped name
*
* @return boolean
*/
public final boolean hasMappedName() {
return m_mappedName != null ? true : false;
}
/**
* Return the mapped name
*
* @return String
*/
public final String getMappedName() {
return m_mappedName;
}
/**
* Check if the specified share is listed in the users allowed list.
*
* @param shr String
* @return boolean
*/
public final boolean hasShare(String shr) {
if (m_shares != null && m_shares.containsString(shr) == false)
return false;
return true;
}
/**
* Detemrine if this account is restricted to using certain shares only.
*
* @return boolean
*/
public final boolean hasShareRestrictions() {
return m_shares == null ? false : true;
}
/**
* Return the list of shares
*
* @return StringList
*/
public final StringList getShareList() {
return m_shares;
}
/**
* Determine if this user in an administrator.
*
* @return boolean
*/
public final boolean isAdministrator() {
return m_admin;
}
/**
* Determine if the user is a guest user
*
* @return boolean
*/
public final boolean isGuest() {
return m_guest;
}
/**
* Remove all shares from the list of restricted shares.
*/
public final void removeAllShares() {
m_shares = null;
}
/**
* Remove the specified share from the list of shares this user is allowed to access.
*
* @param shr String
*/
public final void removeShare(String shr) {
// Check if the share list has been allocated
if (m_shares != null) {
// Remove the share from the list
m_shares.removeString(shr);
// Check if the list is empty
if (m_shares.numberOfStrings() == 0)
m_shares = null;
}
}
/**
* Set the administrator flag.
*
* @param admin boolean
*/
public final void setAdministrator(boolean admin) {
m_admin = admin;
}
/**
* Set the guest flag
*
* @param guest boolean
*/
public final void setGuest(boolean guest) {
m_guest = guest;
}
/**
* Set the user home directory
*
* @param home String
*/
public final void setHomeDirectory(String home) {
m_homeDir = home;
}
/**
* Set the password for this account.
*
* @param pwd String
*/
public final void setPassword(String pwd) {
m_password = pwd;
}
/**
* Set the MD4 hashed password
*
* @param md4Pwd byte[]
*/
public final void setMD4Password(byte[] md4Pwd) {
m_md4Password = md4Pwd;
}
/**
* Set the user name.
*
* @param user String
*/
public final void setUserName(String user) {
m_userName = user;
}
/**
* Set the real user name
*
* @param name String
*/
public final void setRealName(String name) {
m_realName = name;
}
/**
* Set the comment
*
* @param comment String
*/
public final void setComment(String comment) {
m_comment = comment;
}
/**
* Set the mapped name
*
* @param mappedName String
*/
public final void setMappedName( String mappedName) { m_mappedName = mappedName; }
/**
* Return the user account as a string.
*
* @return String
*/
public String toString() {
StringBuffer str = new StringBuffer();
str.append("[");
str.append(getUserName());
str.append(":");
str.append(getPassword());
if (hasMD4Password()) {
str.append(",MD4=");
str.append(HexDump.hexString(getMD4Password()));
}
if (isAdministrator())
str.append(" (ADMIN)");
if (isGuest())
str.append(" (GUEST)");
str.append(",Real=");
str.append(getRealName());
if ( hasMappedName()) {
str.append(", mapped=");
str.append( getMappedName());
}
str.append(",Comment=");
str.append(getComment());
str.append(",Allow=");
if (m_shares == null)
str.append("");
else
str.append(m_shares);
str.append("]");
str.append(",Home=");
if (hasHomeDirectory())
str.append(getHomeDirectory());
else
str.append("None");
return str.toString();
}
}