org.onosproject.incubator.store.virtual.impl

Class SimpleVirtualIntentStore

java.lang.Object

org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore<org.onosproject.net.intent.IntentEvent,org.onosproject.net.intent.IntentStoreDelegate>

org.onosproject.incubator.store.virtual.impl.SimpleVirtualIntentStore

All Implemented Interfaces:

VirtualNetworkIntentStore, VirtualStore<org.onosproject.net.intent.IntentEvent,org.onosproject.net.intent.IntentStoreDelegate>

@Service
public class SimpleVirtualIntentStore
extends AbstractVirtualStore<org.onosproject.net.intent.IntentEvent,org.onosproject.net.intent.IntentStoreDelegate>
implements VirtualNetworkIntentStore

Simple single-instance implementation of the intent store for virtual networks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleVirtualIntentStore.SystemClockTimestamp

Field Summary

Fields inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

delegateMap

Constructor Summary

Constructors

Constructor and Description
SimpleVirtualIntentStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addPending(NetworkId networkId, org.onosproject.net.intent.IntentData data) Adds a new operation, which should be persisted and delegated.
void	batchWrite(NetworkId networkId, java.lang.Iterable<org.onosproject.net.intent.IntentData> updates) Writes a batch of IntentData objects to the store.
void	deactivate()
java.util.List<org.onosproject.net.intent.Intent>	getInstallableIntents(NetworkId networkId, org.onosproject.net.intent.Key intentKey) Returns the list of the installable events associated with the specified original intent.
org.onosproject.net.intent.Intent	getIntent(NetworkId networkId, org.onosproject.net.intent.Key key) Returns the intent with the specified identifier.
long	getIntentCount(NetworkId networkId) Returns the number of intents in the store.
java.lang.Iterable<org.onosproject.net.intent.IntentData>	getIntentData(NetworkId networkId, boolean localOnly, long olderThan) Returns an iterable of all intent data objects in the store.
org.onosproject.net.intent.IntentData	getIntentData(NetworkId networkId, org.onosproject.net.intent.Key key) Returns the intent data object associated with the specified key.
java.lang.Iterable<org.onosproject.net.intent.Intent>	getIntents(NetworkId networkId) Returns an iterable of all intents in the store.
org.onosproject.net.intent.IntentState	getIntentState(NetworkId networkId, org.onosproject.net.intent.Key intentKey) Returns the state of the specified intent.
java.lang.Iterable<org.onosproject.net.intent.Intent>	getPending(NetworkId networkId) Returns the intent requests pending processing.
java.lang.Iterable<org.onosproject.net.intent.IntentData>	getPendingData(NetworkId networkId) Returns the intent data objects that are pending processing.
java.lang.Iterable<org.onosproject.net.intent.IntentData>	getPendingData(NetworkId networkId, boolean localOnly, long olderThan) Returns the intent data objects that are pending processing for longer than the specified duration.
org.onosproject.net.intent.IntentData	getPendingData(NetworkId networkId, org.onosproject.net.intent.Key intentKey) Returns the intent data object that are pending processing for a specfied key.
boolean	isMaster(NetworkId networkId, org.onosproject.net.intent.Key intentKey) Checks to see whether the calling instance is the master for processing this intent, or more specifically, the key contained in this intent.
void	write(NetworkId networkId, org.onosproject.net.intent.IntentData newData) Writes an IntentData object to the store.

Methods inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

hasDelegate, notifyDelegate, notifyDelegate, setDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.incubator.net.virtual.VirtualStore

hasDelegate, setDelegate, unsetDelegate

Constructor Detail

SimpleVirtualIntentStore

public SimpleVirtualIntentStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

getIntentCount

public long getIntentCount(NetworkId networkId)

Description copied from interface: VirtualNetworkIntentStore

Returns the number of intents in the store.

Specified by:

getIntentCount in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

Returns:

the number of intents in the store

getIntents

public java.lang.Iterable<org.onosproject.net.intent.Intent> getIntents(NetworkId networkId)

Description copied from interface: VirtualNetworkIntentStore

Returns an iterable of all intents in the store.

Specified by:

getIntents in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

Returns:

iterable of all intents

getIntentData

public java.lang.Iterable<org.onosproject.net.intent.IntentData> getIntentData(NetworkId networkId,
                                                                               boolean localOnly,
                                                                               long olderThan)

Description copied from interface: VirtualNetworkIntentStore

Returns an iterable of all intent data objects in the store.

Specified by:

getIntentData in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

localOnly - should only intents for which this instance is master be returned

olderThan - specified duration in milliseconds (0 for "now")

Returns:

iterable of all intent data objects

getIntentState

public org.onosproject.net.intent.IntentState getIntentState(NetworkId networkId,
                                                             org.onosproject.net.intent.Key intentKey)

Description copied from interface: VirtualNetworkIntentStore

Returns the state of the specified intent.

Specified by:

getIntentState in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

intentKey - intent identification

Returns:

current intent state

getInstallableIntents

public java.util.List<org.onosproject.net.intent.Intent> getInstallableIntents(NetworkId networkId,
                                                                               org.onosproject.net.intent.Key intentKey)

Description copied from interface: VirtualNetworkIntentStore

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

Specified by:

getInstallableIntents in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

intentKey - original intent identifier

Returns:

compiled installable intents, or null if no installables exist

write

public void write(NetworkId networkId,
                  org.onosproject.net.intent.IntentData newData)

Description copied from interface: VirtualNetworkIntentStore

Writes an IntentData object to the store.

Specified by:

write in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

newData - new intent data to write

batchWrite

public void batchWrite(NetworkId networkId,
                       java.lang.Iterable<org.onosproject.net.intent.IntentData> updates)

Description copied from interface: VirtualNetworkIntentStore

Writes a batch of IntentData objects to the store. A batch has no semantics, this is simply a convenience API.

Specified by:

batchWrite in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

updates - collection of intent data objects to write

getIntent

public org.onosproject.net.intent.Intent getIntent(NetworkId networkId,
                                                   org.onosproject.net.intent.Key key)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent with the specified identifier.

Specified by:

getIntent in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

key - key

Returns:

intent or null if not found

getIntentData

public org.onosproject.net.intent.IntentData getIntentData(NetworkId networkId,
                                                           org.onosproject.net.intent.Key key)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent data object associated with the specified key.

Specified by:

getIntentData in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

key - key to look up

Returns:

intent data object

addPending

public void addPending(NetworkId networkId,
                       org.onosproject.net.intent.IntentData data)

Description copied from interface: VirtualNetworkIntentStore

Adds a new operation, which should be persisted and delegated.

Specified by:

addPending in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

data - operation

isMaster

public boolean isMaster(NetworkId networkId,
                        org.onosproject.net.intent.Key intentKey)

Description copied from interface: VirtualNetworkIntentStore

Checks to see whether the calling instance is the master for processing this intent, or more specifically, the key contained in this intent.

Specified by:

isMaster in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

intentKey - intentKey to check

Returns:

true if master; false, otherwise

getPending

public java.lang.Iterable<org.onosproject.net.intent.Intent> getPending(NetworkId networkId)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent requests pending processing.

Specified by:

getPending in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

Returns:

pending intents

getPendingData

public java.lang.Iterable<org.onosproject.net.intent.IntentData> getPendingData(NetworkId networkId)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent data objects that are pending processing.

Specified by:

getPendingData in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

Returns:

pending intent data objects

getPendingData

public org.onosproject.net.intent.IntentData getPendingData(NetworkId networkId,
                                                            org.onosproject.net.intent.Key intentKey)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent data object that are pending processing for a specfied key.

Specified by:

getPendingData in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

intentKey - key to look up

Returns:

pending intent data object

getPendingData

public java.lang.Iterable<org.onosproject.net.intent.IntentData> getPendingData(NetworkId networkId,
                                                                                boolean localOnly,
                                                                                long olderThan)

Description copied from interface: VirtualNetworkIntentStore

Returns the intent data objects that are pending processing for longer than the specified duration.

Specified by:

getPendingData in interface VirtualNetworkIntentStore

Parameters:

networkId - the virtual network identifier

localOnly - should only intents for which this instance is master be returned

olderThan - specified duration in milliseconds (0 for "now")

Returns:

pending intent data objects