WServiceChainRequest (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.research.niw.networkModel.WAbstractNetworkElement
- - com.net2plan.research.niw.networkModel.WServiceChainRequest

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WServiceChainRequest
extends WAbstractNetworkElement
```
Instances of this class are service chain requests in the IP layer. Service chain requests can be realized by one or more service chains, so each service chain should start in one among a set of given input nodes, and end in one out of the given output nodes, and traverse in its path VNF instances, so that the sequence of types of VNFs to traverse is specified in the request.

The service chain request is also characterized by the total amount of traffic offered by the initial node.

Every time that the traffic traverses a VNF, its volume can change (e.g. traffic can be compressed or decompressed), and the user can specify the compressing/decompressing ratios using so called expansion factors. The expansion factor of a VNF is the output traffic of a given service chain, respect to the traffic at the ORIGIN of the service chain (not at the origin of the VNF).

Also, the user can specify the maximum acceptable latency limit, from the origin node, to (i) the input of each VNF, and (ii) the maximum latency to the flow end node.

Service chains can be tagged to be upstream or downstream (user-defined tag).

The offered traffic of a service chain is the current amount of traffic offered (maybe carried or not). It is possible to associate to a service chain request, information of the different offered traffics that would be produced at different time slots.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WServiceChain`	`addServiceChain(List<? extends WAbstractNetworkElement> sequenceOfIpLinksAndResources, double injectionTrafficGbps)` Adds a service chain to satisfy traffic of this service chain request.
`double`	`getCurrentOfferedTrafficInGbps()` Returns the current offered traffic of this service chain request (that may carried partially, totally or none)
`List<Double>`	`getListMaxLatencyFromOriginToVnStartAndToEndNode_ms()` Returns the list of maximum latencies specified for this service chain request.
`Demand`	`getNe()` Returns the underlying Net2Plan object.
`int`	`getNumberVnfsToTraverse()` Returns the number of VNFs that service chains of this request should traverse
`SortedSet<WNode>`	`getPotentiallyValidDestinations()` Returns the potentially valid destination nodes for the service chains of this request
`SortedSet<WNode>`	`getPotentiallyValidOrigins()` Returns the potentially valid origin nodes for the service chains of this request
`List<Double>`	`getSequenceOfExpansionFactorsRespectToInjection()` Returns a list with the information of the traffic expansion factors when traversing the VNFs.
`List<String>`	`getSequenceVnfTypes()` Returns the sequence of the VNF types that should be traversed by the service chains realizing this request
`List<Pair<String,Double>>`	`getTimeSlotNameAndInitialInjectionIntensityInGbpsList()` Returns the full user-defined traffic intensity information as a list of pairs, where each pair contains the user-defined name of the time slot, and the traffic intensity associated to that time slot
`Optional<Pair<String,Double>>`	`getTrafficIntensityInfo(int timeSlotIndex)` Get the user-defined traffic intensity associated to a time slot with the given index,
`Optional<Double>`	`getTrafficIntensityInfo(String timeSlotName)` Get the user-defined traffic intensity associated to a time slot with the given name,
`String`	`getUserServiceName()` Returns the name of the user service that this service chain request is associated to
`boolean`	`isUpstream()` Indicates if this is an upstream service chain request (initiated in the user).
`void`	`setCurrentOfferedTrafficInGbps(double offeredTrafficInGbps)` Sets the current offered traffic in Gbps for this service chain
`void`	`setIsUpstream(boolean isUpstream)` Sets if this is an upstream service chain request (initiated in the user), with true, of false if the service chain is downstream (ended in the user)
`void`	`setListMaxLatencyFromInitialToVnfStart_ms(List<Double> maxLatencyList_ms)` Sets the information of the list of maximum latencies (in ms) specified for this service chain.
`void`	`setPotentiallyValidDestinations(SortedSet<WNode> validDestinations)` Sets the potentially valid destination nodes for the service chains of this request
`void`	`setPotentiallyValidOrigins(SortedSet<WNode> validOrigins)` Sets the potentially valid origin nodes for the service chains of this request
`void`	`setSequenceOfExpansionFactorsRespectToInjection(List<Double> sequenceOfExpansionFactors)` Sets a list with the information of the traffic expansion factors when traversing the VNFs.
`void`	`setTimeSlotNameAndInitialInjectionIntensityInGbpsList(List<Pair<String,Double>> info)` Sets the full user-defined traffic intensity information as a list of pairs, where each pair contains the user-defined name of the time slot, and the traffic intensity associated to that time slot
`void`	`setUserServiceName(String userServiceName)` Sets the name of the user service that this service chain request is associated to
`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

- Method Detail
  - addServiceChain
```
public WServiceChain addServiceChain(List<? extends WAbstractNetworkElement> sequenceOfIpLinksAndResources,
                                     double injectionTrafficGbps)
```
    Adds a service chain to satisfy traffic of this service chain request. The service chain should have an initial node in the set of valid initial nodes, an end node in the set of valid end nodes, and traverse VNF instances in the order indicated by the service chain request.
    
    Parameters:
    
    sequenceOfIpLinksAndResources - the sequence of WIpLink and WVnfInstance objects realizing this service chain
    
    injectionTrafficGbps - the traffic injected by the origin node of the service chain. Note that VNFs will change the volumes of the traversed flows, according to the expansion factors defined for the service chain
    
    Returns:
    
    see above
  - getCurrentOfferedTrafficInGbps
```
public double getCurrentOfferedTrafficInGbps()
```
    Returns the current offered traffic of this service chain request (that may carried partially, totally or none)
    
    Returns:
    
    see above
  - getListMaxLatencyFromOriginToVnStartAndToEndNode_ms
```
public List<Double> getListMaxLatencyFromOriginToVnStartAndToEndNode_ms()
```
    Returns the list of maximum latencies specified for this service chain request. The list contains V+1 values, being V the number of VNFs to traverse. The first V values (i=1,...,V) correspond to the maximum latency from the origin node, to the input of the i-th VNF traversed. The last value correspon to the maximum latency from the origin node to the end node.
    
    Returns:
    
    see above
  - getNe
```
public Demand 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
  - getNumberVnfsToTraverse
```
public int getNumberVnfsToTraverse()
```
    Returns the number of VNFs that service chains of this request should traverse
    
    Returns:
    
    see above
  - getPotentiallyValidDestinations
```
public SortedSet<WNode> getPotentiallyValidDestinations()
```
    Returns the potentially valid destination nodes for the service chains of this request
    
    Returns:
    
    see above
  - getPotentiallyValidOrigins
```
public SortedSet<WNode> getPotentiallyValidOrigins()
```
    Returns the potentially valid origin nodes for the service chains of this request
    
    Returns:
    
    see above
  - getSequenceOfExpansionFactorsRespectToInjection
```
public List<Double> getSequenceOfExpansionFactorsRespectToInjection()
```
    Returns a list with the information of the traffic expansion factors when traversing the VNFs. This is a list with as many elements as the number of VNFs to traverse (V). If the i-th element of the list is X, means that for each traffic unit injected by the service chain origin node, X traffic units will be produced at the output of the i-th service chain.
    
    Returns:
    
    see above
  - getSequenceVnfTypes
```
public List<String> getSequenceVnfTypes()
```
    Returns the sequence of the VNF types that should be traversed by the service chains realizing this request
    
    Returns:
    
    see above
  - getTimeSlotNameAndInitialInjectionIntensityInGbpsList
```
public List<Pair<String,Double>> getTimeSlotNameAndInitialInjectionIntensityInGbpsList()
```
    Returns the full user-defined traffic intensity information as a list of pairs, where each pair contains the user-defined name of the time slot, and the traffic intensity associated to that time slot
    
    Returns:
    
    see above
  - getTrafficIntensityInfo
```
public Optional<Pair<String,Double>> getTrafficIntensityInfo(int timeSlotIndex)
```
    Get the user-defined traffic intensity associated to a time slot with the given index,
    
    Parameters:
    
    timeSlotIndex - see above
    
    Returns:
    
    a pair with name of the time slot and the traffic intensity value
  - getTrafficIntensityInfo
```
public Optional<Double> getTrafficIntensityInfo(String timeSlotName)
```
    Get the user-defined traffic intensity associated to a time slot with the given name,
    
    Parameters:
    
    timeSlotName - see above
    
    Returns:
    
    see above
  - getUserServiceName
```
public String getUserServiceName()
```
    Returns the name of the user service that this service chain request is associated to
    
    Returns:
    
    see above
  - isUpstream
```
public boolean isUpstream()
```
    Indicates if this is an upstream service chain request (initiated in the user). Returns false if the service chain is downstream (ended in the user)
    
    Returns:
    
    see above
  - setCurrentOfferedTrafficInGbps
```
public void setCurrentOfferedTrafficInGbps(double offeredTrafficInGbps)
```
    Sets the current offered traffic in Gbps for this service chain
    
    Parameters:
    
    offeredTrafficInGbps - see above
  - setIsUpstream
```
public void setIsUpstream(boolean isUpstream)
```
    Sets if this is an upstream service chain request (initiated in the user), with true, of false if the service chain is downstream (ended in the user)
    
    Parameters:
    
    isUpstream - see above
  - setListMaxLatencyFromInitialToVnfStart_ms
```
public void setListMaxLatencyFromInitialToVnfStart_ms(List<Double> maxLatencyList_ms)
```
    Sets the information of the list of maximum latencies (in ms) specified for this service chain. See getListMaxLatencyFromOriginToVnStartAndToEndNode_ms for an explanation
    
    Parameters:
    
    maxLatencyList_ms - see above
  - setPotentiallyValidDestinations
```
public void setPotentiallyValidDestinations(SortedSet<WNode> validDestinations)
```
    Sets the potentially valid destination nodes for the service chains of this request
    
    Parameters:
    
    validDestinations - see above
  - setPotentiallyValidOrigins
```
public void setPotentiallyValidOrigins(SortedSet<WNode> validOrigins)
```
    Sets the potentially valid origin nodes for the service chains of this request
    
    Parameters:
    
    validOrigins - see above
  - setSequenceOfExpansionFactorsRespectToInjection
```
public void setSequenceOfExpansionFactorsRespectToInjection(List<Double> sequenceOfExpansionFactors)
```
    Sets a list with the information of the traffic expansion factors when traversing the VNFs. This is a list with as many elements as the number of VNFs to traverse (V). If the i-th element of the list is X, means that for each traffic unit injected by the service chain origin node, X traffic units will be produced at the output of the i-th service chain.
    
    Parameters:
    
    sequenceOfExpansionFactors - see above
  - setTimeSlotNameAndInitialInjectionIntensityInGbpsList
```
public void setTimeSlotNameAndInitialInjectionIntensityInGbpsList(List<Pair<String,Double>> info)
```
    Sets the full user-defined traffic intensity information as a list of pairs, where each pair contains the user-defined name of the time slot, and the traffic intensity associated to that time slot
    
    Parameters:
    
    info - see above
  - setUserServiceName
```
public void setUserServiceName(String userServiceName)
```
    Sets the name of the user service that this service chain request is associated to
    
    Parameters:
    
    userServiceName - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WServiceChainRequest

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addServiceChain

getCurrentOfferedTrafficInGbps

getListMaxLatencyFromOriginToVnStartAndToEndNode_ms

getNe

getNumberVnfsToTraverse

getPotentiallyValidDestinations

getPotentiallyValidOrigins

getSequenceOfExpansionFactorsRespectToInjection

getSequenceVnfTypes

getTimeSlotNameAndInitialInjectionIntensityInGbpsList

getTrafficIntensityInfo

getTrafficIntensityInfo

getUserServiceName

isUpstream

setCurrentOfferedTrafficInGbps

setIsUpstream

setListMaxLatencyFromInitialToVnfStart_ms

setPotentiallyValidDestinations

setPotentiallyValidOrigins

setSequenceOfExpansionFactorsRespectToInjection

setTimeSlotNameAndInitialInjectionIntensityInGbpsList

setUserServiceName

toString