org.onosproject.incubator.store.virtual.impl

Class SimpleVirtualMeterStore

java.lang.Object

org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore<org.onosproject.net.meter.MeterEvent,org.onosproject.net.meter.MeterStoreDelegate>

org.onosproject.incubator.store.virtual.impl.SimpleVirtualMeterStore

All Implemented Interfaces:

VirtualNetworkMeterStore, VirtualStore<org.onosproject.net.meter.MeterEvent,org.onosproject.net.meter.MeterStoreDelegate>

@Service
public class SimpleVirtualMeterStore
extends AbstractVirtualStore<org.onosproject.net.meter.MeterEvent,org.onosproject.net.meter.MeterStoreDelegate>
implements VirtualNetworkMeterStore

Implementation of the virtual meter store for a single instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.cluster.ClusterService	clusterService

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

delegateMap

Constructor Summary

Constructors

Constructor and Description
SimpleVirtualMeterStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	deactivate()
java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	deleteMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Deletes a meter from the store.
org.onosproject.net.meter.MeterStoreResult	deleteMeterFeatures(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Deletes the meter features from the store.
void	deleteMeterNow(NetworkId networkId, org.onosproject.net.meter.Meter m) Delete this meter immediately.
void	failedMeter(NetworkId networkId, org.onosproject.net.meter.MeterOperation op, org.onosproject.net.meter.MeterFailReason reason) Update the store by deleting the failed meter.
java.util.Collection<org.onosproject.net.meter.Meter>	getAllMeters(NetworkId networkId) Returns all meters stored in the store.
long	getMaxMeters(NetworkId networkId, org.onosproject.net.meter.MeterFeaturesKey key) Retrieve maximum meters available for the device.
org.onosproject.net.meter.Meter	getMeter(NetworkId networkId, org.onosproject.net.meter.MeterKey key) Obtains a meter matching the given meter key.
java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	storeMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Adds a meter to the store.
org.onosproject.net.meter.MeterStoreResult	storeMeterFeatures(NetworkId networkId, org.onosproject.net.meter.MeterFeatures meterfeatures) Adds the meter features to the store.
java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	updateMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Updates a meter whose meter id is the same as the passed meter.
void	updateMeterState(NetworkId networkId, org.onosproject.net.meter.Meter meter) Updates a given meter's state with the provided state.

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

Field Detail

clusterService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.ClusterService clusterService

Constructor Detail

SimpleVirtualMeterStore

public SimpleVirtualMeterStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

storeMeter

public java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult> storeMeter(NetworkId networkId,
                                                                                                     org.onosproject.net.meter.Meter meter)

Description copied from interface: VirtualNetworkMeterStore

Adds a meter to the store.

Specified by:

storeMeter in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

meter - a meter

Returns:

a future indicating the result of the store operation

deleteMeter

public java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult> deleteMeter(NetworkId networkId,
                                                                                                      org.onosproject.net.meter.Meter meter)

Description copied from interface: VirtualNetworkMeterStore

Deletes a meter from the store.

Specified by:

deleteMeter in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

meter - a meter

Returns:

a future indicating the result of the store operation

storeMeterFeatures

public org.onosproject.net.meter.MeterStoreResult storeMeterFeatures(NetworkId networkId,
                                                                     org.onosproject.net.meter.MeterFeatures meterfeatures)

Description copied from interface: VirtualNetworkMeterStore

Adds the meter features to the store.

Specified by:

storeMeterFeatures in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

meterfeatures - the meter features

Returns:

the result of the store operation

deleteMeterFeatures

public org.onosproject.net.meter.MeterStoreResult deleteMeterFeatures(NetworkId networkId,
                                                                      org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMeterStore

Deletes the meter features from the store.

Specified by:

deleteMeterFeatures in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

deviceId - the device id

Returns:

a future indicating the result of the store operation

updateMeter

public java.util.concurrent.CompletableFuture<org.onosproject.net.meter.MeterStoreResult> updateMeter(NetworkId networkId,
                                                                                                      org.onosproject.net.meter.Meter meter)

Description copied from interface: VirtualNetworkMeterStore

Updates a meter whose meter id is the same as the passed meter.

Specified by:

updateMeter in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

meter - a new meter

Returns:

a future indicating the result of the store operation

updateMeterState

public void updateMeterState(NetworkId networkId,
                             org.onosproject.net.meter.Meter meter)

Description copied from interface: VirtualNetworkMeterStore

Updates a given meter's state with the provided state.

Specified by:

updateMeterState in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

meter - a meter

getMeter

public org.onosproject.net.meter.Meter getMeter(NetworkId networkId,
                                                org.onosproject.net.meter.MeterKey key)

Description copied from interface: VirtualNetworkMeterStore

Obtains a meter matching the given meter key.

Specified by:

getMeter in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

key - a meter key

Returns:

a meter

getAllMeters

public java.util.Collection<org.onosproject.net.meter.Meter> getAllMeters(NetworkId networkId)

Description copied from interface: VirtualNetworkMeterStore

Returns all meters stored in the store.

Specified by:

getAllMeters in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

Returns:

a collection of meters

failedMeter

public void failedMeter(NetworkId networkId,
                        org.onosproject.net.meter.MeterOperation op,
                        org.onosproject.net.meter.MeterFailReason reason)

Description copied from interface: VirtualNetworkMeterStore

Update the store by deleting the failed meter. Notifies the delegate that the meter failed to allow it to nofity the app.

Specified by:

failedMeter in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

op - a failed meter operation

reason - a failure reason

deleteMeterNow

public void deleteMeterNow(NetworkId networkId,
                           org.onosproject.net.meter.Meter m)

Description copied from interface: VirtualNetworkMeterStore

Delete this meter immediately.

Specified by:

deleteMeterNow in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

m - a meter

getMaxMeters

public long getMaxMeters(NetworkId networkId,
                         org.onosproject.net.meter.MeterFeaturesKey key)

Description copied from interface: VirtualNetworkMeterStore

Retrieve maximum meters available for the device.

Specified by:

getMaxMeters in interface VirtualNetworkMeterStore

Parameters:

networkId - a virtual network identifier

key - the meter features key

Returns:

the maximum number of meters supported by the device