org.alfresco.jlan.server.auth

Class UserAccount

java.lang.Object

org.alfresco.jlan.server.auth.UserAccount

public class UserAccount
extends java.lang.Object

User Account Class

Holds the details of a user account on the server.

Constructor Summary

Constructors

Constructor and Description
UserAccount() Default constructor
UserAccount(java.lang.String user, java.lang.String pwd) Create a user with the specified name and password.

Method Summary

Methods

Modifier and Type	Method and Description
void	addShare(java.lang.String shr) Add the specified share to the list of allowed shares for this user.
boolean	allowsShare(java.lang.String shr) Determine if this user is allowed to access the specified share.
java.lang.String	getComment() Return the user comment
java.lang.String	getHomeDirectory() Return the home directory for this user
byte[]	getMD4Password() Return the MD4 hashed password
java.lang.String	getPassword() Return the password
java.lang.String	getRealName() Return the real user name
StringList	getShareList() Return the list of shares
java.lang.String	getUserName() Return the user name.
boolean	hasHomeDirectory() Check if the user has a home direectory configured
boolean	hasMD4Password() Check if the MD4 hashed password is available
boolean	hasShare(java.lang.String shr) Check if the specified share is listed in the users allowed list.
boolean	hasShareRestrictions() Detemrine if this account is restricted to using certain shares only.
boolean	isAdministrator() Determine if this user in an administrator.
boolean	isGuest() Determine if the user is a guest user
void	removeAllShares() Remove all shares from the list of restricted shares.
void	removeShare(java.lang.String shr) Remove the specified share from the list of shares this user is allowed to access.
void	setAdministrator(boolean admin) Set the administrator flag.
void	setComment(java.lang.String comment) Set the comment
void	setGuest(boolean guest) Set the guest flag
void	setHomeDirectory(java.lang.String home) Set the user home directory
void	setMD4Password(byte[] md4Pwd) Set the MD4 hashed password
void	setPassword(java.lang.String pwd) Set the password for this account.
void	setRealName(java.lang.String name) Set the real user name
void	setUserName(java.lang.String user) Set the user name.
java.lang.String	toString() Return the user account as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserAccount

public UserAccount()

Default constructor

UserAccount

public UserAccount(java.lang.String user,
           java.lang.String pwd)

Create a user with the specified name and password.

Parameters:

user - String

pwd - String

Method Detail

addShare

public final void addShare(java.lang.String shr)

Add the specified share to the list of allowed shares for this user.

Parameters:

shr - java.lang.String

allowsShare

public final boolean allowsShare(java.lang.String shr)

Determine if this user is allowed to access the specified share.

Parameters:

shr - java.lang.String

Returns:

boolean

hasHomeDirectory

public final boolean hasHomeDirectory()

Check if the user has a home direectory configured

Returns:

boolean

getHomeDirectory

public final java.lang.String getHomeDirectory()

Return the home directory for this user

Returns:

String

getPassword

public final java.lang.String getPassword()

Return the password

Returns:

java.lang.String

hasMD4Password

public final boolean hasMD4Password()

Check if the MD4 hashed password is available

Returns:

boolean

getMD4Password

public final byte[] getMD4Password()

Return the MD4 hashed password

Returns:

byte[]

getUserName

public final java.lang.String getUserName()

Return the user name.

Returns:

java.lang.String

getRealName

public final java.lang.String getRealName()

Return the real user name

Returns:

String

getComment

public final java.lang.String getComment()

Return the user comment

Returns:

String

hasShare

public final boolean hasShare(java.lang.String shr)

Check if the specified share is listed in the users allowed list.

Parameters:

shr - java.lang.String

Returns:

boolean

hasShareRestrictions

public final boolean hasShareRestrictions()

Detemrine if this account is restricted to using certain shares only.

Returns:

boolean

getShareList

public final StringList getShareList()

Return the list of shares

Returns:

StringList

isAdministrator

public final boolean isAdministrator()

Determine if this user in an administrator.

Returns:

boolean

isGuest

public final boolean isGuest()

Determine if the user is a guest user

Returns:

boolean

removeAllShares

public final void removeAllShares()

Remove all shares from the list of restricted shares.

removeShare

public final void removeShare(java.lang.String shr)

Remove the specified share from the list of shares this user is allowed to access.

Parameters:

shr - java.lang.String

setAdministrator

public final void setAdministrator(boolean admin)

Set the administrator flag.

Parameters:

admin - boolean

setGuest

public final void setGuest(boolean guest)

Set the guest flag

Parameters:

guest - boolean

setHomeDirectory

public final void setHomeDirectory(java.lang.String home)

Set the user home directory

Parameters:

home - String

setPassword

public final void setPassword(java.lang.String pwd)

Set the password for this account.

Parameters:

pwd - java.lang.String

setMD4Password

public final void setMD4Password(byte[] md4Pwd)

Set the MD4 hashed password

Parameters:

md4Pwd - byte[]

setUserName

public final void setUserName(java.lang.String user)

Set the user name.

Parameters:

user - java.lang.String

setRealName

public final void setRealName(java.lang.String name)

Set the real user name

Parameters:

name - String

setComment

public final void setComment(java.lang.String comment)

Set the comment

Parameters:

comment - String

toString

public java.lang.String toString()

Return the user account as a string.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String