Package org.onosproject.newoptical.api

Interface OpticalPathService

All Superinterfaces:

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

All Known Implementing Classes:

OpticalPathProvisioner

@Beta
public interface OpticalPathService
extends org.onosproject.event.ListenerService<OpticalPathEvent,OpticalPathListener>

Service to setup optical domain connectivity.

Method Summary

Modifier and Type	Method	Description
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.
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 interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

setupConnectivity

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.

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

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.

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

boolean removeConnectivity(OpticalConnectivityId id)

Removes connectivity with given ID.

Parameters:

id - ID of connectivity

Returns:

true if succeed. false if failed.

getPath

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

Returns path assigned to given ID.

Parameters:

id - ID of connectivity

Returns:

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

listConnectivity

java.util.Collection<OpticalConnectivity> listConnectivity()

Lists collection of known OpticalConnectivity.

Returns:

collection of OpticalConnectivity

listIntents

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

Lists intents generated from specified OpticalConnectivity.

Parameters:

id - OpticalConnectivity identifier

Returns:

set of Intent Key