org.onosproject.incubator.net.tunnel.impl

Class TunnelManager

java.lang.Object

org.onosproject.net.provider.AbstractProviderRegistry<P,S>

org.onosproject.net.provider.AbstractListenerProviderRegistry<TunnelEvent,TunnelListener,TunnelProvider,TunnelProviderService>

org.onosproject.incubator.net.tunnel.impl.TunnelManager

All Implemented Interfaces:

org.onosproject.event.ListenerService<TunnelEvent,TunnelListener>, TunnelAdminService, TunnelProviderRegistry, TunnelService, org.onosproject.net.provider.ProviderRegistry<TunnelProvider,TunnelProviderService>

@Service
public class TunnelManager
extends org.onosproject.net.provider.AbstractListenerProviderRegistry<TunnelEvent,TunnelListener,TunnelProvider,TunnelProviderService>
implements TunnelService, TunnelAdminService, TunnelProviderRegistry

Provides implementation of the tunnel NB/SB APIs.

Field Summary

Fields

Modifier and Type	Field and Description
protected TunnelStore	store

Fields inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

eventDispatcher, listenerRegistry

Constructor Summary

Constructors

Constructor and Description
TunnelManager()

Method Summary

Modifier and Type	Method and Description
void	activate()
Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, org.onosproject.net.Annotations... annotations) Borrows all tunnels between source and destination.
Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, org.onosproject.net.Annotations... annotations) Borrows all specified type tunnels between source and destination.
Tunnel	borrowTunnel(org.onosproject.core.ApplicationId consumerId, TunnelId tunnelId, org.onosproject.net.Annotations... annotations) Borrows a specific tunnel.
Collection<Tunnel>	borrowTunnel(org.onosproject.core.ApplicationId consumerId, TunnelName tunnelName, org.onosproject.net.Annotations... annotations) Borrows a specific tunnel by tunnelName.
protected TunnelProviderService	createProviderService(TunnelProvider provider)
void	deactivate()
boolean	downTunnel(org.onosproject.core.ApplicationId producerId, TunnelId tunnelId) Triggers removal of specified tunnel.
Iterable<Tunnel>	getTunnels(org.onosproject.net.DeviceId deviceId) Returns the collection of tunnels applied on the specified device.
Collection<Tunnel>	queryAllTunnels() Returns all tunnels.
Collection<Tunnel>	queryTunnel(Tunnel.Type type) Returns all specified type tunnels.
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.
Collection<TunnelSubscription>	queryTunnelSubscription(org.onosproject.core.ApplicationId consumerId) Returns all tunnel subscription record by consumer.
void	removeTunnel(TunnelId tunnelId) Removes the provisioned tunnel.
void	removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, org.onosproject.net.provider.ProviderId producerName) Removes the provisioned tunnel leading to and from the specified labels.
void	removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, org.onosproject.net.provider.ProviderId producerName) Removes all provisioned tunnels leading to and from the specified connection point.
boolean	returnTunnel(org.onosproject.core.ApplicationId consumerId, 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 consumerId, 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 consumerId, TunnelId tunnelId, org.onosproject.net.Annotations... annotations) Returns back a specific tunnel to store.
boolean	returnTunnel(org.onosproject.core.ApplicationId consumerId, TunnelName tunnelName, org.onosproject.net.Annotations... annotations) Returns all specific name tunnel back store.
TunnelId	setupTunnel(org.onosproject.core.ApplicationId producerId, org.onosproject.net.ElementId srcElementId, Tunnel tunnel, org.onosproject.net.Path path) Creates a tunnel with given path and default initial state.
int	tunnelCount() Returns all tunnels.
void	updateTunnel(Tunnel tunnel, org.onosproject.net.Path path) Invokes the core to update a tunnel based on specified tunnel parameters.
void	updateTunnelState(Tunnel tunnel, Tunnel.State state) Updates the state of a tunnel.

Methods inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

addListener, bindEventDispatcher, post, removeListener, unbindEventDispatcher

Methods inherited from class org.onosproject.net.provider.AbstractProviderRegistry

defaultProvider, getProvider, getProvider, getProvider, getProviders, register, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Methods inherited from interface org.onosproject.net.provider.ProviderRegistry

getProviders, register, unregister

Field Detail

store

@Reference(cardinality=MANDATORY_UNARY)
protected TunnelStore store

Constructor Detail

TunnelManager

public TunnelManager()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

removeTunnel

public void removeTunnel(TunnelId tunnelId)

Description copied from interface: TunnelAdminService

Removes the provisioned tunnel.

Specified by:

removeTunnel in interface TunnelAdminService

Parameters:

tunnelId - tunnel ID

updateTunnel

public void updateTunnel(Tunnel tunnel,
                         org.onosproject.net.Path path)

Description copied from interface: TunnelAdminService

Invokes the core to update a tunnel based on specified tunnel parameters.

Specified by:

updateTunnel in interface TunnelAdminService

Parameters:

tunnel - Tunnel

path - explicit route (path changed) or null (path not changed) for the tunnel

updateTunnelState

public void updateTunnelState(Tunnel tunnel,
                              Tunnel.State state)

Description copied from interface: TunnelAdminService

Updates the state of a tunnel.

Specified by:

updateTunnelState in interface TunnelAdminService

Parameters:

tunnel - tunnel to be changed

state - new state of the tunnel

removeTunnels

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

Description copied from interface: TunnelAdminService

Removes the provisioned tunnel leading to and from the specified labels.

Specified by:

removeTunnels in interface TunnelAdminService

Parameters:

src - source label

dst - destination label

producerName - producer name

removeTunnels

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

Description copied from interface: TunnelAdminService

Removes all provisioned tunnels leading to and from the specified connection point.

Specified by:

removeTunnels in interface TunnelAdminService

Parameters:

src - source connection point

dst - destination connection point

type - tunnel type

producerName - producer name

borrowTunnel

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

Description copied from interface: TunnelService

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.

Specified by:

borrowTunnel in interface TunnelService

Parameters:

consumerId - a tunnel consumer

tunnelId - tunnel identify generated by onos

annotations - Annotations

Returns:

Tunnel subscribed tunnel

borrowTunnel

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

Description copied from interface: TunnelService

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.

Specified by:

borrowTunnel in interface TunnelService

Parameters:

consumerId - a tunnel consumer

tunnelName - tunnel name

annotations - Annotations

Returns:

collection of subscribed Tunnels

borrowTunnel

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

Description copied from interface: TunnelService

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.

Specified by:

borrowTunnel in interface TunnelService

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

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

Description copied from interface: TunnelService

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.

Specified by:

borrowTunnel in interface TunnelService

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

public TunnelId setupTunnel(org.onosproject.core.ApplicationId producerId,
                            org.onosproject.net.ElementId srcElementId,
                            Tunnel tunnel,
                            org.onosproject.net.Path path)

Description copied from interface: TunnelService

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.

Specified by:

setupTunnel in interface TunnelService

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

public boolean downTunnel(org.onosproject.core.ApplicationId producerId,
                          TunnelId tunnelId)

Description copied from interface: TunnelService

Triggers removal of specified tunnel.

Specified by:

downTunnel in interface TunnelService

Parameters:

producerId - a tunnel producer

tunnelId - identity for the tunnel to be triggered for removal

Returns:

success or failure

returnTunnel

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

Description copied from interface: TunnelService

Returns back a specific tunnel to store.

Specified by:

returnTunnel in interface TunnelService

Parameters:

consumerId - a tunnel consumer

tunnelId - tunnel identify generated by ONOS

annotations - Annotations

Returns:

success or fail

returnTunnel

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

Description copied from interface: TunnelService

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 TunnelService

Parameters:

consumerId - a tunnel consumer

tunnelName - tunnel name

annotations - Annotations

Returns:

boolean

returnTunnel

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

Description copied from interface: TunnelService

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

Specified by:

returnTunnel in interface TunnelService

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

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

Description copied from interface: TunnelService

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

Specified by:

returnTunnel in interface TunnelService

Parameters:

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

Returns a tunnel by a specific tunnel identity.

Specified by:

queryTunnel in interface TunnelService

Parameters:

tunnelId - tunnel identify generated by tunnel producer

Returns:

Tunnel

queryTunnelSubscription

public Collection<TunnelSubscription> queryTunnelSubscription(org.onosproject.core.ApplicationId consumerId)

Description copied from interface: TunnelService

Returns all tunnel subscription record by consumer.

Specified by:

queryTunnelSubscription in interface TunnelService

Parameters:

consumerId - consumer identity

Returns:

Collection of TunnelSubscription

queryTunnel

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

Description copied from interface: TunnelService

Returns all specified type tunnels.

Specified by:

queryTunnel in interface TunnelService

Parameters:

type - tunnel type

Returns:

Collection of tunnels

queryTunnel

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

Description copied from interface: TunnelService

Returns all tunnels between source point and destination point.

Specified by:

queryTunnel in interface TunnelService

Parameters:

src - a source point of tunnel.

dst - a destination point of tunnel.

Returns:

Collection of tunnels

queryAllTunnels

public Collection<Tunnel> queryAllTunnels()

Description copied from interface: TunnelService

Returns all tunnels.

Specified by:

queryAllTunnels in interface TunnelService

Returns:

Collection of tunnels

tunnelCount

public int tunnelCount()

Description copied from interface: TunnelService

Returns all tunnels.

Specified by:

tunnelCount in interface TunnelService

Returns:

all tunnels

createProviderService

protected TunnelProviderService createProviderService(TunnelProvider provider)

Specified by:

createProviderService in class org.onosproject.net.provider.AbstractProviderRegistry<TunnelProvider,TunnelProviderService>

getTunnels

public Iterable<Tunnel> getTunnels(org.onosproject.net.DeviceId deviceId)

Description copied from interface: TunnelService

Returns the collection of tunnels applied on the specified device.

Specified by:

getTunnels in interface TunnelService

Parameters:

deviceId - device identifier

Returns:

collection of tunnels