Package io.vertigo.account.authorization

Class UserAuthorizationsBasic

java.lang.Object

io.vertigo.account.authorization.UserAuthorizationsBasic

All Implemented Interfaces:

Serializable

public final class UserAuthorizationsBasic
extends Object
implements Serializable

This class list User's Authorizations.

Author:

pchretien, npiedeloup

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserAuthorizationsBasic()

Method Summary

Modifier and Type	Method	Description
UserAuthorizationsBasic	addPermission(PermissionBasic permission)	Add a authorization to this User.
UserAuthorizationsBasic	addRole(RoleBasic role)	Add a role to this User.
UserAuthorizationsBasic	clearPermissions()	Clear all authorization on this user.
UserAuthorizationsBasic	clearRoles()	Clear all roles on this user.
UserAuthorizationsBasic	clearSecurityKeys()	Clear Security Keys.
Set<PermissionBasic>	getPermissions()	Return permissions set of this user.
Set<RoleBasic>	getRoles()	Return roles set of this user.
Map<String,List<Serializable>>	getSecurityKeys()	Return the security keys of this user.
boolean	hasRole(RoleBasic role)
UserAuthorizationsBasic	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

UserAuthorizationsBasic

public UserAuthorizationsBasic()

Method Detail

addRole

public UserAuthorizationsBasic addRole(RoleBasic role)

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

Parameters:

role - Role to add

Returns:

this UserAuthorizations

getRoles

public Set<RoleBasic> getRoles()

Return roles set of this user.

Returns:

roles set

hasRole

public boolean hasRole(RoleBasic role)

Parameters:

role - Role

Returns:

if user has this role

clearRoles

public UserAuthorizationsBasic clearRoles()

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

Returns:

this UserAuthorizations

addPermission

public UserAuthorizationsBasic addPermission(PermissionBasic permission)

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

Parameters:

permission - Authorization to add

Returns:

this UserPermissionV1s

getPermissions

public Set<PermissionBasic> getPermissions()

Return permissions set of this user.

Returns:

permissions set

clearPermissions

public UserAuthorizationsBasic clearPermissions()

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 UserAuthorizationsBasic 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 UserAuthorizationsBasic clearSecurityKeys()

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

Returns:

this UserAuthorizations