Package org.apache.catalina.users
Class MemoryUser
- java.lang.Object
-
- org.apache.catalina.users.AbstractUser
-
- org.apache.catalina.users.MemoryUser
-
- All Implemented Interfaces:
java.security.Principal
,User
@Deprecated public class MemoryUser extends AbstractUser
Deprecated.UseAbstractUser
instead.Concrete implementation of
User
for theMemoryUserDatabase
implementation ofUserDatabase
.- Since:
- 4.1
- Author:
- Craig R. McClanahan
-
-
Field Summary
Fields Modifier and Type Field Description protected MemoryUserDatabase
database
Deprecated.TheMemoryUserDatabase
that owns this user.protected java.util.concurrent.CopyOnWriteArrayList<Group>
groups
Deprecated.The set ofGroup
s that this user is a member of.protected java.util.concurrent.CopyOnWriteArrayList<Role>
roles
Deprecated.The set ofRole
s associated with this user.-
Fields inherited from class org.apache.catalina.users.AbstractUser
fullName, password, username
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addGroup(Group group)
Deprecated.Add a newGroup
to those this user belongs to.void
addRole(Role role)
Deprecated.Add a newRole
to those assigned specifically to this user.java.util.Iterator<Group>
getGroups()
Deprecated.Return the set ofGroup
s to which this user belongs.java.util.Iterator<Role>
getRoles()
Deprecated.Return the set ofRole
s assigned specifically to this user.UserDatabase
getUserDatabase()
Deprecated.Return theUserDatabase
within which this User is defined.boolean
isInGroup(Group group)
Deprecated.Is this user in the specified group?boolean
isInRole(Role role)
Deprecated.Is this user specifically assigned the specifiedRole
?void
removeGroup(Group group)
Deprecated.Remove aGroup
from those this user belongs to.void
removeGroups()
Deprecated.Remove allGroup
s from those this user belongs to.void
removeRole(Role role)
Deprecated.Remove aRole
from those assigned to this user.void
removeRoles()
Deprecated.Remove allRole
s from those assigned to this user.java.lang.String
toString()
Deprecated.Return a String representation of this user.java.lang.String
toXml()
Deprecated.Return a String representation of this user in XML format.-
Methods inherited from class org.apache.catalina.users.AbstractUser
getFullName, getName, getPassword, getUsername, setFullName, setPassword, setUsername
-
-
-
-
Field Detail
-
database
protected final MemoryUserDatabase database
Deprecated.TheMemoryUserDatabase
that owns this user.
-
groups
protected final java.util.concurrent.CopyOnWriteArrayList<Group> groups
Deprecated.The set ofGroup
s that this user is a member of.
-
-
Method Detail
-
getGroups
public java.util.Iterator<Group> getGroups()
Deprecated.Return the set ofGroup
s to which this user belongs.- Specified by:
getGroups
in interfaceUser
- Specified by:
getGroups
in classAbstractUser
- Returns:
- the set of
Group
s to which this user belongs.
-
getRoles
public java.util.Iterator<Role> getRoles()
Deprecated.Return the set ofRole
s assigned specifically to this user.- Specified by:
getRoles
in interfaceUser
- Specified by:
getRoles
in classAbstractUser
- Returns:
- the set of
Role
s assigned specifically to this user.
-
getUserDatabase
public UserDatabase getUserDatabase()
Deprecated.Return theUserDatabase
within which this User is defined.- Returns:
- the
UserDatabase
within which this User is defined.
-
addGroup
public void addGroup(Group group)
Deprecated.Add a newGroup
to those this user belongs to.- Specified by:
addGroup
in interfaceUser
- Specified by:
addGroup
in classAbstractUser
- Parameters:
group
- The new group
-
addRole
public void addRole(Role role)
Deprecated.Add a newRole
to those assigned specifically to this user.- Specified by:
addRole
in interfaceUser
- Specified by:
addRole
in classAbstractUser
- Parameters:
role
- The new role
-
isInGroup
public boolean isInGroup(Group group)
Deprecated.Is this user in the specified group?- Specified by:
isInGroup
in interfaceUser
- Specified by:
isInGroup
in classAbstractUser
- Parameters:
group
- The group to check- Returns:
true
if the user is in the specified group
-
isInRole
public boolean isInRole(Role role)
Deprecated.Is this user specifically assigned the specifiedRole
? This method does NOT check for roles inherited based onGroup
membership.- Specified by:
isInRole
in interfaceUser
- Specified by:
isInRole
in classAbstractUser
- Parameters:
role
- The role to check- Returns:
true
if the user has the specified role
-
removeGroup
public void removeGroup(Group group)
Deprecated.Remove aGroup
from those this user belongs to.- Specified by:
removeGroup
in interfaceUser
- Specified by:
removeGroup
in classAbstractUser
- Parameters:
group
- The old group
-
removeGroups
public void removeGroups()
Deprecated.Remove allGroup
s from those this user belongs to.- Specified by:
removeGroups
in interfaceUser
- Specified by:
removeGroups
in classAbstractUser
-
removeRole
public void removeRole(Role role)
Deprecated.Remove aRole
from those assigned to this user.- Specified by:
removeRole
in interfaceUser
- Specified by:
removeRole
in classAbstractUser
- Parameters:
role
- The old role
-
removeRoles
public void removeRoles()
Deprecated.Remove allRole
s from those assigned to this user.- Specified by:
removeRoles
in interfaceUser
- Specified by:
removeRoles
in classAbstractUser
-
toXml
public java.lang.String toXml()
Deprecated.Return a String representation of this user in XML format.
IMPLEMENTATION NOTE - For backwards compatibility, the reader that processes this entry will accept either
username
orname
for the username property.- Returns:
- the XML representation
-
toString
public java.lang.String toString()
Deprecated.Return a String representation of this user.
- Specified by:
toString
in interfacejava.security.Principal
- Overrides:
toString
in classjava.lang.Object
-
-