org.onosproject.net.resource.impl

Class LabelAllocator

java.lang.Object

org.onosproject.net.resource.impl.LabelAllocator

public final class LabelAllocator
extends Object

Helper class which interacts with the ResourceService and provides a unified API to allocate MPLS labels and VLAN Ids.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelAllocator.FirstFitSelection First fit label selection.
static interface	LabelAllocator.LabelSelection Interface for selection algorithms of the labels.
static class	LabelAllocator.RandomSelection Random label selection.

Constructor Summary

Constructors

Constructor and Description
LabelAllocator(org.onosproject.net.resource.ResourceService rs) Creates a new label allocator.

Method Summary

Modifier and Type	Method and Description
Map<org.onosproject.net.LinkKey,org.onlab.util.Identifier<?>>	assignLabelToLinks(Set<org.onosproject.net.Link> links, org.onosproject.net.intent.IntentId id, org.onosproject.net.EncapsulationType type) Allocates labels and associates them to links.
Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>>	assignLabelToPorts(Set<org.onosproject.net.Link> links, org.onosproject.net.intent.IntentId id, org.onosproject.net.EncapsulationType type) Allocates labels and associates them to source and destination ports of a link.
LabelAllocator.LabelSelection	getLabelSelection() Retrieves the label selection behavior.
static boolean	isInEnum(String value) Checks if a given string is a valid Behavior.
void	setLabelSelection(String type) Changes the selection behavior.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelAllocator

public LabelAllocator(org.onosproject.net.resource.ResourceService rs)

Creates a new label allocator. Random is the default behavior.

Parameters:

rs - the resource service

Method Detail

isInEnum

public static boolean isInEnum(String value)

Checks if a given string is a valid Behavior.

Parameters:

value - the string to check

Returns:

true if value is a valid Behavior, false otherwise

setLabelSelection

public void setLabelSelection(String type)

Changes the selection behavior.

Parameters:

type - the behavior type

getLabelSelection

public LabelAllocator.LabelSelection getLabelSelection()

Retrieves the label selection behavior.

Returns:

the label selection behavior in use

assignLabelToLinks

public Map<org.onosproject.net.LinkKey,org.onlab.util.Identifier<?>> assignLabelToLinks(Set<org.onosproject.net.Link> links,
                                                                                        org.onosproject.net.intent.IntentId id,
                                                                                        org.onosproject.net.EncapsulationType type)

Allocates labels and associates them to links.

Parameters:

links - the links where labels will be allocated

id - the intent Id

type - the encapsulation type

Returns:

the list of links and associated labels

assignLabelToPorts

public Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> assignLabelToPorts(Set<org.onosproject.net.Link> links,
                                                                                             org.onosproject.net.intent.IntentId id,
                                                                                             org.onosproject.net.EncapsulationType type)

Allocates labels and associates them to source and destination ports of a link.

Parameters:

links - the links on which labels will be reserved

id - the intent Id

type - the encapsulation type

Returns:

the list of ports and associated labels