org.onosproject.incubator.net.domain

Interface IntentDomainProvider

All Superinterfaces:

Provider

@Beta
public interface IntentDomainProvider
extends Provider

FIXME.

Method Summary

Modifier and Type	Method and Description
IntentResource	apply(IntentResource domainIntentResource) Requests that the provider apply the path from the intent resource.
void	cancel(IntentResource domainIntentResource) Requests that the provider cancel the path.
java.util.Set<IntentResource>	getResources() Returns all intent resources held by the provider.
IntentResource	modify(IntentResource oldResource, IntentResource newResource) Request that the provider attempt to modify an existing resource to satisfy a new intent primitive.
void	release(IntentResource resource) Requests that the provider release an intent resource.
java.util.List<IntentResource>	request(IntentDomain domain, IntentPrimitive primitive) Requests that the provider attempt to satisfy the intent primitive.

Methods inherited from interface org.onosproject.net.provider.Provider

id

Method Detail

request

java.util.List<IntentResource> request(IntentDomain domain,
                                       IntentPrimitive primitive)

Requests that the provider attempt to satisfy the intent primitive. The application must apply the context before the intent resource can be used. Request contexts can be explictly cancelled, or they will eventually time out so that resources can be reused.

Parameters:

domain - intent domain for the request

primitive - intent primitive

Returns:

intent resources that specify paths that satisfy the request.

modify

IntentResource modify(IntentResource oldResource,
                      IntentResource newResource)

Request that the provider attempt to modify an existing resource to satisfy a new intent primitive. The application must apply the context before the intent resource can be used.

Parameters:

oldResource - the resource to be replaced

newResource - the resource to be applied

Returns:

request contexts that contain resources to satisfy the intent

release

void release(IntentResource resource)

Requests that the provider release an intent resource.

Parameters:

resource - intent resource

apply

IntentResource apply(IntentResource domainIntentResource)

Requests that the provider apply the path from the intent resource.

Parameters:

domainIntentResource - request context

Returns:

intent resource that satisfies the intent

cancel

void cancel(IntentResource domainIntentResource)

Requests that the provider cancel the path. Requests that are not applied will be eventually timed out by the provider.

Parameters:

domainIntentResource - the intent resource whose path should be cancelled.

getResources

java.util.Set<IntentResource> getResources()

Returns all intent resources held by the provider.

Returns:

set of intent resources