org.onosproject.provider.pcep.tunnel.impl

Class PcepTunnelProvider

java.lang.Object

org.onosproject.net.provider.AbstractProvider

org.onosproject.provider.pcep.tunnel.impl.PcepTunnelProvider

All Implemented Interfaces:

TunnelProvider, org.onosproject.net.provider.Provider

@Service
public class PcepTunnelProvider
extends org.onosproject.net.provider.AbstractProvider
implements TunnelProvider

Provider which uses an PCEP controller to detect, update, create network tunnels.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.cfg.ComponentConfigService	cfgService
protected PcepController	controller
protected org.onosproject.net.device.DeviceService	deviceService
static long	IDENTIFIER_SET
protected org.onosproject.net.link.LinkService	linkService
static String	LSRID
protected org.onosproject.mastership.MastershipService	mastershipService
protected PcepClientController	pcepClientController
protected PcepTunnelApiMapper	pcepTunnelApiMapper
static long	SET
protected TunnelAdminService	tunnelAdminService
protected TunnelProviderRegistry	tunnelProviderRegistry
protected TunnelService	tunnelService

Constructor Summary

Constructors

Constructor and Description
PcepTunnelProvider() Creates a Tunnel provider.

Method Summary

Modifier and Type	Method and Description
void	activate()
void	deactivate()
void	modified(org.osgi.service.component.ComponentContext context)
String	pathToString(List<org.onosproject.net.Link> links)
void	releaseTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel) Instructs the provider to release a tunnel given the respective device.
void	releaseTunnel(Tunnel tunnel) Instructs the provider to release a tunnel.
void	setupTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to setup a tunnel given the respective device.
void	setupTunnel(Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to setup a tunnel.
TunnelId	tunnelAdded(TunnelDescription tunnel) Signals that the provider has added a tunnel.
TunnelId	tunnelAdded(TunnelDescription tunnel, Tunnel.State tunnelState)
Tunnel	tunnelQueryById(TunnelId tunnelId) Signals that the a tunnel was queried.
void	tunnelRemoved(TunnelDescription tunnel) Signals that the provider has removed a tunnel.
void	tunnelUpdated(TunnelDescription tunnel) Signals that the a tunnel was changed (e.g., sensing changes of tunnel).It's used by producers.
void	tunnelUpdated(TunnelDescription tunnel, Tunnel.State tunnelState)
void	updateTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to update a tunnel given the respective device.
void	updateTunnel(Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to update a tunnel.

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

id

Methods inherited from class java.lang.Object

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

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

id

Field Detail

IDENTIFIER_SET

public static final long IDENTIFIER_SET

See Also:

Constant Field Values

SET

public static final long SET

See Also:

Constant Field Values

LSRID

public static final String LSRID

See Also:

Constant Field Values

tunnelProviderRegistry

@Reference(cardinality=MANDATORY_UNARY)
protected TunnelProviderRegistry tunnelProviderRegistry

controller

@Reference(cardinality=MANDATORY_UNARY)
protected PcepController controller

pcepClientController

@Reference(cardinality=MANDATORY_UNARY)
protected PcepClientController pcepClientController

tunnelService

@Reference(cardinality=MANDATORY_UNARY)
protected TunnelService tunnelService

cfgService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cfg.ComponentConfigService cfgService

tunnelAdminService

@Reference(cardinality=MANDATORY_UNARY)
protected TunnelAdminService tunnelAdminService

mastershipService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.mastership.MastershipService mastershipService

deviceService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.device.DeviceService deviceService

linkService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.link.LinkService linkService

pcepTunnelApiMapper

protected PcepTunnelApiMapper pcepTunnelApiMapper

Constructor Detail

PcepTunnelProvider

public PcepTunnelProvider()

Creates a Tunnel provider.

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

modified

public void modified(org.osgi.service.component.ComponentContext context)

setupTunnel

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

Description copied from interface: TunnelProvider

Instructs the provider to setup a tunnel. It's used by consumers.

Specified by:

setupTunnel in interface TunnelProvider

Parameters:

tunnel - Tunnel

path - explicit route or null for the tunnel

setupTunnel

public void setupTunnel(org.onosproject.net.ElementId srcElement,
                        Tunnel tunnel,
                        org.onosproject.net.Path path)

Description copied from interface: TunnelProvider

Instructs the provider to setup a tunnel given the respective device. It's used by consumers.

Specified by:

setupTunnel in interface TunnelProvider

Parameters:

srcElement - device

tunnel - Tunnel

path - explicit route (not null) for the tunnel

releaseTunnel

public void releaseTunnel(Tunnel tunnel)

Description copied from interface: TunnelProvider

Instructs the provider to release a tunnel. It's used by consumers.

Specified by:

releaseTunnel in interface TunnelProvider

Parameters:

tunnel - Tunnel

releaseTunnel

public void releaseTunnel(org.onosproject.net.ElementId srcElement,
                          Tunnel tunnel)

Description copied from interface: TunnelProvider

Instructs the provider to release a tunnel given the respective device. It's used by consumers.

Specified by:

releaseTunnel in interface TunnelProvider

Parameters:

srcElement - device

tunnel - Tunnel

updateTunnel

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

Description copied from interface: TunnelProvider

Instructs the provider to update a tunnel. It's used by consumers. Maybe some consumers enable to update a tunnel.

Specified by:

updateTunnel in interface TunnelProvider

Parameters:

tunnel - Tunnel

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

updateTunnel

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

Description copied from interface: TunnelProvider

Instructs the provider to update a tunnel given the respective device. It's used by consumers. Maybe some consumers enable to update a tunnel.

Specified by:

updateTunnel in interface TunnelProvider

Parameters:

srcElement - device

tunnel - Tunnel

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

tunnelAdded

public TunnelId tunnelAdded(TunnelDescription tunnel)

Description copied from interface: TunnelProvider

Signals that the provider has added a tunnel. It's used by producers.

Specified by:

tunnelAdded in interface TunnelProvider

Parameters:

tunnel - tunnel information

Returns:

tunnel identity

tunnelAdded

public TunnelId tunnelAdded(TunnelDescription tunnel,
                            Tunnel.State tunnelState)

tunnelRemoved

public void tunnelRemoved(TunnelDescription tunnel)

Description copied from interface: TunnelProvider

Signals that the provider has removed a tunnel. It's used by producers.

Specified by:

tunnelRemoved in interface TunnelProvider

Parameters:

tunnel - tunnel information

tunnelUpdated

public void tunnelUpdated(TunnelDescription tunnel)

Description copied from interface: TunnelProvider

Signals that the a tunnel was changed (e.g., sensing changes of tunnel).It's used by producers.

Specified by:

tunnelUpdated in interface TunnelProvider

Parameters:

tunnel - tunnel information

tunnelUpdated

public void tunnelUpdated(TunnelDescription tunnel,
                          Tunnel.State tunnelState)

pathToString

public String pathToString(List<org.onosproject.net.Link> links)

tunnelQueryById

public Tunnel tunnelQueryById(TunnelId tunnelId)

Description copied from interface: TunnelProvider

Signals that the a tunnel was queried. It's used by producers.

Specified by:

tunnelQueryById in interface TunnelProvider

Parameters:

tunnelId - tunnel identity

Returns:

tunnel entity