org.hawkular.accounts.api

Interface RoleService

All Known Implementing Classes:

RoleServiceImpl

public interface RoleService

Provides access to information related to Role. Can be injected via CDI into managed beans as follows:

         @Inject RoleService roleService;
     

Concrete implementations do not hold any state, but it's advised to get an instance through CDI or as an EJB.

Author:

Juraci Paixão Kröhling

Method Summary

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.

Method Detail

create

Role create(String name,
            String description)

Creates a new Role based on the given name and description.

Parameters:

name - the role's name. Must be unique and non-null

description - free text, can be null

Returns:

the new Role

getById

Role getById(UUID id)

Retrieves the persistent Role based on its ID.

Parameters:

id - the role ID

Returns:

the role for the given ID

getByName

Role getByName(String name)

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

Parameters:

name - the common name for the role.

Returns:

the role for the given name

getImplicitUserRoles

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). 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.

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:

getImplicitUserRoles(Role)

getImplicitUserRoles

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). 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.

Parameters:

role - the "top of hierarchy" role to get the incorporated roles from

Returns:

a list of implicit roles or an empty list.

getImplicitPermittedRoles

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. 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.

Parameters:

name - the "top of hierarchy" role to get the incorporated roles from

Returns:

a list of implicit roles or an empty list.

getImplicitPermittedRoles

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. 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.

Parameters:

role - the "top of hierarchy" role to get the incorporated roles from

Returns:

a list of implicit roles or an empty list.

produceRoleByName

Role produceRoleByName(javax.enterprise.inject.spi.InjectionPoint injectionPoint)

CDI producer method for Role beans annotated with NamedRole. This method is not intended to be called by consumers of the API.

Parameters:

injectionPoint - the CDI InjectionPoint

Returns:

the role for the name on the annotation

getOrCreateByName

Role getOrCreateByName(String name,
                       String description)

Retrieves a Role based on the given name. If none exists, creates a new role based on the given name and description.

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.