org.onosproject.incubator.net.tunnel

Interface TunnelStore

All Superinterfaces:

Store<TunnelEvent,TunnelStoreDelegate>

@Beta
public interface TunnelStore
extends Store<TunnelEvent,TunnelStoreDelegate>

Manages inventory of tunnel; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Annotations... annotations) Returns all tunnels between source and destination.
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, Annotations... annotations) Returns all specified type tunnels between source and destination.
Tunnel	borrowTunnel(ApplicationId consumerId, TunnelId tunnelId, Annotations... annotations) Returns a specific tunnel.
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelName tunnelName, 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	deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst, ProviderId producerName) Deletes all tunnels between source point and destination point.
void	deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, 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(ApplicationId consumerId) Returns all tunnel subscription record by consumer.
boolean	returnTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Annotations... annotations) Returns all tunnels between source and destination back the store.
boolean	returnTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, Annotations... annotations) Returns all specific type tunnels between source and destination back store.
boolean	returnTunnel(ApplicationId consumerId, TunnelId tunnelId, Annotations... annotations) Returns back a specific tunnel to store.
boolean	returnTunnel(ApplicationId consumerId, TunnelName tunnelName, Annotations... annotations) Returns all specific name tunnel back store.
int	tunnelCount() Returns all tunnels.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

createOrUpdateTunnel

TunnelId createOrUpdateTunnel(Tunnel tunnel)

Creates or updates a tunnel.

Parameters:

tunnel - tunnel

Returns:

tunnel identity

createOrUpdateTunnel

TunnelId createOrUpdateTunnel(Tunnel tunnel,
                              Tunnel.State state)

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

Parameters:

tunnel - tunnel

state - tunnel state

Returns:

tunnel identity

deleteTunnel

void deleteTunnel(TunnelId tunnelId)

Deletes a tunnel by a specific tunnel identifier.

Parameters:

tunnelId - tunnel unique identifier generated by ONOS

deleteTunnel

void deleteTunnel(TunnelEndPoint src,
                  TunnelEndPoint dst,
                  ProviderId producerName)

Deletes all tunnels between source point and destination point.

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

producerName - producerName

deleteTunnel

void deleteTunnel(TunnelEndPoint src,
                  TunnelEndPoint dst,
                  Tunnel.Type type,
                  ProviderId producerName)

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

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

type - tunnel type

producerName - producerName

borrowTunnel

Tunnel borrowTunnel(ApplicationId consumerId,
                    TunnelId tunnelId,
                    Annotations... annotations)

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.

Parameters:

consumerId - a tunnel consumer

tunnelId - tunnel identify generated by onos

annotations - parameter

Returns:

Tunnel subscribed tunnel

borrowTunnel

java.util.Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
                                          TunnelName tunnelName,
                                          Annotations... annotations)

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.

Parameters:

consumerId - a tunnel consumer

tunnelName - tunnel name

annotations - parameter

Returns:

collection of subscribed Tunnels

borrowTunnel

java.util.Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
                                          TunnelEndPoint src,
                                          TunnelEndPoint dst,
                                          Annotations... annotations)

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.

Parameters:

consumerId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel

annotations - parameter

Returns:

collection of subscribed Tunnels

borrowTunnel

java.util.Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
                                          TunnelEndPoint src,
                                          TunnelEndPoint dst,
                                          Tunnel.Type type,
                                          Annotations... annotations)

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.

Parameters:

consumerId - 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

returnTunnel

boolean returnTunnel(ApplicationId consumerId,
                     TunnelId tunnelId,
                     Annotations... annotations)

Returns back a specific tunnel to store.

Parameters:

consumerId - a tunnel consumer

tunnelId - tunnel identify generated by ONOS

annotations - Annotations

Returns:

success or fail

returnTunnel

boolean returnTunnel(ApplicationId consumerId,
                     TunnelName tunnelName,
                     Annotations... annotations)

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.

Parameters:

consumerId - a tunnel consumer

tunnelName - tunnel name

annotations - Annotations

Returns:

boolean

returnTunnel

boolean returnTunnel(ApplicationId consumerId,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Tunnel.Type type,
                     Annotations... annotations)

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

Parameters:

consumerId - 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

boolean returnTunnel(ApplicationId consumerId,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Annotations... annotations)

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

Parameters:

consumerId - a tunnel consumer

src - a source point of tunnel.

dst - a destination point of tunnel.

annotations - Annotations

Returns:

success or fail

queryTunnel

Tunnel queryTunnel(TunnelId tunnelId)

Returns a tunnel by a specific tunnel identity.

Parameters:

tunnelId - tunnel identify generated by tunnel producer

Returns:

Tunnel

queryTunnelSubscription

java.util.Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId consumerId)

Returns all tunnel subscription record by consumer.

Parameters:

consumerId - consumer identity

Returns:

Collection of TunnelSubscription

queryTunnel

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

Returns all specified type tunnels.

Parameters:

type - tunnel type

Returns:

Collection of tunnels

queryTunnel

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

Returns all tunnels between source point and destination point.

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

Returns:

Collection of tunnels

queryAllTunnels

java.util.Collection<Tunnel> queryAllTunnels()

Returns all tunnels.

Returns:

Collection of tunnels

tunnelCount

int tunnelCount()

Returns all tunnels.

Returns:

all tunnels