Package io.vertigo.account.authorization

Class UserAuthorizations

java.lang.Object

io.vertigo.account.authorization.UserAuthorizations

All Implemented Interfaces:

Serializable

public final class UserAuthorizations
extends Object
implements Serializable

This class list User's Authorizations.

Author:

pchretien, npiedeloup

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserAuthorizations()

Method Summary

Modifier and Type	Method	Description
UserAuthorizations	addAuthorization(Authorization authorization)	Add a authorization to this User.
UserAuthorizations	addRole(Role role)	Add a role to this User.
UserAuthorizations	clearAuthorizations()	Clear all authorization on this user.
UserAuthorizations	clearRoles()	Clear all roles on this user.
UserAuthorizations	clearSecurityKeys()	Clear Security Keys.
Set<Authorization>	getEntityAuthorizations(io.vertigo.datamodel.structure.definitions.DtDefinition entityDefinition)	Return authorizations set for this type of entity.
Set<String>	getPriorAuthorizationNames()	Return uncontextual authorizations set of this user.
Set<Role>	getRoles()	Return roles set of this user.
Map<String,List<Serializable>>	getSecurityKeys()	Return the security keys of this user.
boolean	hasAuthorization(AuthorizationName... authorizationNames)
boolean	hasRole(Role role)
UserAuthorizations	withSecurityKeys(String securityKey, Serializable value)	Add a security key part of his security perimeter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserAuthorizations

public UserAuthorizations()

Method Detail

addRole

public UserAuthorizations addRole(Role role)

Add a role to this User. Role must be previously declared.

Parameters:

role - Role to add

Returns:

this UserAuthorizations

getRoles

public Set<Role> getRoles()

Return roles set of this user.

Returns:

roles set

hasRole

public boolean hasRole(Role role)

Parameters:

role - Role

Returns:

if user has this role

clearRoles

public UserAuthorizations clearRoles()

Clear all roles on this user. (authorizations are cleared too) Warning : no more rights after that.

Returns:

this UserAuthorizations

addAuthorization

public UserAuthorizations addAuthorization(Authorization authorization)

Add a authorization to this User. Authorization must be previously declared.

Parameters:

authorization - Authorization to add

Returns:

this UserAuthorizations

getPriorAuthorizationNames

public Set<String> getPriorAuthorizationNames()

Return uncontextual authorizations set of this user. It may be limited by entity right. It's usefull for UI rendering rights based.

Returns:

authorizations set

getEntityAuthorizations

public Set<Authorization> getEntityAuthorizations(io.vertigo.datamodel.structure.definitions.DtDefinition entityDefinition)

Return authorizations set for this type of entity.

Parameters:

entityDefinition - Entity definition

Returns:

Authorizations set

hasAuthorization

public boolean hasAuthorization(AuthorizationName... authorizationNames)

Parameters:

authorizationNamse - Authorization

Returns:

true if user has this authorization

clearAuthorizations

public UserAuthorizations clearAuthorizations()

Clear all authorization on this user. (but only authorization : roles aren't cleared) Warning : no more rights after that.

Returns:

this UserAuthorizations

getSecurityKeys

public Map<String,List<Serializable>> getSecurityKeys()

Return the security keys of this user. Used for data dependent security rules.

Returns:

User's security keys.

withSecurityKeys

public UserAuthorizations withSecurityKeys(String securityKey,
                                           Serializable value)

Add a security key part of his security perimeter. A security key can be multi-valued (then withSecurityKeys is call multiple times). Value should be an array if this securityKey is a tree (hierarchical) key.

Parameters:

securityKey - Name

value - Value

Returns:

this UserAuthorizations

clearSecurityKeys

public UserAuthorizations clearSecurityKeys()

Clear Security Keys. Use when user change it security perimeter.

Returns:

this UserAuthorizations