MgnlUser (Magnolia Main Project (Parent) 6.2.3 API)

java.lang.Object
- info.magnolia.cms.security.AbstractUser
- - info.magnolia.cms.security.MgnlUser

All Implemented Interfaces:

User, Serializable, Principal
```
public class MgnlUser
extends AbstractUser
implements User, Serializable
```
A read-only snapshot of a Magnolia user as found in JCR at the moment of creation (e.g. upon login). Any changes to the underlying properties, roles and groups will be reflected here only upon first logging out and then logging in again. To get a "real-time" view of a user's status, use MgnlUserManager.getUser(String) or similar methods instead.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String,String> properties)` Deprecated. since 5.5.5. Please use `MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection)` instead.
`MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String,String> properties, String path, String uuid)` Deprecated. since 5.5.5. Please use `MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection)` instead.
`MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String,String> properties, String path, String uuid, Collection<String> allGroups, Collection<String> allRoles)` This constructor is mainly used by `MgnlUserManager` or by custom extensions of this object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected String`	`decodePassword(String encodedPassword)` Deprecated. Since 4.5.8. Password is now encoded by BCrypt and therefore cannot be decoded.
`Collection<String>`	`getAllGroups()` Get all groups this user belongs to, collected recursively including supergroups.
`Collection<String>`	`getAllRoles()` Get all roles assigned to this user, collected recursively including groups and supergroups.
`int`	`getFailedLoginAttempts()`
`Collection<String>`	`getGroups()` Get groups that are directly assigned to the user.
`String`	`getIdentifier()` Gets user identifier.
`String`	`getLanguage()`
`String`	`getName()`
`String`	`getPassword()`
`String`	`getPath()`
`String`	`getProperty(String propertyName)` Gets an arbitrary property from this user.
`String`	`getRealm()`
`Calendar`	`getReleaseTime()`
`Collection<String>`	`getRoles()` Get roles that are directly assigned to the user.
`String`	`getUuid()` Deprecated. since 4.5.1, use `getIdentifier()` instead
`boolean`	`hasRole(String roleName)` Is this user in a specified role?
`boolean`	`inGroup(String groupName)` Is this user in a specified group?
`boolean`	`isEnabled()` Returns false if the user was explicitly disabled.
`void`	`setLastAccess()` Deprecated. since 4.5, use `UserManager.updateLastAccessTimestamp(User)` instead
`void`	`setPath(String path)` Deprecated.
`void`	`setProperty(String propertyName, String value)` Deprecated. since 4.5, use `UserManager` instead
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface info.magnolia.cms.security.User
addGroup, addRole, removeGroup, removeRole, setEnabled

Methods inherited from interface java.security.Principal
equals, hashCode, implies

- Constructor Detail
  - MgnlUser
```
public MgnlUser(String name,
                String realm,
                Collection<String> directGroups,
                Collection<String> directRoles,
                Map<String,String> properties,
                String path,
                String uuid,
                Collection<String> allGroups,
                Collection<String> allRoles)
```
    This constructor is mainly used by MgnlUserManager or by custom extensions of this object. If you extend MgnlUser, chances are you need to provide your own MgnlUserManager as well.
    
    See Also:
    
    MgnlUserManager.getUser(String), MgnlUserManager.newUserInstance(javax.jcr.Node)
  - MgnlUser
```
@Deprecated
public MgnlUser(String name,
                            String realm,
                            Collection<String> directGroups,
                            Collection<String> directRoles,
                            Map<String,String> properties,
                            String path,
                            String uuid)
```
    Deprecated. since 5.5.5. Please use MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection) instead.
  - MgnlUser
```
@Deprecated
public MgnlUser(String name,
                            String realm,
                            Collection<String> directGroups,
                            Collection<String> directRoles,
                            Map<String,String> properties)
```
    Deprecated. since 5.5.5. Please use MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection) instead.
- Method Detail
  - inGroup
```
public boolean inGroup(String groupName)
```
    Description copied from interface: User
    
    Is this user in a specified group?
    
    Specified by:
    
    inGroup in interface User
    
    Returns:
    
    true if in group
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: User
    
    Returns false if the user was explicitly disabled. Implementations should return true by default if the status is unknown.
    
    Specified by:
    
    isEnabled in interface User
  - hasRole
```
public boolean hasRole(String roleName)
```
    Description copied from interface: User
    
    Is this user in a specified role?
    
    Specified by:
    
    hasRole in interface User
    
    Parameters:
    
    roleName - the name of the role
    
    Returns:
    
    true if in role
  - getFailedLoginAttempts
```
public int getFailedLoginAttempts()
```
  - getReleaseTime
```
public Calendar getReleaseTime()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface User
    
    Specified by:
    
    getName in interface Principal
  - getPassword
```
public String getPassword()
```
    Specified by:
    
    getPassword in interface User
  - decodePassword
```
@Deprecated
protected String decodePassword(String encodedPassword)
```
    Deprecated. Since 4.5.8. Password is now encoded by BCrypt and therefore cannot be decoded.
  - getLanguage
```
public String getLanguage()
```
    Specified by:
    
    getLanguage in interface User
  - getProperty
```
public String getProperty(String propertyName)
```
    Description copied from interface: User
    
    Gets an arbitrary property from this user.
    
    Specified by:
    
    getProperty in interface User
  - getGroups
```
public Collection<String> getGroups()
```
    Description copied from interface: User
    
    Get groups that are directly assigned to the user.
    
    Specified by:
    
    getGroups in interface User
  - getAllGroups
```
public Collection<String> getAllGroups()
```
    Description copied from interface: User
    
    Get all groups this user belongs to, collected recursively including supergroups.
    
    Specified by:
    
    getAllGroups in interface User
  - getRoles
```
public Collection<String> getRoles()
```
    Description copied from interface: User
    
    Get roles that are directly assigned to the user.
    
    Specified by:
    
    getRoles in interface User
  - getAllRoles
```
public Collection<String> getAllRoles()
```
    Description copied from interface: User
    
    Get all roles assigned to this user, collected recursively including groups and supergroups.
    
    Specified by:
    
    getAllRoles in interface User
  - getPath
```
public String getPath()
```
  - setPath
```
@Deprecated
public void setPath(String path)
```
    Deprecated.
  - getRealm
```
public String getRealm()
```
  - setLastAccess
```
@Deprecated
public void setLastAccess()
```
    Deprecated. since 4.5, use UserManager.updateLastAccessTimestamp(User) instead
    
    Update the "last access" timestamp.
  - setProperty
```
@Deprecated
public void setProperty(String propertyName,
                                    String value)
```
    Deprecated. since 4.5, use UserManager instead
    
    Description copied from interface: User
    
    Sets an arbitrary property for this user. Values are currently Strings; we'd need some kind of abstract encoding mechanism to allow other types if needed.
    
    Specified by:
    
    setProperty in interface User
  - getIdentifier
```
public String getIdentifier()
```
    Description copied from interface: User
    
    Gets user identifier.
    
    Specified by:
    
    getIdentifier in interface User
  - getUuid
```
@Deprecated
public String getUuid()
```
    Deprecated. since 4.5.1, use getIdentifier() instead
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Principal
    
    Overrides:
    
    toString in class Object

Class MgnlUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface info.magnolia.cms.security.User

Methods inherited from interface java.security.Principal

Constructor Detail

MgnlUser

MgnlUser

MgnlUser

Method Detail

inGroup

isEnabled

hasRole

getFailedLoginAttempts

getReleaseTime

getName

getPassword

decodePassword

getLanguage

getProperty

getGroups

getAllGroups

getRoles

getAllRoles

getPath

setPath

getRealm

setLastAccess

setProperty

getIdentifier

getUuid

toString