org.onosproject.incubator.store.tunnel.impl

Class DistributedTunnelStore

java.lang.Object

org.onosproject.store.AbstractStore<TunnelEvent,TunnelStoreDelegate>

org.onosproject.incubator.store.tunnel.impl.DistributedTunnelStore

All Implemented Interfaces:

TunnelStore, org.onosproject.store.Store<TunnelEvent,TunnelStoreDelegate>

@Service
public class DistributedTunnelStore
extends org.onosproject.store.AbstractStore<TunnelEvent,TunnelStoreDelegate>
implements TunnelStore

Manages inventory of tunnel in distributed data store that uses optimistic replication and gossip based techniques.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService	clusterCommunicator
protected org.onosproject.cluster.ClusterService	clusterService
protected org.onosproject.core.CoreService	coreService
protected org.onosproject.store.service.StorageService	storageService

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
DistributedTunnelStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
java.util.Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId appId, TunnelEndPoint src, TunnelEndPoint dst, org.onosproject.net.Annotations... annotations) Returns all tunnels between source and destination.
java.util.Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId appId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, org.onosproject.net.Annotations... annotations) Returns all specified type tunnels between source and destination.
Tunnel	borrowTunnel(org.onosproject.core.ApplicationId appId, TunnelId tunnelId, org.onosproject.net.Annotations... annotations) Returns a specific tunnel.
java.util.Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId appId, TunnelName tunnelName, org.onosproject.net.Annotations... annotations) Returns a specific tunnel by tunnelName.
TunnelId	createOrUpdateTunnel(Tunnel tunnel) Creates or updates a tunnel.
TunnelId	createOrUpdateTunnel(Tunnel tunnel, Tunnel.State state) Creates a tunnel or updates a tunnel with the new state given in input.
void	deactivate()
void	deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst, org.onosproject.net.provider.ProviderId producerName) Deletes all tunnels between source point and destination point.
void	deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, org.onosproject.net.provider.ProviderId producerName) Deletes all specific type tunnels between source point and destination point.
void	deleteTunnel(TunnelId tunnelId) Deletes a tunnel by a specific tunnel identifier.
java.util.Collection<Tunnel>	queryAllTunnels() Returns all tunnels.
java.util.Collection<Tunnel>	queryTunnel(Tunnel.Type type) Returns all specified type tunnels.
java.util.Collection<Tunnel>	queryTunnel(TunnelEndPoint src, TunnelEndPoint dst) Returns all tunnels between source point and destination point.
Tunnel	queryTunnel(TunnelId tunnelId) Returns a tunnel by a specific tunnel identity.
java.util.Collection<TunnelSubscription>	queryTunnelSubscription(org.onosproject.core.ApplicationId appId) Returns all tunnel subscription record by consumer.
boolean	returnTunnel(org.onosproject.core.ApplicationId appId, TunnelEndPoint src, TunnelEndPoint dst, org.onosproject.net.Annotations... annotations) Returns all tunnels between source and destination back the store.
boolean	returnTunnel(org.onosproject.core.ApplicationId appId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, org.onosproject.net.Annotations... annotations) Returns all specific type tunnels between source and destination back store.
boolean	returnTunnel(org.onosproject.core.ApplicationId appId, TunnelId tunnelId, org.onosproject.net.Annotations... annotations) Returns back a specific tunnel to store.
boolean	returnTunnel(org.onosproject.core.ApplicationId appId, TunnelName tunnelName, org.onosproject.net.Annotations... annotations) Returns all specific name tunnel back store.
int	tunnelCount() Returns all tunnels.

Methods inherited from class org.onosproject.store.AbstractStore

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.store.Store

hasDelegate, setDelegate, unsetDelegate

Field Detail

clusterCommunicator

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService clusterCommunicator

clusterService

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

coreService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.core.CoreService coreService

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

Constructor Detail

DistributedTunnelStore

public DistributedTunnelStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

createOrUpdateTunnel

public TunnelId createOrUpdateTunnel(Tunnel tunnel)

Description copied from interface: TunnelStore

Creates or updates a tunnel.

Specified by:

createOrUpdateTunnel in interface TunnelStore

Parameters:

tunnel - tunnel

Returns:

tunnel identity

createOrUpdateTunnel

public TunnelId createOrUpdateTunnel(Tunnel tunnel,
                                     Tunnel.State state)

Description copied from interface: TunnelStore

Creates a tunnel or updates a tunnel with the new state given in input.

Specified by:

createOrUpdateTunnel in interface TunnelStore

Parameters:

tunnel - tunnel

state - tunnel state

Returns:

tunnel identity

deleteTunnel

public void deleteTunnel(TunnelId tunnelId)

Description copied from interface: TunnelStore

Deletes a tunnel by a specific tunnel identifier.

Specified by:

deleteTunnel in interface TunnelStore

Parameters:

tunnelId - tunnel unique identifier generated by ONOS

deleteTunnel

public void deleteTunnel(TunnelEndPoint src,
                         TunnelEndPoint dst,
                         org.onosproject.net.provider.ProviderId producerName)

Description copied from interface: TunnelStore

Deletes all tunnels between source point and destination point.

Specified by:

deleteTunnel in interface TunnelStore

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

producerName - producerName

deleteTunnel

public void deleteTunnel(TunnelEndPoint src,
                         TunnelEndPoint dst,
                         Tunnel.Type type,
                         org.onosproject.net.provider.ProviderId producerName)

Description copied from interface: TunnelStore

Deletes all specific type tunnels between source point and destination point.

Specified by:

deleteTunnel in interface TunnelStore

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

type - tunnel type

producerName - producerName

borrowTunnel

public Tunnel borrowTunnel(org.onosproject.core.ApplicationId appId,
                           TunnelId tunnelId,
                           org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns a specific tunnel. Annotations parameter is reserved. If there is no tunnel in the store, return a "null" object, and record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer actively.

Specified by:

borrowTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

tunnelId - tunnel identify generated by onos

annotations - parameter

Returns:

Tunnel subscribed tunnel

borrowTunnel

public java.util.Collection<Tunnel> borrowTunnel(org.onosproject.core.ApplicationId appId,
                                                 TunnelEndPoint src,
                                                 TunnelEndPoint dst,
                                                 org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns all tunnels between source and destination. Annotations parameter is reserved. If there is no any tunnel in the store, return a empty collection, and record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer actively. Otherwise ONOS core returns all the tunnels, consumer determined which one to use.

Specified by:

borrowTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel

annotations - parameter

Returns:

collection of subscribed Tunnels

borrowTunnel

public java.util.Collection<Tunnel> borrowTunnel(org.onosproject.core.ApplicationId appId,
                                                 TunnelEndPoint src,
                                                 TunnelEndPoint dst,
                                                 Tunnel.Type type,
                                                 org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns all specified type tunnels between source and destination. Annotations parameter is reserved. If there is no any tunnel in the store, return a empty collection, and record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer actively. Otherwise,ONOS core returns all available tunnels, consumer determined which one to use.

Specified by:

borrowTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel

type - tunnel type

annotations - Annotations

Returns:

collection of available Tunnels

borrowTunnel

public java.util.Collection<Tunnel> borrowTunnel(org.onosproject.core.ApplicationId appId,
                                                 TunnelName tunnelName,
                                                 org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns a specific tunnel by tunnelName. Annotations parameter is reserved. If there is no tunnel in the store, return a "null" object,and record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer actively.

Specified by:

borrowTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

tunnelName - tunnel name

annotations - parameter

Returns:

collection of subscribed Tunnels

returnTunnel

public boolean returnTunnel(org.onosproject.core.ApplicationId appId,
                            TunnelName tunnelName,
                            org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns all specific name tunnel back store. Annotations parameter is reserved.If there is no tunnel in the store, return a "null" object,and record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer actively.

Specified by:

returnTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

tunnelName - tunnel name

annotations - Annotations

Returns:

boolean

returnTunnel

public boolean returnTunnel(org.onosproject.core.ApplicationId appId,
                            TunnelId tunnelId,
                            org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns back a specific tunnel to store.

Specified by:

returnTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

tunnelId - tunnel identify generated by ONOS

annotations - Annotations

Returns:

success or fail

returnTunnel

public boolean returnTunnel(org.onosproject.core.ApplicationId appId,
                            TunnelEndPoint src,
                            TunnelEndPoint dst,
                            Tunnel.Type type,
                            org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns all specific type tunnels between source and destination back store. Annotations parameter is reserved.

Specified by:

returnTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel

type - tunnel type

annotations - Annotations

Returns:

success or fail

returnTunnel

public boolean returnTunnel(org.onosproject.core.ApplicationId appId,
                            TunnelEndPoint src,
                            TunnelEndPoint dst,
                            org.onosproject.net.Annotations... annotations)

Description copied from interface: TunnelStore

Returns all tunnels between source and destination back the store. Annotations parameter is reserved.

Specified by:

returnTunnel in interface TunnelStore

Parameters:

appId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel.

annotations - Annotations

Returns:

success or fail

queryTunnel

public Tunnel queryTunnel(TunnelId tunnelId)

Description copied from interface: TunnelStore

Returns a tunnel by a specific tunnel identity.

Specified by:

queryTunnel in interface TunnelStore

Parameters:

tunnelId - tunnel identify generated by tunnel producer

Returns:

Tunnel

queryTunnelSubscription

public java.util.Collection<TunnelSubscription> queryTunnelSubscription(org.onosproject.core.ApplicationId appId)

Description copied from interface: TunnelStore

Returns all tunnel subscription record by consumer.

Specified by:

queryTunnelSubscription in interface TunnelStore

Parameters:

appId - consumer identity

Returns:

Collection of TunnelSubscription

queryTunnel

public java.util.Collection<Tunnel> queryTunnel(Tunnel.Type type)

Description copied from interface: TunnelStore

Returns all specified type tunnels.

Specified by:

queryTunnel in interface TunnelStore

Parameters:

type - tunnel type

Returns:

Collection of tunnels

queryTunnel

public java.util.Collection<Tunnel> queryTunnel(TunnelEndPoint src,
                                                TunnelEndPoint dst)

Description copied from interface: TunnelStore

Returns all tunnels between source point and destination point.

Specified by:

queryTunnel in interface TunnelStore

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

Returns:

Collection of tunnels

queryAllTunnels

public java.util.Collection<Tunnel> queryAllTunnels()

Description copied from interface: TunnelStore

Returns all tunnels.

Specified by:

queryAllTunnels in interface TunnelStore

Returns:

Collection of tunnels

tunnelCount

public int tunnelCount()

Description copied from interface: TunnelStore

Returns all tunnels.

Specified by:

tunnelCount in interface TunnelStore

Returns:

all tunnels