org.hawkular.accounts.api

Interface ResourceService

All Known Implementing Classes:

ResourceServiceImpl

public interface ResourceService

Manages Resource. A Resource can be anything that is meant to be protected by the consumer modules. For instance, a Resource could be an Alert, an Inventory item or a Metric. Can be injected via CDI into managed beans as follows:

         @Inject ResourceService resourceService;
     

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
PersonaResourceRole	addRoleToPersona(Resource resource, Persona persona, Role role) Adds a Role to a Persona into a Resource
Resource	create(String id, Persona persona) Creates a Resource based on its ID, owned by the specified Persona
Resource	create(String id, Resource parent) Creates a new sub resource, based on a given ID and owning resource
Resource	create(String id, Resource parent, Persona persona) Creates a new sub resource, based on a given ID, parent and owned by the specified Persona
void	delete(String id) Removes a Resource based on its ID.
Resource	get(String id) Deprecated. Use getById(UUID)
Resource	getById(UUID id) Retrieves a Resource based on its ID.
List<Resource>	getByPersona(Persona persona) Lists all the resources that belong to a given persona.
List<PersonaResourceRole>	getRolesForPersona(Resource resource, Persona persona) Deprecated. Use PersonaResourceRoleService.getByPersonaAndResource(Persona, Resource) instead
void	revokeAllForPersona(Resource resource, Persona persona) Revoke all roles that the given persona has on the resource.
void	transfer(Resource resource, Persona persona) Transfers the resource to the given persona.

Method Detail

get

@Deprecated
Resource get(String id)

Deprecated. Use getById(UUID)

Retrieves a Resource based on its ID. If the ID is not "UUID-like", then a new UUID is created based on the bytes of the given ID. By "UUID-like", we mean a string that matches a regular expression for the appearance of an UUID such as 'eb66fa08-7cbf-11e5-8cdd-3c970e9648d7'.

Parameters:

id - the resource's ID

Returns:

the existing Resource or null if the resource doesn't exists.

Throws:

IllegalArgumentException - if the given ID is null

See Also:

UUID.nameUUIDFromBytes(byte[])

getById

Resource getById(UUID id)

Retrieves a Resource based on its ID.

Parameters:

id - the resource's ID

Returns:

the existing Resource or null if the resource doesn't exists.

Throws:

IllegalArgumentException - if the given ID is null

create

Resource create(String id,
                Persona persona)

Creates a Resource based on its ID, owned by the specified Persona

Parameters:

id - the ID to be assigned to this resource or null for a new UUID

persona - a valid owner for this resource

Returns:

the newly created Resource

Throws:

IllegalArgumentException - if the persona is null

create

Resource create(String id,
                Resource parent)

Creates a new sub resource, based on a given ID and owning resource

Parameters:

id - the ID to be assigned to this resource or null for a new UUID

parent - a valid resource to serve as the parent of this sub resource

Returns:

the newly created Resource

Throws:

IllegalArgumentException - if the parent is null

create

Resource create(String id,
                Resource parent,
                Persona persona)

Creates a new sub resource, based on a given ID, parent and owned by the specified Persona

Parameters:

id - the ID to be assigned to this resource or null for a new UUID

parent - the resource's parent or null if the owner is provided

persona - the resource's owner or null if the parent is provided

Returns:

the newly created Resource

Throws:

IllegalArgumentException - if both the parent and the owner are null

delete

void delete(String id)

Removes a Resource based on its ID.

Parameters:

id - the resource's ID

Throws:

IllegalArgumentException - if the given ID is null

getByPersona

List<Resource> getByPersona(Persona persona)

Lists all the resources that belong to a given persona.

Parameters:

persona - the persona that owns the resources

Returns:

a List of Resource containing the resources owned by the persona

transfer

void transfer(Resource resource,
              Persona persona)

Transfers the resource to the given persona. Note that the previous owner might still have individual permissions on the resource, so, consider also calling revokeAllForPersona(Resource, Persona) if it's appropriate. This method also revokes all the current permissions of the new owner, replacing all of them by a single "SuperUser" role on the resource.

Parameters:

resource - the resource to receive the new owner

persona - the persona that will be the new owner

revokeAllForPersona

void revokeAllForPersona(Resource resource,
                         Persona persona)

Revoke all roles that the given persona has on the resource. Note that this does not changes the ownership of a resource, so, if the persona is currently the owner of the resource, the persona will still have owner-rights to it, even though no individual roles are given.

Parameters:

resource - the resource that the person currently has roles

persona - the persona to get the access revoked

addRoleToPersona

PersonaResourceRole addRoleToPersona(Resource resource,
                                     Persona persona,
                                     Role role)

Adds a Role to a Persona into a Resource

Parameters:

resource - the resource

persona - the persona to get access to the resource

role - the role of the persona on the resource

getRolesForPersona

@Deprecated
List<PersonaResourceRole> getRolesForPersona(Resource resource,
                                                         Persona persona)

Deprecated. Use PersonaResourceRoleService.getByPersonaAndResource(Persona, Resource) instead

Retrieves the roles that a given persona has on the given resource.

Parameters:

resource - the resource to check

persona - the persona to check

Returns:

a list of PersonaResourceRole, with one entry per combination.