org.codehaus.cargo.container.property
Class User

java.lang.Object
  org.codehaus.cargo.container.property.User

public final class User
extends Object

Represent an authenticating user for the Servlet container.

Version:

$Id: User.java 1705 2008-09-02 13:14:55Z adriana $

Constructor Summary

User()

Method Summary

void	addRole(String role)
void	addRoles(List roles)
static Map	createRoleMap(List users) Create a user map indexed on the roles.
boolean	equals(Object userObject)
String	getName()
String	getPassword()
List	getRoles()
int	hashCode()
protected static List	parseRoles(String rolesAsString) Parse roles defined as a list in the format "role1,role2,...,roleN".
protected static User	parseUser(String userAsString) Parse a user defined in the format "name:pwd:role1,...roleN".
static List	parseUsers(String usersAsString) Parse a string representing the users (see ServletPropertySet.USERS.
void	setName(String name)
void	setPassword(String password) Sets the authenticated user password.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

setName

public void setName(String name)

Parameters:

name - the user name

getName

public String getName()

Returns:

the user name

setPassword

public void setPassword(String password)

Sets the authenticated user password.

Parameters:

password - the user password

getPassword

public String getPassword()

Returns:

the user password

addRole

public void addRole(String role)

Parameters:

role - a role attached to this user

addRoles

public void addRoles(List roles)

Parameters:

roles - a list of roles attached to this user

getRoles

public List getRoles()

Returns:

the list of roles attached to this user

equals

public boolean equals(Object userObject)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

parseUsers

public static List parseUsers(String usersAsString)

Parse a string representing the users (see ServletPropertySet.USERS.

Parameters:

usersAsString - the string representing the users

Returns:

a list of User objects

parseUser

protected static User parseUser(String userAsString)

Parse a user defined in the format "name:pwd:role1,...roleN".

Parameters:

userAsString - the user defines as a string

Returns:

the parsed user

parseRoles

protected static List parseRoles(String rolesAsString)

Parse roles defined as a list in the format "role1,role2,...,roleN".

Parameters:

rolesAsString - the roles defined as a string

Returns:

the parsed list of roles

createRoleMap

public static Map createRoleMap(List users)

Create a user map indexed on the roles.

Parameters:

users - list of User for which to extract roles from

Returns:

a map of roles containing users