com.xdev.security.authorization

Class Subject.Implementation

java.lang.Object

com.xdev.security.authorization.Subject.Implementation

All Implemented Interfaces:

Subject, Subject.Mutable

Enclosing interface:

Subject

public static class Subject.Implementation
extends Object
implements Subject.Mutable

Simple default implementation for a Subject.Mutable Subject. Initializing / updating the explicit roles returned by roles() is thread-safe.

Author:

XDEV Software (TM)

Nested Class Summary

Nested classes/interfaces inherited from interface com.xdev.security.authorization.Subject

Subject.Implementation, Subject.Mutable

Constructor Summary

Constructors

Constructor and Description
Implementation(String name) Implementation detail constructor that might change in the future.
Implementation(String name, Set<Role> roles) Implementation detail constructor that might change in the future.

Method Summary

Modifier and Type	Method and Description
void	clearCachedEffectivePermissions() Implementation-specific method to clear the cached effective roles.
Map<Resource,Permission>	effectivePermissions() Returns a collection containing all effective permissions, meaning the combined permissions of all effective roles as returned by Subject.effectiveRoles().
void	initializeEffectivePermissions()
String	name()
void	reinitializeEffectivePermissions()
Set<Role>	roles()
void	setRoles(Collection<? extends Role> roles) Updates the explicit roles of this subject instance, i.e.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xdev.security.authorization.Subject

effectiveRoles, hasPermission, update

Constructor Detail

Implementation

public Implementation(String name,
                      Set<Role> roles)

Implementation detail constructor that might change in the future.

Implementation

public Implementation(String name)

Implementation detail constructor that might change in the future.

Method Detail

initializeEffectivePermissions

public final void initializeEffectivePermissions()

reinitializeEffectivePermissions

public final void reinitializeEffectivePermissions()

clearCachedEffectivePermissions

public final void clearCachedEffectivePermissions()

Implementation-specific method to clear the cached effective roles. This should never be needed for a basically immutable implementation, but in order to give at least some possibibilty to retrigger the caching, here's the way.

name

public final String name()

Specified by:

name in interface Subject

Returns:

the subject's unchangable name that identifies a particular instance.

roles

public final Set<Role> roles()

Specified by:

roles in interface Subject

Returns:

this subject's explicitely defined roles.

effectivePermissions

public final Map<Resource,Permission> effectivePermissions()

Returns a collection containing all effective permissions, meaning the combined permissions of all effective roles as returned by Subject.effectiveRoles(). If multiple permissions apply to the same Resource, the permission with the highest significance (highest absolut value of its weight) supersedes the others.

Specified by:

effectivePermissions in interface Subject

Returns:

a map containing all effective permissions and their applying resources.

setRoles

public void setRoles(Collection<? extends Role> roles)

Updates the explicit roles of this subject instance, i.e. the roles returned by Subject.roles().

Specified by:

setRoles in interface Subject.Mutable

Parameters:

roles - the new Role instances to be used.

toString

public String toString()

Overrides:

toString in class Object