RoleServiceImpl (Hawkular - Accounts

java.lang.Object
- org.hawkular.accounts.api.internal.impl.BaseServiceImpl<Role>
- - org.hawkular.accounts.api.internal.impl.RoleServiceImpl

All Implemented Interfaces:: RoleService

@PermitAll
public class RoleServiceImpl
extends BaseServiceImpl<Role>
implements RoleService

Author:: Juraci Paixão Kröhling

Constructor Summary

Constructors
Constructor and Description

RoleServiceImpl()

Constructors
Constructor and Description
`RoleServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Role`	`create(String name, String description)` Creates a new Role based on the given name and description.
`Role`	`getById(UUID id)` Retrieves the persistent Role based on its ID.
`Role`	`getByName(String name)` Retrieves the persistent Role based on its fixed name.
`Set<Role>`	`getImplicitPermittedRoles(Role role)` Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the perspective of an operation.
`Set<Role>`	`getImplicitPermittedRoles(String name)` Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the perspective of an operation.
`Set<Role>`	`getImplicitUserRoles(Role role)` Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the User's perspective (ie: user has the given role).
`Set<Role>`	`getImplicitUserRoles(String name)` Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the User's perspective (ie: user has the given role).
`Role`	`getOrCreateByName(String name, String description)` Retrieves a Role based on the given name.
`Role`	`produceRoleByName(javax.enterprise.inject.spi.InjectionPoint injectionPoint)` CDI producer method for Role beans annotated with `NamedRole`.

Methods inherited from class org.hawkular.accounts.api.internal.impl.BaseServiceImpl
getById

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RoleServiceImpl
```
public RoleServiceImpl()
```
- Method Detail
  - getById
```
public Role getById(UUID id)
```
    Description copied from interface: RoleService
    
    Retrieves the persistent Role based on its ID.
    
    Specified by:
    
    getById in interface RoleService
    
    Parameters:
    
    id - the role ID
    
    Returns:
    
    the role for the given ID
  - create
```
public Role create(String name,
                   String description)
```
    Description copied from interface: RoleService
    
    Creates a new Role based on the given name and description.
    
    Specified by:
    
    create in interface RoleService
    
    Parameters:
    
    name - the role's name. Must be unique and non-null
    
    description - free text, can be null
    
    Returns:
    
    the new Role
  - getByName
```
public Role getByName(String name)
```
    Description copied from interface: RoleService
    Retrieves the persistent Role based on its fixed name. For instance, requesting the role with name "SuperUser" would return the Role object representing the role with this name. Valid values:
    - Monitor
    - Operator
    - Maintainer
    - Deployer
    - Administrator
    - Auditor
    - SuperUser
    Specified by:
    
    getByName in interface RoleService
    
    Parameters:
    
    name - the common name for the role.
    
    Returns:
    
    the role for the given name
  - getImplicitUserRoles
```
public Set<Role> getImplicitUserRoles(String name)
```
    Description copied from interface: RoleService
    
    Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the User's perspective (ie: user has the given role). For instance, "SuperUser" would return all roles, while "Monitor" would return an empty Set, and "Operator" would return a set containing only "Monitor".
    
    Note that this is not suitable for getting which roles are allowed to perform an operation.
    
    Specified by:
    
    getImplicitUserRoles in interface RoleService
    
    Parameters:
    
    name - the "top of hierarchy" role to get the incorporated roles from
    
    Returns:
    
    a list of implicit roles or an empty list.
    
    See Also:
    
    RoleService.getImplicitUserRoles(Role)
  - getImplicitPermittedRoles
```
public Set<Role> getImplicitPermittedRoles(String name)
```
    Description copied from interface: RoleService
    
    Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the perspective of an operation. For instance, "SuperUser" would return an empty set meaning that only "SuperUser" is allowed, while "Monitor" would return all other roles.
    
    Note that this is not suitable for getting which roles an user implicitly has.
    
    Specified by:
    
    getImplicitPermittedRoles in interface RoleService
    
    Parameters:
    
    name - the "top of hierarchy" role to get the incorporated roles from
    
    Returns:
    
    a list of implicit roles or an empty list.
  - getImplicitUserRoles
```
public Set<Role> getImplicitUserRoles(Role role)
```
    Description copied from interface: RoleService
    
    Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the User's perspective (ie: user has the given role). For instance, "SuperUser" would return all roles, while "Monitor" would return an empty Set, and "Operator" would return a set containing only "Monitor".
    
    Note that this is not suitable for getting which roles are allowed to perform an operation.
    
    Specified by:
    
    getImplicitUserRoles in interface RoleService
    
    Parameters:
    
    role - the "top of hierarchy" role to get the incorporated roles from
    
    Returns:
    
    a list of implicit roles or an empty list.
  - getImplicitPermittedRoles
```
public Set<Role> getImplicitPermittedRoles(Role role)
```
    Description copied from interface: RoleService
    
    Following Wildfly's definition of roles, this method returns all roles that are implicit from the given role from the perspective of an operation. For instance, "SuperUser" would return an empty set meaning that only "SuperUser" is allowed, while "Monitor" would return all other roles.
    
    Note that this is not suitable for getting which roles an user implicitly has.
    
    Specified by:
    
    getImplicitPermittedRoles in interface RoleService
    
    Parameters:
    
    role - the "top of hierarchy" role to get the incorporated roles from
    
    Returns:
    
    a list of implicit roles or an empty list.
  - produceRoleByName
```
@Produces
public Role produceRoleByName(javax.enterprise.inject.spi.InjectionPoint injectionPoint)
```
    Description copied from interface: RoleService
    
    CDI producer method for Role beans annotated with NamedRole. This method is not intended to be called by consumers of the API.
    
    Specified by:
    
    produceRoleByName in interface RoleService
    
    Parameters:
    
    injectionPoint - the CDI InjectionPoint
    
    Returns:
    
    the role for the name on the annotation
  - getOrCreateByName
```
public Role getOrCreateByName(String name,
                              String description)
```
    Description copied from interface: RoleService
    
    Retrieves a Role based on the given name. If none exists, creates a new role based on the given name and description.
    
    Specified by:
    
    getOrCreateByName in interface RoleService
    
    Parameters:
    
    name - the name to use in the lookup of the Role
    
    description - a description to use, in case the role doesn't exist yet
    
    Returns:
    
    a newly created role if there's no role with the given name, or the existing role.

Class RoleServiceImpl

Constructor Summary

Method Summary

Methods inherited from class org.hawkular.accounts.api.internal.impl.BaseServiceImpl

Methods inherited from class java.lang.Object

Constructor Detail

RoleServiceImpl

Method Detail

getById

create

getByName

getImplicitUserRoles

getImplicitPermittedRoles

getImplicitUserRoles

getImplicitPermittedRoles

produceRoleByName

getOrCreateByName