org.onosproject.net.intent

Interface IntentService

public interface IntentService

Service for application submitting or withdrawing their intents.

Method Summary

Modifier and Type	Method and Description
void	addListener(IntentListener listener) Adds the specified listener for intent events.
void	execute(IntentOperations operations) Submits a batch of submit & withdraw operations.
List<Intent>	getInstallableIntents(IntentId intentId) Returns the list of the installable events associated with the specified top-level intent.
Intent	getIntent(IntentId id) Retrieves the intent specified by its identifier.
long	getIntentCount() Returns the number of intents currently in the system.
Iterable<Intent>	getIntents() Returns an iterable of intents currently in the system.
IntentState	getIntentState(IntentId id) Retrieves the state of an intent by its identifier.
void	removeListener(IntentListener listener) Removes the specified listener for intent events.
void	replace(IntentId oldIntentId, Intent newIntent) Replaces the specified intent with a new one.
void	submit(Intent intent) Submits an intent into the system.
void	withdraw(Intent intent) Withdraws an intent from the system.

Method Detail

submit

void submit(Intent intent)

Submits an intent into the system.

This is an asynchronous request meaning that any compiling or installation activities may be done at later time.

Parameters:

intent - intent to be submitted

withdraw

void withdraw(Intent intent)

Withdraws an intent from the system.

This is an asynchronous request meaning that the environment may be affected at later time.

Parameters:

intent - intent to be withdrawn

replace

void replace(IntentId oldIntentId,
             Intent newIntent)

Replaces the specified intent with a new one.

Parameters:

oldIntentId - identifier of the old intent being replaced

newIntent - new intent replacing the old one

execute

void execute(IntentOperations operations)

Submits a batch of submit & withdraw operations. Such a batch is assumed to be processed together.

This is an asynchronous request meaning that the environment may be affected at later time.

Parameters:

operations - batch of intent operations

getIntents

Iterable<Intent> getIntents()

Returns an iterable of intents currently in the system.

Returns:

set of intents

getIntentCount

long getIntentCount()

Returns the number of intents currently in the system.

Returns:

number of intents

getIntent

Intent getIntent(IntentId id)

Retrieves the intent specified by its identifier.

Parameters:

id - intent identifier

Returns:

the intent or null if one with the given identifier is not found

getIntentState

IntentState getIntentState(IntentId id)

Retrieves the state of an intent by its identifier.

Parameters:

id - intent identifier

Returns:

the intent state or null if one with the given identifier is not found

getInstallableIntents

List<Intent> getInstallableIntents(IntentId intentId)

Returns the list of the installable events associated with the specified top-level intent.

Parameters:

intentId - top-level intent identifier

Returns:

compiled installable intents

addListener

void addListener(IntentListener listener)

Adds the specified listener for intent events.

Parameters:

listener - listener to be added

removeListener

void removeListener(IntentListener listener)

Removes the specified listener for intent events.

Parameters:

listener - listener to be removed