info.magnolia.cms.security
Class ExternalUser

java.lang.Object
  extended by info.magnolia.cms.security.AbstractUser
      extended by info.magnolia.cms.security.ExternalUser
All Implemented Interfaces:
User, Serializable, Principal

public class ExternalUser
extends AbstractUser
implements Serializable

A user which is not stored in Magnolia. For instance a user stored in LDAP or AD.

Version:
$Revision:2558 $ ($Author:scharles $)
See Also:
Serialized Form

Constructor Summary
protected ExternalUser(Map<String,String> properties, GroupList groupList, RoleList roleList)
           
protected ExternalUser(Subject subject)
          Deprecated. since 4.5 use ExternalUser(java.util.Map, info.magnolia.cms.security.auth.GroupList, info.magnolia.cms.security.auth.RoleList) instead
 
Method Summary
 void addGroup(String groupName)
          Adds this user to a group.
 void addRole(String roleName)
          Adds a role to this user.
 Collection<String> getAllGroups()
          Get all groups to which this user belongs to, collected recursively including.
 Collection<String> getAllRoles()
          Get all roles assigned to this user, collected recursively including groups/subgroups.
 String getEmail()
           
 Collection<String> getGroups()
          Get groups that are directly assigned to the user.
 String getIdentifier()
          Gets user identifier.
 String getLanguage()
           
 String getName()
           
 String getPassword()
           
 String getProperty(String propertyName)
          Gets an arbitrary property from this user.
 Collection<String> getRoles()
          Get roles that are directly assigned to the user.
 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 removeGroup(String groupName)
          Remove a group.
 void removeRole(String roleName)
          Remove a role.
 void setEnabled(boolean enabled)
           
 void setProperty(String propertyName, String value)
          Sets an arbitrary property for this user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.security.Principal
equals, hashCode, toString
 

Constructor Detail

ExternalUser

@Deprecated
protected ExternalUser(Subject subject)
Deprecated. since 4.5 use ExternalUser(java.util.Map, info.magnolia.cms.security.auth.GroupList, info.magnolia.cms.security.auth.RoleList) instead

Parameters:
subject - as created by login module

ExternalUser

protected ExternalUser(Map<String,String> properties,
                       GroupList groupList,
                       RoleList roleList)
Method Detail

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

removeRole

public void removeRole(String roleName)
Description copied from interface: User
Remove a role. Implementation is optional

Specified by:
removeRole in interface User

addRole

public void addRole(String roleName)
Description copied from interface: User
Adds a role to this user. Implementation is optional

Specified by:
addRole in interface User
Parameters:
roleName - the name of the role

inGroup

public boolean inGroup(String groupName)
Is this user in a specified group?

Specified by:
inGroup in interface User
Returns:
true if in group

removeGroup

public void removeGroup(String groupName)
                 throws UnsupportedOperationException
Remove a group. Implementation is optional

Specified by:
removeGroup in interface User
Throws:
UnsupportedOperationException

addGroup

public void addGroup(String groupName)
              throws UnsupportedOperationException
Adds this user to a group. Implementation is optional

Specified by:
addGroup in interface User
Throws:
UnsupportedOperationException

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

setEnabled

public void setEnabled(boolean enabled)
Specified by:
setEnabled in interface User

getLanguage

public String getLanguage()
Specified by:
getLanguage in interface User

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

getEmail

public String getEmail()

getProperty

public String getProperty(String propertyName)
Description copied from interface: User
Gets an arbitrary property from this user.

Specified by:
getProperty in interface User

setProperty

public void setProperty(String propertyName,
                        String value)
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

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 to which this user belongs to, collected recursively including.

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/subgroups.

Specified by:
getAllRoles in interface User


Copyright © 2003-2013 Magnolia International Ltd.. All Rights Reserved.