com.net2plan.research.niw.networkModel

Class WNet

java.lang.Object

com.net2plan.research.niw.networkModel.WAbstractNetworkElement

com.net2plan.research.niw.networkModel.WNet

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>

public class WNet
extends WAbstractNetworkElement

This class represents an IP over WDM network with potential VNF placement. This is the main model class, that gives access to the key methods to play with the network

Constructor Summary

Constructors

Constructor and Description
WNet(NetPlan np)

Method Summary

Modifier and Type	Method and Description
Pair<WFiber,WFiber>	addFiber(WNode a, WNode b, List<Integer> validOpticalSlotRanges, double lengthInKm, boolean isBidirectional) Adds a fiber to the design
Pair<WIpLink,WIpLink>	addIpLink(WNode a, WNode b, double nominalLineRateGbps, boolean isBidirectional) Adds an IP link to the network
WLightpathRequest	addLightpathRequest(WNode a, WNode b, double lineRateGbps, boolean isToBe11Protected) Adds a lightpath request to the design
WNode	addNode(double xCoord, double yCoord, String name, String type) Adds a node to the design
void	addOrUpdateUserService(WUserService info) Adds or updates a user service to the defined repository of user services
void	addOrUpdateVnfType(WVnfType info) Adds a new VNF type to the network, with the provided information
WServiceChainRequest	addServiceChainRequest(WNode userInjectionNode, boolean isUpstream, WUserService userService) Adds a request for an upstream or downstream unidirectional service chain, for the given user service.
WVnfInstance	addVnfInstance(WNode hostNode, String name, WVnfType type) Adds an instance of the VNF of the given type, in the indicated host node, applying it the given name
static WNet	createEmptyDesign() Creates an empty design with no nodes, links etc.
List<WFiber>	getFibers() Returns the list of fibers, in increasing order according to its id
WLayerIp	getIpLayer() Returns the object identifying the IP layer
List<WIpLink>	getIpLinks() Returns the list of IP links, in increasing order according to its id
List<List<? extends WAbstractNetworkElement>>	getKShortestServiceChainInIpLayer(int k, WNode a, WNode b, List<String> sequenceOfVnfTypesToTraverse, Optional<Map<WIpLink,Double>> optionalCostMapOrElseLatency, Optional<Map<WVnfInstance,Double>> optionalVnfCostMapOrElseLatency) Returns a ranking with the k-shortest paths for service chains, given the end nodes, and the sequence of types of VNFs that it should traverse.
List<List<WFiber>>	getKShortestWdmPath(int k, WNode a, WNode b, Optional<Map<WFiber,Double>> optionalCostMapOrElseLatency) Returns a ranking with the k-shortest paths composed as a sequence of WFiber links in the network, given the origin and end nodes of the paths.
List<WLightpathRequest>	getLightpathRequests() Returns the list of lightpath requests, in increasing order according to its id
List<WLightpathUnregenerated>	getLightpaths() Returns the list of lightpaths, in increasing order according to its id
NetPlan	getNe() Returns the underlying Net2Plan object.
Optional<WNode>	getNodeByName(String name) Returns the network node with the indicated name, if any
List<WNode>	getNodes() Returns the list of network nodes, in increasing order according to its id
SortedSet<WNode>	getNodesConnectedToCore() Returns the nodes in the network that are supposed to have a connection to the network core (the core nodes and those connecting links are not part of the network)
List<WServiceChainRequest>	getServiceChainRequests() Returns the list of service chain requests, in increasing order according to its id
List<WServiceChain>	getServiceChains() Returns the list of service chains, in increasing order according to its id
SortedSet<String>	getUserServiceNames() Returns all the unique ids (names) of the user services defined
SortedMap<String,WUserService>	getUserServicesInfo() Returns the user service information defined, in a map with key the user service identifier, and value the user service object
SortedSet<WVnfInstance>	getVnfInstances() Returns a set with all the VNF instances in the network of any type
SortedSet<WVnfInstance>	getVnfInstances(String type) Returns a set with all the VNF instances in the network of the given type
Optional<WVnfType>	getVnfType(String typeName) Returns the WVnfType object assigned to that name, if any
SortedSet<String>	getVnfTypeNames() Returns the set of VNF type names defined
List<WVnfType>	getVnfTypes() Returns the map associating the VNF type, with the associated VNF object, as was defined by the user
WLayerWdm	getWdmLayer() Returns the object identifying the WDM layer
boolean	isDeepCopy(WNet other) Indicates if a network is an exact copy of other network in every aspect
static WNet	loadFromFile(File f) Creates a design, loading it from a file
void	removeUserServiceInfo(String userServiceName) Removes a user service definition from the internal repo
void	removeVnfType(String vnfTypeName) Removes a defined VNF type
void	saveToFile(File f) Saves this network in the given file
void	setUserServicesInfo(SortedMap<String,WUserService> newInfo) Sets a new user service id to info map, removing all previous user services defined
void	setVnfTypesRemovingPreviousInfo(SortedSet<WVnfType> newInfo) Sets a new VNF type map, removing all previous VNF types defined
String	toString()

Methods inherited from class com.net2plan.research.niw.networkModel.WAbstractNetworkElement

compareTo, equals, getAsFiber, getAsIpLayer, getAsIpLink, getAsLightpathRequest, getAsLightpathUnregenerated, getAsNode, getAsServiceChain, getAsServiceChainRequest, getAsVnfInstance, getAsWdmLayer, getId, getNet, getNetPlan, isFiber, isLayerIp, isLayerWdm, isLightpathRequest, isLightpathUnregenerated, isNode, isServiceChain, isServiceChainRequest, isVnfInstance, isWIpLink, wasRemoved

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WNet

public WNet(NetPlan np)

Method Detail

addFiber

public Pair<WFiber,WFiber> addFiber(WNode a,
                                    WNode b,
                                    List<Integer> validOpticalSlotRanges,
                                    double lengthInKm,
                                    boolean isBidirectional)

Adds a fiber to the design

Parameters:

a - the origin node

b - the destination node

validOpticalSlotRanges - the pairs (init slot , end slot) with the valid optical slot ranges for the fiber

lengthInKm - the user-defined length in km. If negative, the harversine distance is set for the link length, that considers node (x,y) coordinates a longitude-latitude pairs

isBidirectional - indicates if the fiber to add is bidirectional

Returns:

the first element of the pair is the fiber a- b, the second is b-a or null in non-bidirectional cases

addIpLink

public Pair<WIpLink,WIpLink> addIpLink(WNode a,
                                       WNode b,
                                       double nominalLineRateGbps,
                                       boolean isBidirectional)

Adds an IP link to the network

Parameters:

a - The IP link origin node

b - The IP lin kend node

nominalLineRateGbps - The nominal line rate of the IP link in Gbps

isBidirectional - An indication if the IP link to add should be a pair of two unidirectional IP links in opposite directions

Returns:

the first element of the pair is the a-b IP link, the second is the b-a IP link or null if not bidirectional IP link is requested

addLightpathRequest

public WLightpathRequest addLightpathRequest(WNode a,
                                             WNode b,
                                             double lineRateGbps,
                                             boolean isToBe11Protected)

Adds a lightpath request to the design

Parameters:

a - The origin node of the lightpath request

b - The destination node of the lightpath request

lineRateGbps - The nominal line rate in Gbps

isToBe11Protected - indicates if it is requested to have a 1+1 setting assigned to this lightpath

Returns:

the lightpath request created

addNode

public WNode addNode(double xCoord,
                     double yCoord,
                     String name,
                     String type)

Adds a node to the design

Parameters:

xCoord - the x coordinate

yCoord - the y coordinate

name - the node name, that should be unique

type - the type of node: a user-defined string

Returns:

see above

addOrUpdateUserService

public void addOrUpdateUserService(WUserService info)

Adds or updates a user service to the defined repository of user services

Parameters:

info - see above

addOrUpdateVnfType

public void addOrUpdateVnfType(WVnfType info)

Adds a new VNF type to the network, with the provided information

Parameters:

info - see above

addServiceChainRequest

public WServiceChainRequest addServiceChainRequest(WNode userInjectionNode,
                                                   boolean isUpstream,
                                                   WUserService userService)

Adds a request for an upstream or downstream unidirectional service chain, for the given user service. The user service will define the sequence of VNF types that the flow must traverse, and will indicate the set of potential end nodes (for upstream flows) or potential initial nodes (for downstream flows).

Parameters:

userInjectionNode - the node where the traffic starts (in upstream flows) or ends (in downstream flows)

isUpstream - if true, the flow is supposed to start in the injection node, if false, the flow is supposed to end in the injection node

userService - the user service defining this service chain request.

Returns:

see above

addVnfInstance

public WVnfInstance addVnfInstance(WNode hostNode,
                                   String name,
                                   WVnfType type)

Adds an instance of the VNF of the given type, in the indicated host node, applying it the given name

Parameters:

hostNode - see above

name - see above

type - see above

Returns:

the created instance

createEmptyDesign

public static WNet createEmptyDesign()

Creates an empty design with no nodes, links etc.

Returns:

see above

getFibers

public List<WFiber> getFibers()

Returns the list of fibers, in increasing order according to its id

Returns:

see above

getIpLayer

public WLayerIp getIpLayer()

Returns the object identifying the IP layer

Returns:

see above

getIpLinks

public List<WIpLink> getIpLinks()

Returns the list of IP links, in increasing order according to its id

Returns:

see above

getKShortestServiceChainInIpLayer

public List<List<? extends WAbstractNetworkElement>> getKShortestServiceChainInIpLayer(int k,
                                                                                       WNode a,
                                                                                       WNode b,
                                                                                       List<String> sequenceOfVnfTypesToTraverse,
                                                                                       Optional<Map<WIpLink,Double>> optionalCostMapOrElseLatency,
                                                                                       Optional<Map<WVnfInstance,Double>> optionalVnfCostMapOrElseLatency)

Returns a ranking with the k-shortest paths for service chains, given the end nodes, and the sequence of types of VNFs that it should traverse.

Parameters:

k - the maximum number of paths to return in the ranking

a - the origin node

b - the end node

sequenceOfVnfTypesToTraverse - the sequence of VNF types to be traversed, in the given order

optionalCostMapOrElseLatency - an optional map of the cost to assign to traversing each IP link, if none, the cost is assumed to the IP link latency

optionalVnfCostMapOrElseLatency - an optional map of the cost to assign to traverse each VNF instance, if none, the cost is assumed to be the VNF instance processing time

Returns:

a list of up to k paths, where each path is a sequence of WIpLink and WVnfInstance objects forming a service chain from a to b

getKShortestWdmPath

public List<List<WFiber>> getKShortestWdmPath(int k,
                                              WNode a,
                                              WNode b,
                                              Optional<Map<WFiber,Double>> optionalCostMapOrElseLatency)

Returns a ranking with the k-shortest paths composed as a sequence of WFiber links in the network, given the origin and end nodes of the paths.

Parameters:

k - the maximum number of paths to return in the ranking

a - the origin node

b - the end node

optionalCostMapOrElseLatency - an optional map of the cost to assign to traversing each WFiber link, if none, the cost is assumed to be the WFiber latency

Returns:

a list of up to k paths, where each path is a sequence of WFiber objects forming a path from a to b

getLightpathRequests

public List<WLightpathRequest> getLightpathRequests()

Returns the list of lightpath requests, in increasing order according to its id

Returns:

see above

getLightpaths

public List<WLightpathUnregenerated> getLightpaths()

Returns the list of lightpaths, in increasing order according to its id

Returns:

see above

getNe

public NetPlan getNe()

Description copied from class: WAbstractNetworkElement

Returns the underlying Net2Plan object. Users should NOT modify or even read this object, since all manipulations should be made through the provided methods in he library. This method is just provided for debugging for those users who really know what they are doing

Specified by:

getNe in class WAbstractNetworkElement

Returns:

see above

getNodeByName

public Optional<WNode> getNodeByName(String name)

Returns the network node with the indicated name, if any

Parameters:

name - see above

Returns:

see above

getNodes

public List<WNode> getNodes()

Returns the list of network nodes, in increasing order according to its id

Returns:

see above

getNodesConnectedToCore

public SortedSet<WNode> getNodesConnectedToCore()

Returns the nodes in the network that are supposed to have a connection to the network core (the core nodes and those connecting links are not part of the network)

Returns:

see above

getServiceChainRequests

public List<WServiceChainRequest> getServiceChainRequests()

Returns the list of service chain requests, in increasing order according to its id

Returns:

see above

getServiceChains

public List<WServiceChain> getServiceChains()

Returns the list of service chains, in increasing order according to its id

Returns:

see above

getUserServiceNames

public SortedSet<String> getUserServiceNames()

Returns all the unique ids (names) of the user services defined

Returns:

see above

getUserServicesInfo

public SortedMap<String,WUserService> getUserServicesInfo()

Returns the user service information defined, in a map with key the user service identifier, and value the user service object

Returns:

see above

getVnfInstances

public SortedSet<WVnfInstance> getVnfInstances()

Returns a set with all the VNF instances in the network of any type

Returns:

see above

getVnfInstances

public SortedSet<WVnfInstance> getVnfInstances(String type)

Returns a set with all the VNF instances in the network of the given type

Parameters:

type - see above

Returns:

see above

getVnfType

public Optional<WVnfType> getVnfType(String typeName)

Returns the WVnfType object assigned to that name, if any

Parameters:

typeName - see above

Returns:

see above

getVnfTypeNames

public SortedSet<String> getVnfTypeNames()

Returns the set of VNF type names defined

Returns:

see above

getVnfTypes

public List<WVnfType> getVnfTypes()

Returns the map associating the VNF type, with the associated VNF object, as was defined by the user

Returns:

see above

getWdmLayer

public WLayerWdm getWdmLayer()

Returns the object identifying the WDM layer

Returns:

see above

isDeepCopy

public boolean isDeepCopy(WNet other)

Indicates if a network is an exact copy of other network in every aspect

Parameters:

other - see above

Returns:

see above

loadFromFile

public static WNet loadFromFile(File f)

Creates a design, loading it from a file

Parameters:

f - see above

Returns:

see above

removeUserServiceInfo

public void removeUserServiceInfo(String userServiceName)

Removes a user service definition from the internal repo

Parameters:

userServiceName - see above

removeVnfType

public void removeVnfType(String vnfTypeName)

Removes a defined VNF type

Parameters:

vnfTypeName - see above

saveToFile

public void saveToFile(File f)

Saves this network in the given file

Parameters:

f - see above

setUserServicesInfo

public void setUserServicesInfo(SortedMap<String,WUserService> newInfo)

Sets a new user service id to info map, removing all previous user services defined

Parameters:

newInfo - see above

setVnfTypesRemovingPreviousInfo

public void setVnfTypesRemovingPreviousInfo(SortedSet<WVnfType> newInfo)

Sets a new VNF type map, removing all previous VNF types defined

Parameters:

newInfo - see above

toString

public String toString()

Overrides:

toString in class Object