org.hawkular.accounts.api

Interface PersonaService

All Known Implementing Classes:

PersonaServiceImpl

public interface PersonaService

Provides an interface for querying and managing Persona. Can be injected via CDI into managed beans as follows:

         @Inject PersonaService personaService;
     

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
Persona	get(String id) Retrieves an Persona based on a given ID.
Persona	getCurrent() Retrieves the current Persona for this request.
Set<Role>	getEffectiveRolesForResource(Persona persona, Resource resource) Retrieves the effective role of a Persona on a given Resource.
boolean	isAllowedToImpersonate(HawkularUser actual, Persona toImpersonate) Checks if the current user is allowed to impersonate the given persona.

Method Detail

get

Persona get(String id)

Retrieves an Persona based on a given ID.

Parameters:

id - the persona's ID

Returns:

the persona or null if there are no persona under this ID.

Throws:

IllegalArgumentException - if the ID is null

getEffectiveRolesForResource

Set<Role> getEffectiveRolesForResource(Persona persona,
                                       Resource resource)

Retrieves the effective role of a Persona on a given Resource. If the Persona has no direct roles on the given resource, then the organizations to which this persona is checked. A combined list of roles is returned.

Example 1:
User "jdoe" is "SuperUser" and "Auditor" on "resource1". Both "SuperUser" and "Auditor" are returned.

Example 2:
User "jdoe" is a CIO and belongs to "Operations" and to "Management" and has no direct roles on "resource1".
"Operations" is "Administrator" on "resource1"
"Management" is "SuperUser" on "resource1"
The effective roles for "jdoe" on "resource1" are "SuperUser" and "Administrator".

Parameters:

persona - the persona

resource - the resource

Returns:

the effective roles that the persona has on the resource or null if no permissions are set

getCurrent

Persona getCurrent()

Retrieves the current Persona for this request.

Returns:

the current persona.

isAllowedToImpersonate

boolean isAllowedToImpersonate(HawkularUser actual,
                               Persona toImpersonate)

Checks if the current user is allowed to impersonate the given persona. At this moment, this implementation returns only "true", but will soon be changed to the appropriate behavior.

Parameters:

actual - the logged in user

toImpersonate - the persona to be impersonated

Returns:

whether or not the current user can impersona the given persona