info.magnolia.cms.security

Interface User

All Superinterfaces:

Principal, Serializable

All Known Implementing Classes:

AbstractUser, DummyUser, ExternalUser, MgnlUser, RescueSecuritySupport.RescueUser

public interface User
extends Principal, Serializable

Represents a magnolia user.

Method Summary

Modifier and Type	Method and Description
default void	addGroup(String groupName) Deprecated. since 4.5 - use UserManager.addGroup(User, String) instead.
default void	addRole(String roleName) Deprecated. since 4.5 - use UserManager.addRole(User, String) instead.
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.
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.
default void	removeGroup(String groupName) Deprecated. since 4.5 - use UserManager.removeGroup(User, String) instead.
default void	removeRole(String roleName) Deprecated. since 4.5 - use UserManager.removeRole(User, String) instead.
default void	setEnabled(boolean enabled) Deprecated. since 4.5, use UserManager.setProperty(User, String, Value) instead
void	setProperty(String propertyName, String value) Deprecated. since 4.5, use UserManager.setProperty(User, String, Value) instead

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Method Detail

hasRole

boolean hasRole(String roleName)

Is this user in a specified role?

Parameters:

roleName - the name of the role

Returns:

true if in role

removeRole

@Deprecated
default void removeRole(String roleName)
                             throws UnsupportedOperationException

Deprecated. since 4.5 - use UserManager.removeRole(User, String) instead.

Remove a role. Implementation is optional

Throws:

UnsupportedOperationException

addRole

@Deprecated
default void addRole(String roleName)
                          throws UnsupportedOperationException

Deprecated. since 4.5 - use UserManager.addRole(User, String) instead.

Adds a role to this user. Implementation is optional

Parameters:

roleName - the name of the role

Throws:

UnsupportedOperationException

inGroup

boolean inGroup(String groupName)

Is this user in a specified group?

Returns:

true if in group

removeGroup

@Deprecated
default void removeGroup(String groupName)
                              throws UnsupportedOperationException

Deprecated. since 4.5 - use UserManager.removeGroup(User, String) instead.

Remove a group. Implementation is optional

Throws:

UnsupportedOperationException

addGroup

@Deprecated
default void addGroup(String groupName)
                           throws UnsupportedOperationException

Deprecated. since 4.5 - use UserManager.addGroup(User, String) instead.

Adds this user to a group. Implementation is optional

Throws:

UnsupportedOperationException

isEnabled

boolean isEnabled()

Returns false if the user was explicitly disabled. Implementations should return true by default if the status is unknown.

setEnabled

@Deprecated
default void setEnabled(boolean enabled)

Deprecated. since 4.5, use UserManager.setProperty(User, String, Value) instead

getLanguage

String getLanguage()

getName

String getName()

Specified by:

getName in interface Principal

getPassword

String getPassword()

getProperty

String getProperty(String propertyName)

Gets an arbitrary property from this user.

setProperty

@Deprecated
void setProperty(String propertyName,
                             String value)

Deprecated. since 4.5, use UserManager.setProperty(User, String, Value) instead

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.

getIdentifier

String getIdentifier()

Gets user identifier.

getGroups

Collection<String> getGroups()

Get groups that are directly assigned to the user.

getAllGroups

Collection<String> getAllGroups()

Get all groups this user belongs to, collected recursively including supergroups.

getRoles

Collection<String> getRoles()

Get roles that are directly assigned to the user.

getAllRoles

Collection<String> getAllRoles()

Get all roles assigned to this user, collected recursively including groups and supergroups.