com.neurosys.security.auth.domain

Interface User

All Superinterfaces:

Principal, Serializable

All Known Subinterfaces:

IGenericEcomUser, SAASUser<T>, SuperUser

All Known Implementing Classes:

AdminUser, AdminUser, BasicUser, GenericEcomUser, GuestUser, RegisteredUser

public interface User
extends Principal, Serializable

Generic representation of a User

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	User.BIT_MASKS

Method Summary

Modifier and Type	Method and Description
<U extends User> U	copyAs(Class<U> userType) Provide an equivalent copy of this user as userType For different types of users we may need to get a copy for that User Type.
Map<String,Collection<Authorization>>	getAuthorizationMap() Map of entity Name to Set of Authorization. The entity name can refer to any section that has a name, that uniquely identifies the entity.
int	getBitmask()
default Supplier	getEnvironmentSupplier() When user loads this context and supplies it to the Session. Example: What is the default page for the Role etc.
String	getId()
Collection<String>	getRoleNames()
User	setAuthorizationMap(Map<String,Collection<Authorization>> auths) Map of entity Name to Set of Authorization. The entity name can refer to any section that has a name, that uniquely identifies the entity.
User	setBitmask(int bitmask)
void	setId(String id)
void	setRoleNames(Collection<String> roleNames)

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Method Detail

getId

String getId()

setId

void setId(String id)

getAuthorizationMap

Map<String,Collection<Authorization>> getAuthorizationMap()

Map of entity Name to Set of Authorization.
The entity name can refer to any section that has a name, that uniquely identifies the entity.

Returns:

Map

getRoleNames

Collection<String> getRoleNames()

Returns:

Collection of Role.getName()

setRoleNames

void setRoleNames(Collection<String> roleNames)

setAuthorizationMap

User setAuthorizationMap(Map<String,Collection<Authorization>> auths)

Map of entity Name to Set of Authorization.
The entity name can refer to any section that has a name, that uniquely identifies the entity.

Returns:

Map

getBitmask

int getBitmask()

setBitmask

User setBitmask(int bitmask)

copyAs

<U extends User> U copyAs(Class<U> userType)

Provide an equivalent copy of this user as userType

For different types of users we may need to get a copy for that User Type. If a particular type is not supported then throw a RuntimeException.

User objects are tricky since they may need to exist in various forms. This method allows a polymorphic nature of the User without having to implement or extends strict hierarchies.

Parameters:

userClass - as Class

Returns:

getEnvironmentSupplier

default Supplier getEnvironmentSupplier()

When user loads this context and supplies it to the Session.
Example: What is the default page for the Role etc.

Can be null:

true