RoleRegistry

All Known Subinterfaces:

AuthorizationManager, AuthorizationRegistry, RoleManager, XdevInMemorySecurityManager, XdevSecurityManager<C,R>

All Known Implementing Classes:

AuthorizationManager.Implementation, AuthorizationRegistry.Implementation, RoleManager.Implementation, RoleRegistry.Implementation, XdevInMemorySecurityManager.Implementation, XdevSecurityManager.Implementation
```
public interface RoleRegistry
```
A registry type that provides a means for centralized lookup and iteration of known Role instances. Note that a registry conceptually only provides reading access, not modifying access to its contents. For modifying operations, see RoleManager.

Author:

XDEV Software (TM)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RoleRegistry.Implementation` A simple `RoleRegistry` default implementation that synchronizes on a provided lock instance for accessing the internal registry in order to avoid concurrency issues while the internal datastructure is rebuilt.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Object`	`lockRoleRegistry()` Returns the lock instance that is internally used by this registry instance.
`static RoleRegistry`	`New(Collection<? extends Role> roles)` Creates a new `RoleRegistry` instance using the passed `Role` instance to derive its internal datastructure from and a newly instantiated object to be used as the synchronization lock.
`static RoleRegistry`	`New(Collection<? extends Role> roles, Object registryLock)` Creates a new `RoleRegistry` instance using the passed `Role` instances to derive its internal datastructure from and the passed registryLock instance as the synchronization lock for accessing the registry.
`static RoleRegistry`	`New(Map<String,Role> registry)` Creates a new `RoleRegistry` instance using the passed map instance and a newly instantiated object to be used a synchronization lock.
`static RoleRegistry`	`New(Map<String,Role> registry, Object registryLock)` Creates a new `RoleRegistry` instance using the passed map instance as its internal datastructure and the passed registryLock instance as the synchronization lock for accessing the registry.
`Role`	`role(String roleName)` Returns the `Role` instance identified by the passed role name.
`Map<String,Role>`	`roles()` Returns a read-only map of all known `Role` instances (values), identified by their names (keys).

- Method Detail
  - role
```
Role role(String roleName)
```
    Returns the Role instance identified by the passed role name.
    
    Parameters:
    
    roleName - the name identifying the desired Role instance.
    
    Returns:
    
    the Role instance identified by the passed name.
  - roles
```
Map<String,Role> roles()
```
    Returns a read-only map of all known Role instances (values), identified by their names (keys).
    
    Returns:
    
    a read-only map containing all known roles.
  - lockRoleRegistry
```
Object lockRoleRegistry()
```
    Returns the lock instance that is internally used by this registry instance.
    
    Returns:
    
    the lock.
  - New
```
static RoleRegistry New(Map<String,Role> registry,
                        Object registryLock)
```
    Creates a new RoleRegistry instance using the passed map instance as its internal datastructure and the passed registryLock instance as the synchronization lock for accessing the registry.
    
    Parameters:
    
    registry - the map instance to be used as the internal datastructure.
    
    registryLock - the locking instance to be used to synchronize on for accessing the registry.
    
    Returns:
    
    a new RoleRegistry instance using the passed instances.
  - New
```
static RoleRegistry New(Map<String,Role> registry)
```
    Creates a new RoleRegistry instance using the passed map instance and a newly instantiated object to be used a synchronization lock.
    
    Parameters:
    
    registry - the map instance to be used as the internal datastructure.
    
    Returns:
    
    a new RoleRegistry instance using the passed instance.
  - New
```
static RoleRegistry New(Collection<? extends Role> roles,
                        Object registryLock)
```
    Creates a new RoleRegistry instance using the passed Role instances to derive its internal datastructure from and the passed registryLock instance as the synchronization lock for accessing the registry.
    
    Parameters:
    
    subjects - the Role instances to derive the internal datastructure from.
    
    registryLock - the locking instance to be used to synchronize on for accessing the registry.
    
    Returns:
    
    a new RoleRegistry instance using the passed instances.
  - New
```
static RoleRegistry New(Collection<? extends Role> roles)
```
    Creates a new RoleRegistry instance using the passed Role instance to derive its internal datastructure from and a newly instantiated object to be used as the synchronization lock.
    
    Parameters:
    
    subjects - the Role instance to be used as the internal datastructure.
    
    Returns:
    
    a new RoleRegistry instance using the passed instance.

Interface RoleRegistry

Nested Class Summary

Method Summary

Method Detail

role

roles

lockRoleRegistry

New

New

New

New