org.onosproject.net.intent

Interface IntentStore

All Superinterfaces:

Store<IntentEvent,IntentStoreDelegate>

public interface IntentStore
extends Store<IntentEvent,IntentStoreDelegate>

Manages inventory of end-station intents; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
List<BatchWrite.Operation>	batchWrite(BatchWrite batch) Execute writes in a batch.
void	createIntent(Intent intent) Deprecated.
List<Intent>	getInstallableIntents(IntentId intentId) Returns the list of the installable events associated with the specified original intent.
Intent	getIntent(IntentId intentId) Returns the intent with the specified identifier.
long	getIntentCount() Returns the number of intents in the store.
Iterable<Intent>	getIntents() Returns a collection of all intents in the store.
IntentState	getIntentState(IntentId intentId) Returns the state of the specified intent.
void	removeInstalledIntents(IntentId intentId) Removes any installable intents which resulted from compilation of the specified original intent.
void	removeIntent(IntentId intentId) Deprecated.
void	setInstallableIntents(IntentId intentId, List<Intent> installableIntents) Sets the installable intents which resulted from compilation of the specified original intent.
void	setState(Intent intent, IntentState newState) Sets the state of the specified intent to the new state.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

createIntent

@Deprecated
void createIntent(Intent intent)

Deprecated.

Submits a new intent into the store. If the returned event is not null, the manager is expected to dispatch the event and then to kick off intent compilation process. Otherwise, another node has been elected to perform the compilation process and the node will learn about the submittal and results of the intent compilation via the delegate mechanism.

Parameters:

intent - intent to be submitted

removeIntent

@Deprecated
void removeIntent(IntentId intentId)

Deprecated.

Removes the specified intent from the inventory.

Parameters:

intentId - intent identification

getIntentCount

long getIntentCount()

Returns the number of intents in the store.

Returns:

the number of intents in the store

getIntents

Iterable<Intent> getIntents()

Returns a collection of all intents in the store.

Returns:

iterable collection of all intents

getIntent

Intent getIntent(IntentId intentId)

Returns the intent with the specified identifier.

Parameters:

intentId - intent identification

Returns:

intent or null if not found

getIntentState

IntentState getIntentState(IntentId intentId)

Returns the state of the specified intent.

Parameters:

intentId - intent identification

Returns:

current intent state

setState

void setState(Intent intent,
              IntentState newState)

Sets the state of the specified intent to the new state.

Parameters:

intent - intent whose state is to be changed

newState - new state

setInstallableIntents

void setInstallableIntents(IntentId intentId,
                           List<Intent> installableIntents)

Sets the installable intents which resulted from compilation of the specified original intent.

Parameters:

intentId - original intent identifier

installableIntents - compiled installable intents

getInstallableIntents

List<Intent> getInstallableIntents(IntentId intentId)

Returns the list of the installable events associated with the specified original intent.

Parameters:

intentId - original intent identifier

Returns:

compiled installable intents

removeInstalledIntents

void removeInstalledIntents(IntentId intentId)

Removes any installable intents which resulted from compilation of the specified original intent.

Parameters:

intentId - original intent identifier

batchWrite

List<BatchWrite.Operation> batchWrite(BatchWrite batch)

Execute writes in a batch.

Parameters:

batch - BatchWrite to execute

Returns:

failed operations