org.objectweb.jonas.security.realm.principals.User Class Reference

Inherits org.objectweb.jonas.security.realm.principals.UserMBean.

Inherited by org.objectweb.jonas.security.realm.principals.LDAPUser.

Inheritance diagram for org.objectweb.jonas.security.realm.principals.User:

[legend]Collaboration diagram for org.objectweb.jonas.security.realm.principals.User:

[legend]List of all members.

Public Member Functions
	User ()
	User (String name, String password)
void	setName (String name)
String	getName ()
String	getPassword ()
void	setPassword (String password)
HashPassword	getHashPassword ()
void	setGroups (String groups)
String	getGroups ()
String[]	getArrayGroups ()
void	setRoles (String roles)
void	addGroup (String group)
void	addRole (String role)
void	removeGroup (String group)
void	removeRole (String role)
String	getRoles ()
void	setCombinedRoles (ArrayList combinedRoles)
ArrayList	getCombinedRoles ()
String[]	getArrayRoles ()
String	toXML ()
String	toString ()
Protected Member Functions
void	setHashPassword (HashPassword hashPassword)
Static Protected Attributes
final String	SEPARATOR = ","

---

Detailed Description

This class define the User class which represent a user by its name, password, etc.

Author:

Florent Benoit (initial developer)

Alexandre Thaveau (add DN for the certificates in method setName)

Marc-Antoine Bourgeot (add DN for the certificates in method setName)

Definition at line 47 of file User.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas.security.realm.principals.User.User (   )

Constructor Definition at line 87 of file User.java.

org.objectweb.jonas.security.realm.principals.User.User (  String  name, String  password )

Constructor with a given login / password Parameters: name  the given name password  the given password Definition at line 95 of file User.java. References org.objectweb.jonas.security.realm.principals.User.setName(), and org.objectweb.jonas.security.realm.principals.User.setPassword().

Here is the call graph for this function:

---

Member Function Documentation

void org.objectweb.jonas.security.realm.principals.User.addGroup (  String  group  )

Add the specified group to this user Parameters: group  the group to add Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 215 of file User.java. Referenced by org.objectweb.jonas.security.realm.principals.User.setGroups().

void org.objectweb.jonas.security.realm.principals.User.addRole (  String  role  )

Add a role to this user Parameters: role  the given role Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 225 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceDS.findUser(), and org.objectweb.jonas.security.realm.principals.User.setRoles().

String [] org.objectweb.jonas.security.realm.principals.User.getArrayGroups (   )

Get the groups Returns: the array of the groups Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 192 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceMemory.getArrayListCombinedRoles().

String [] org.objectweb.jonas.security.realm.principals.User.getArrayRoles (   )

Get the roles Returns: the array of the roles Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 291 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceMemory.getArrayListCombinedRoles(), org.objectweb.jonas.security.realm.factory.JResourceLDAP.getArrayListCombinedRoles(), and org.objectweb.jonas.security.realm.factory.JResourceDS.getArrayListCombinedRoles().

ArrayList org.objectweb.jonas.security.realm.principals.User.getCombinedRoles (   )

Get the combined roles of this user Returns: the combined of the user Definition at line 283 of file User.java.

String org.objectweb.jonas.security.realm.principals.User.getGroups (   )

Get the groups Returns: the comma separated list of groups Definition at line 171 of file User.java.

HashPassword org.objectweb.jonas.security.realm.principals.User.getHashPassword (   )

Set the hashed password of this user Returns: hashPassword hashed password of this user Definition at line 150 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceMemory.isValidUser(), org.objectweb.jonas.security.realm.factory.JResourceDS.isValidUser(), and org.objectweb.jonas.security.realm.factory.JResourceLDAP.isValidUserCompare().

String org.objectweb.jonas.security.realm.principals.User.getName (   )

Get the name of this user Returns: the name of this user Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 117 of file User.java. Referenced by org.objectweb.jonas.security.realm.web.jetty50.Standard.authenticate(), org.objectweb.jonas.security.realm.web.catalina50.Standard.authenticate(), org.objectweb.jonas.security.realm.web.catalina50.JACC.authenticate(), and org.objectweb.jonas.security.realm.factory.JResourceMemory.removeMBeans().

String org.objectweb.jonas.security.realm.principals.User.getPassword (   )

Get the password of this user Returns: the password of this user Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 125 of file User.java. Referenced by org.objectweb.jonas.security.realm.web.catalina50.Standard.authenticate(), org.objectweb.jonas.security.realm.web.catalina50.JACC.authenticate(), org.objectweb.jonas.security.realm.factory.JResourceMemory.isValidUser(), org.objectweb.jonas.security.realm.factory.JResourceDS.isValidUser(), org.objectweb.jonas.security.realm.factory.JResourceLDAP.isValidUserCompare(), and org.objectweb.jonas.security.auth.spi.JResourceLoginModule.login().

String org.objectweb.jonas.security.realm.principals.User.getRoles (   )

Get the roles Returns: the array of the roles Definition at line 255 of file User.java.

void org.objectweb.jonas.security.realm.principals.User.removeGroup (  String  group  )

Remove a group from this user Parameters: group  the given group Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 235 of file User.java.

void org.objectweb.jonas.security.realm.principals.User.removeRole (  String  role  )

Remove a role from this user Parameters: role  the given role Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 245 of file User.java.

void org.objectweb.jonas.security.realm.principals.User.setCombinedRoles (  ArrayList  combinedRoles  )

Set the combined roles of this user Parameters: combinedRoles  combined of the user Definition at line 275 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.getArrayListCombinedRoles(), and org.objectweb.jonas.security.realm.factory.JResourceDS.getArrayListCombinedRoles().

void org.objectweb.jonas.security.realm.principals.User.setGroups (  String  groups  )

Set the groups of the user Parameters: groups  the comma separated list of the groups of the user Definition at line 158 of file User.java. References org.objectweb.jonas.security.realm.principals.User.addGroup(), and org.objectweb.jonas.security.realm.principals.User.SEPARATOR.

Here is the call graph for this function:

void org.objectweb.jonas.security.realm.principals.User.setHashPassword (  HashPassword  hashPassword  )  [protected]

Set the hashed password of this user Parameters: hashPassword  hashed password of this user Definition at line 142 of file User.java. Referenced by org.objectweb.jonas.security.realm.principals.User.setPassword().

void org.objectweb.jonas.security.realm.principals.User.setName (  String  name  )

Set the name of this user Parameters: name  Name of the user Definition at line 104 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.findUser(), org.objectweb.jonas.security.realm.factory.JResourceDS.findUser(), and org.objectweb.jonas.security.realm.principals.User.User().

void org.objectweb.jonas.security.realm.principals.User.setPassword (  String  password  )

Set the password of this user Parameters: password  password of the user Implements org.objectweb.jonas.security.realm.principals.UserMBean. Definition at line 133 of file User.java. References org.objectweb.jonas.security.realm.principals.User.setHashPassword(). Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.findUser(), org.objectweb.jonas.security.realm.factory.JResourceDS.findUser(), and org.objectweb.jonas.security.realm.principals.User.User().

Here is the call graph for this function:

void org.objectweb.jonas.security.realm.principals.User.setRoles (  String  roles  )

Set the roles of the user Parameters: roles  the comma separated list of the roles of the user Definition at line 200 of file User.java. References org.objectweb.jonas.security.realm.principals.User.addRole(), and org.objectweb.jonas.security.realm.principals.User.SEPARATOR. Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.findUser().

Here is the call graph for this function:

String org.objectweb.jonas.security.realm.principals.User.toString (   )

Use the XML representation of this object Returns: the XML representation of this object Definition at line 317 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.toXML(), and org.objectweb.jonas.security.realm.factory.JResourceDS.toXML().

String org.objectweb.jonas.security.realm.principals.User.toXML (   )

String representation of the user Returns: the xml representation of the user Definition at line 299 of file User.java. Referenced by org.objectweb.jonas.security.realm.factory.JResourceLDAP.toString(), and org.objectweb.jonas.security.realm.factory.JResourceDS.toString().

---

Member Data Documentation

final String org.objectweb.jonas.security.realm.principals.User.SEPARATOR = "," [static, protected]

Separator of the groups/roles Definition at line 52 of file User.java. Referenced by org.objectweb.jonas.security.realm.principals.User.setGroups(), and org.objectweb.jonas.security.realm.principals.User.setRoles().

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas/security/realm/principals/User.java

---