org.onosproject.incubator.net.tunnel

Interface TunnelService

All Superinterfaces:

ListenerService<TunnelEvent,TunnelListener>

@Beta
public interface TunnelService
extends ListenerService<TunnelEvent,TunnelListener>

Service for interacting with the inventory of tunnels.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Annotations... annotations) Borrows all tunnels between source and destination.
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, Annotations... annotations) Borrows all specified type tunnels between source and destination.
Tunnel	borrowTunnel(ApplicationId consumerId, TunnelId tunnelId, Annotations... annotations) Borrows a specific tunnel.
java.util.Collection<Tunnel>	borrowTunnel(ApplicationId consumerId, TunnelName tunnelName, Annotations... annotations) Borrows a specific tunnel by tunnelName.
boolean	downTunnel(ApplicationId producerId, TunnelId tunnelId) Triggers removal of specified tunnel.
java.lang.Iterable<Tunnel>	getTunnels(DeviceId deviceId) Returns the collection of tunnels applied on the specified device.
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.
TunnelId	setupTunnel(ApplicationId producerId, ElementId srcElementId, Tunnel tunnel, Path path) Creates a tunnel with given path and default initial state.
int	tunnelCount() Returns all tunnels.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

borrowTunnel

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

Borrows a specific tunnel. Annotations parameter is reserved.If there is no tunnel in the store, returns 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 - Annotations

Returns:

Tunnel subscribed tunnel

borrowTunnel

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

Borrows 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 - Annotations

Returns:

collection of subscribed Tunnels

borrowTunnel

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

Borrows 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 - Annotations

Returns:

collection of subscribed Tunnels

borrowTunnel

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

Borrows 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

setupTunnel

TunnelId setupTunnel(ApplicationId producerId,
                     ElementId srcElementId,
                     Tunnel tunnel,
                     Path path)

Creates a tunnel with given path and default initial state. The state changes in due course of time based on changes happening in the network.

Parameters:

producerId - a tunnel producer

srcElementId - element id of the source

tunnel - to be created

path - path of the tunnel

Returns:

generated tunnel identity

downTunnel

boolean downTunnel(ApplicationId producerId,
                   TunnelId tunnelId)

Triggers removal of specified tunnel.

Parameters:

producerId - a tunnel producer

tunnelId - identity for the tunnel to be triggered for removal

Returns:

success or failure

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

getTunnels

java.lang.Iterable<Tunnel> getTunnels(DeviceId deviceId)

Returns the collection of tunnels applied on the specified device.

Parameters:

deviceId - device identifier

Returns:

collection of tunnels