org.onosproject.net.newresource

Interface ResourceService

@Beta
public interface ResourceService

Service for allocating/releasing resource(s) and retrieving allocation(s) and availability.

Method Summary

Modifier and Type	Method and Description
List<ResourceAllocation>	allocate(ResourceConsumer consumer, List<ResourcePath> resources) Transactionally allocates the specified resources to the specified user.
default List<ResourceAllocation>	allocate(ResourceConsumer consumer, ResourcePath... resources) Transactionally allocates the specified resources to the specified user.
default Optional<ResourceAllocation>	allocate(ResourceConsumer consumer, ResourcePath resource) Allocates the specified resource to the specified user.
Collection<ResourceAllocation>	getResourceAllocations(ResourceConsumer consumer) Returns resources allocated to the specified consumer.
<T> Collection<ResourceAllocation>	getResourceAllocations(ResourcePath parent, Class<T> cls) Returns allocated resources being as children of the specified parent and being the specified resource type.
boolean	isAvailable(ResourcePath resource) Returns the availability of the specified resource.
boolean	release(List<ResourceAllocation> allocations) Transactionally releases the specified resource allocations.
default boolean	release(ResourceAllocation... allocations) Transactionally releases the specified resource allocations.
default boolean	release(ResourceAllocation allocation) Releases the specified resource allocation.
boolean	release(ResourceConsumer consumer) Transactionally releases the resources allocated to the specified consumer.

Method Detail

allocate

default Optional<ResourceAllocation> allocate(ResourceConsumer consumer,
                                              ResourcePath resource)

Allocates the specified resource to the specified user.

Parameters:

consumer - resource user which the resource is allocated to

resource - resource to be allocated

Returns:

allocation information enclosed by Optional. If the allocation fails, the return value is empty

allocate

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

Transactionally allocates the specified resources to the specified user. All allocations are made when this method succeeds, or no allocation is made when this method fails.

Parameters:

consumer - resource user which the resources are allocated to

resources - resources to be allocated

Returns:

non-empty list of allocation information if succeeded, otherwise empty list

allocate

default List<ResourceAllocation> allocate(ResourceConsumer consumer,
                                          ResourcePath... resources)

Transactionally allocates the specified resources to the specified user. All allocations are made when this method succeeds, or no allocation is made when this method fails.

Parameters:

consumer - resource user which the resources are allocated to

resources - resources to be allocated

Returns:

non-empty list of allocation information if succeeded, otherwise empty list

release

default boolean release(ResourceAllocation allocation)

Releases the specified resource allocation.

Parameters:

allocation - resource allocation to be released

Returns:

true if succeeded, otherwise false

release

boolean release(List<ResourceAllocation> allocations)

Transactionally releases the specified resource allocations. All allocations are released when this method succeeded, or no allocation is released when this method fails.

Parameters:

allocations - resource allocations to be released

Returns:

true if succeeded, otherwise false

release

default boolean release(ResourceAllocation... allocations)

Transactionally releases the specified resource allocations. All allocations are released when this method succeeded, or no allocation is released when this method fails.

Parameters:

allocations - resource allocations to be released

Returns:

true if succeeded, otherwise false

release

boolean release(ResourceConsumer consumer)

Transactionally releases the resources allocated to the specified consumer. All allocations are released when this method succeeded, or no allocation is released when this method fails.

Parameters:

consumer - consumer whose allocated resources are to be released

Returns:

true if succeeded, otherwise false

getResourceAllocations

<T> Collection<ResourceAllocation> getResourceAllocations(ResourcePath parent,
                                                          Class<T> cls)

Returns allocated resources being as children of the specified parent and being the specified resource type.

Type Parameters:

T - type of the resource

Parameters:

parent - parent resource path

cls - class to specify a type of resource

Returns:

non-empty collection of resource allocations if resources are allocated with the subject and type, empty collection if no resource is allocated with the subject and type

getResourceAllocations

Collection<ResourceAllocation> getResourceAllocations(ResourceConsumer consumer)

Returns resources allocated to the specified consumer.

Parameters:

consumer - consumer whose allocated resources are to be returned

Returns:

resources allocated to the consumer

isAvailable

boolean isAvailable(ResourcePath resource)

Returns the availability of the specified resource.

Parameters:

resource - resource to check the availability

Returns:

true if available, otherwise false