org.onosproject.net.intent

Class Intent

java.lang.Object

org.onosproject.net.intent.Intent

All Implemented Interfaces:

BatchOperationTarget

Direct Known Subclasses:

ConnectivityIntent, OpticalConnectivityIntent, OpticalPathIntent

public abstract class Intent
extends Object
implements BatchOperationTarget

Abstraction of an application level intent.

Make sure that an Intent should be immutable when a new type is defined.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Intent() Constructor for serializer.
protected	Intent(ApplicationId appId, Collection<NetworkResource> resources) Creates a new intent.

Method Summary

Modifier and Type	Method and Description
ApplicationId	appId() Returns the identifier of the application that requested the intent.
static void	bindIdGenerator(IdGenerator newIdGenerator) Binds an id generator for unique intent id generation.
boolean	equals(Object obj)
int	hashCode()
IntentId	id() Returns the intent identifier.
boolean	isInstallable() Indicates whether or not the intent is installable.
Collection<NetworkResource>	resources() Returns the collection of resources required for this intent.
static void	unbindIdGenerator(IdGenerator oldIdGenerator) Unbinds an id generator.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Intent

protected Intent()

Constructor for serializer.

Intent

protected Intent(ApplicationId appId,
                 Collection<NetworkResource> resources)

Creates a new intent.

Parameters:

appId - application identifier

resources - required network resources (optional)

Method Detail

id

public IntentId id()

Returns the intent identifier.

Returns:

intent fingerprint

appId

public ApplicationId appId()

Returns the identifier of the application that requested the intent.

Returns:

application identifier

resources

public Collection<NetworkResource> resources()

Returns the collection of resources required for this intent.

Returns:

collection of resources; may be null

isInstallable

public boolean isInstallable()

Indicates whether or not the intent is installable.

Returns:

true if installable

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

bindIdGenerator

public static void bindIdGenerator(IdGenerator newIdGenerator)

Binds an id generator for unique intent id generation. Note: A generator cannot be bound if there is already a generator bound.

Parameters:

newIdGenerator - id generator

unbindIdGenerator

public static void unbindIdGenerator(IdGenerator oldIdGenerator)

Unbinds an id generator. Note: The caller must provide the old id generator to succeed.

Parameters:

oldIdGenerator - the current id generator