org.onosproject.net.newresource

Interface ResourceStore

@Beta
public interface ResourceStore

Service for storing resource and consumer information.

Method Summary

Modifier and Type	Method and Description
boolean	allocate(List<ResourcePath> resources, ResourceConsumer consumer) Allocates the specified resources to the specified consumer in transactional way.
<T> Collection<ResourcePath>	getAllocatedResources(ResourcePath parent, Class<T> cls) Returns a collection of the resources which are children of the specified parent and whose type is the specified class.
Optional<ResourceConsumer>	getConsumer(ResourcePath resource) Returns the resource consumer to whom the specified resource is allocated.
Collection<ResourcePath>	getResources(ResourceConsumer consumer) Returns a collection of the resources allocated to the specified consumer.
boolean	register(List<ResourcePath> resources) Registers the resources in transactional way.
boolean	release(List<ResourcePath> resources, List<ResourceConsumer> consumers) Releases the specified resources allocated to the specified corresponding consumers in transactional way.
boolean	unregister(List<ResourcePath> resources) Unregisters the resources in transactional way.

Method Detail

register

boolean register(List<ResourcePath> resources)

Registers the resources in transactional way. Resource registration must be done before resource allocation. The state after completion of this method is all the resources are registered, or none of the given resources is registered. The whole registration fails when any one of the resource can't be registered.

Parameters:

resources - resources to be registered

Returns:

true if the registration succeeds, false otherwise

unregister

boolean unregister(List<ResourcePath> resources)

Unregisters the resources in transactional way. The state after completion of this method is all the resources are unregistered, or none of the given resources is unregistered. The whole unregistration fails when any one of the resource can't be unregistered.

Parameters:

resources - resources to be unregistered

Returns:

true if the registration succeeds, false otherwise

allocate

boolean allocate(List<ResourcePath> resources,
                 ResourceConsumer consumer)

Allocates the specified resources to the specified consumer in transactional way. The state after completion of this method is all the resources are allocated to the consumer, or no resource is allocated to the consumer. The whole allocation fails when any one of the resource can't be allocated.

Parameters:

resources - resources to be allocated

consumer - resource consumer which the resources are allocated to

Returns:

true if the allocation succeeds, false otherwise.

release

boolean release(List<ResourcePath> resources,
                List<ResourceConsumer> consumers)

Releases the specified resources allocated to the specified corresponding consumers in transactional way. The state after completion of this method is all the resources are released from the consumer, or no resource is released. The whole release fails when any one of the resource can't be released. The size of the list of resources and that of consumers must be equal. The resource and consumer with the same position from the head of each list correspond to each other.

Parameters:

resources - resources to be released

consumers - resource consumers to whom the resource allocated to

Returns:

true if succeeds, otherwise false

getConsumer

Optional<ResourceConsumer> getConsumer(ResourcePath resource)

Returns the resource consumer to whom the specified resource is allocated.

Parameters:

resource - resource whose allocated consumer to be returned

Returns:

resource consumer who are allocated the resource

getResources

Collection<ResourcePath> getResources(ResourceConsumer consumer)

Returns a collection of the resources allocated to the specified consumer.

Parameters:

consumer - resource consumer whose allocated resource are searched for

Returns:

a collection of the resources allocated to the specified consumer

getAllocatedResources

<T> Collection<ResourcePath> getAllocatedResources(ResourcePath parent,
                                                   Class<T> cls)

Returns a collection of the resources which are children of the specified parent and whose type is the specified class.

Type Parameters:

T - type of the resource

Parameters:

parent - parent of the resources to be returned

cls - class instance of the children

Returns:

a collection of the resources which belongs to the specified subject and whose type is the specified class.