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
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) Retrieves a Resource based on its ID.

Method Detail

get

Resource get(String 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