Package org.onosproject.newoptical

Class OpticalPathProvisioner

java.lang.Object

org.onosproject.event.AbstractListenerManager<OpticalPathEvent,OpticalPathListener>

org.onosproject.newoptical.OpticalPathProvisioner

All Implemented Interfaces:

org.onosproject.event.ListenerService<OpticalPathEvent,OpticalPathListener>, OpticalPathService

@Beta
public class OpticalPathProvisioner
extends org.onosproject.event.AbstractListenerManager<OpticalPathEvent,OpticalPathListener>
implements OpticalPathService

Main component to configure optical connectivity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OpticalPathProvisioner.InternalIntentListener

Field Summary

Fields

Modifier and Type	Field	Description
protected org.onosproject.cluster.ClusterService	clusterService
protected org.onosproject.core.CoreService	coreService
protected org.onosproject.net.device.DeviceService	deviceService
protected org.onosproject.net.intent.IntentService	intentService
protected org.onosproject.net.link.LinkService	linkService
protected org.onosproject.mastership.MastershipService	mastershipService
protected org.onosproject.net.config.NetworkConfigService	networkConfigService
protected org.onosproject.net.resource.ResourceService	resourceService
protected org.onosproject.store.service.StorageService	storageService
protected org.onosproject.net.topology.TopologyService	topologyService

Fields inherited from class org.onosproject.event.AbstractListenerManager

eventDispatcher, listenerRegistry

Constructor Summary

Constructors

Constructor	Description
OpticalPathProvisioner()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext context)
protected void	deactivate()
java.util.Optional<java.util.List<org.onosproject.net.Link>>	getPath(OpticalConnectivityId id)	Returns path assigned to given ID.
java.util.Collection<OpticalConnectivity>	listConnectivity()	Lists collection of known OpticalConnectivity.
java.util.Set<org.onosproject.net.intent.Key>	listIntents(OpticalConnectivityId id)	Lists intents generated from specified OpticalConnectivity.
void	modified(org.osgi.service.component.ComponentContext context)
boolean	removeConnectivity(OpticalConnectivityId id)	Removes connectivity with given ID.
OpticalConnectivityId	setupConnectivity(org.onosproject.net.ConnectPoint ingress, org.onosproject.net.ConnectPoint egress, org.onlab.util.Bandwidth bandwidth, java.time.Duration latency)	Calculates multi-layer path between connect points and sets up connectivity.
OpticalConnectivityId	setupPath(org.onosproject.net.Path path, org.onlab.util.Bandwidth bandwidth, java.time.Duration latency)	Sets up connectivity along given multi-layer path including cross-connect links.

Methods inherited from class org.onosproject.event.AbstractListenerManager

addListener, post, removeListener

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

Field Detail

intentService

protected org.onosproject.net.intent.IntentService intentService

topologyService

protected org.onosproject.net.topology.TopologyService topologyService

coreService

protected org.onosproject.core.CoreService coreService

linkService

protected org.onosproject.net.link.LinkService linkService

mastershipService

protected org.onosproject.mastership.MastershipService mastershipService

clusterService

protected org.onosproject.cluster.ClusterService clusterService

deviceService

protected org.onosproject.net.device.DeviceService deviceService

storageService

protected org.onosproject.store.service.StorageService storageService

networkConfigService

protected org.onosproject.net.config.NetworkConfigService networkConfigService

resourceService

protected org.onosproject.net.resource.ResourceService resourceService

Constructor Detail

OpticalPathProvisioner

public OpticalPathProvisioner()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

deactivate

protected void deactivate()

modified

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

listConnectivity

public java.util.Collection<OpticalConnectivity> listConnectivity()

Description copied from interface: OpticalPathService

Lists collection of known OpticalConnectivity.

Specified by:

listConnectivity in interface OpticalPathService

Returns:

collection of OpticalConnectivity

listIntents

public java.util.Set<org.onosproject.net.intent.Key> listIntents(OpticalConnectivityId id)

Description copied from interface: OpticalPathService

Lists intents generated from specified OpticalConnectivity.

Specified by:

listIntents in interface OpticalPathService

Parameters:

id - OpticalConnectivity identifier

Returns:

set of Intent Key

setupConnectivity

public OpticalConnectivityId setupConnectivity(org.onosproject.net.ConnectPoint ingress,
                                               org.onosproject.net.ConnectPoint egress,
                                               org.onlab.util.Bandwidth bandwidth,
                                               java.time.Duration latency)

Description copied from interface: OpticalPathService

Calculates multi-layer path between connect points and sets up connectivity.

Specified by:

setupConnectivity in interface OpticalPathService

Parameters:

ingress - ingress port

egress - egress port

bandwidth - required bandwidth. No bandwidth is assured if null.

latency - required latency. No latency is assured if null.

Returns:

id of created connectivity if successful, null otherwise.

setupPath

public OpticalConnectivityId setupPath(org.onosproject.net.Path path,
                                       org.onlab.util.Bandwidth bandwidth,
                                       java.time.Duration latency)

Description copied from interface: OpticalPathService

Sets up connectivity along given multi-layer path including cross-connect links.

Specified by:

setupPath in interface OpticalPathService

Parameters:

path - multi-layer path along which connectivity will be set up

bandwidth - required bandwidth. No bandwidth is assured if null.

latency - required latency. No latency is assured if null.

Returns:

id of created connectivity if successful, null otherwise.

removeConnectivity

public boolean removeConnectivity(OpticalConnectivityId id)

Description copied from interface: OpticalPathService

Removes connectivity with given ID.

Specified by:

removeConnectivity in interface OpticalPathService

Parameters:

id - ID of connectivity

Returns:

true if succeed. false if failed.

getPath

public java.util.Optional<java.util.List<org.onosproject.net.Link>> getPath(OpticalConnectivityId id)

Description copied from interface: OpticalPathService

Returns path assigned to given ID.

Specified by:

getPath in interface OpticalPathService

Parameters:

id - ID of connectivity

Returns:

list of link that compose a path. empty if ID is invalid.