org.onosproject.net.intent.impl.compiler

Class LinkCollectionCompiler<T>

java.lang.Object

org.onosproject.net.intent.impl.compiler.LinkCollectionCompiler<T>

Direct Known Subclasses:

LinkCollectionIntentCompiler, LinkCollectionIntentFlowObjectiveCompiler

public class LinkCollectionCompiler<T>
extends Object

Shared APIs and implementations for Link Collection compilers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LinkCollectionCompiler.ForwardingInstructions Helper class to encapsulate treatment and selector in an unique abstraction.

Constructor Summary

Constructors

Constructor and Description
LinkCollectionCompiler()

Method Summary

Modifier and Type	Method and Description
protected void	computePorts(org.onosproject.net.intent.LinkCollectionIntent intent, com.google.common.collect.SetMultimap<org.onosproject.net.DeviceId,org.onosproject.net.PortNumber> inputPorts, com.google.common.collect.SetMultimap<org.onosproject.net.DeviceId,org.onosproject.net.PortNumber> outputPorts) Helper method to compute input and output ports for each device crossed in the path.
protected LinkCollectionCompiler.ForwardingInstructions	createForwardingInstruction(Optional<org.onosproject.net.intent.constraint.EncapsulationConstraint> encapConstraint, org.onosproject.net.intent.LinkCollectionIntent intent, org.onosproject.net.PortNumber inPort, Set<org.onosproject.net.PortNumber> outPorts, org.onosproject.net.DeviceId deviceId, Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> labels) Helper method to handle the different scenario (not encap, single hop, encap).
protected LinkCollectionCompiler.ForwardingInstructions	createForwardingInstructions(org.onosproject.net.intent.LinkCollectionIntent intent, org.onosproject.net.PortNumber inPort, org.onosproject.net.DeviceId deviceId, Set<org.onosproject.net.PortNumber> outPorts) Computes treatment and selector which will be used in the flow representation (Rule, Objective).
protected LinkCollectionCompiler.ForwardingInstructions	createForwardingInstructions(org.onosproject.net.intent.LinkCollectionIntent intent, org.onosproject.net.PortNumber inPort, org.onlab.util.Identifier<?> inLabel, org.onosproject.net.DeviceId deviceId, Set<org.onosproject.net.PortNumber> outPorts, Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> outLabels, org.onosproject.net.EncapsulationType type) Computes treatment and selector which will be used in the flow representation (Rule, Objective).
protected List<T>	createRules(org.onosproject.net.intent.LinkCollectionIntent intent, org.onosproject.net.DeviceId deviceId, Set<org.onosproject.net.PortNumber> inPorts, Set<org.onosproject.net.PortNumber> outPorts, Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> labels) Creates the flows representations.
protected Optional<org.onosproject.net.intent.constraint.EncapsulationConstraint>	getIntentEncapConstraint(org.onosproject.net.intent.LinkCollectionIntent intent) Retrieves the encapsulation constraint from the link collection intent.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkCollectionCompiler

public LinkCollectionCompiler()

Method Detail

createRules

protected List<T> createRules(org.onosproject.net.intent.LinkCollectionIntent intent,
                              org.onosproject.net.DeviceId deviceId,
                              Set<org.onosproject.net.PortNumber> inPorts,
                              Set<org.onosproject.net.PortNumber> outPorts,
                              Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> labels)

Creates the flows representations. This default implementation does nothing. Subclasses should override this method to create their specific flows representations (flow rule, flow objective).

Parameters:

intent - the intent to compile

deviceId - the affected device

inPorts - the input ports

outPorts - the output ports

labels - the labels for the label switching hop by hop

Returns:

the list of flows representations

createForwardingInstruction

protected LinkCollectionCompiler.ForwardingInstructions createForwardingInstruction(Optional<org.onosproject.net.intent.constraint.EncapsulationConstraint> encapConstraint,
                                                                                    org.onosproject.net.intent.LinkCollectionIntent intent,
                                                                                    org.onosproject.net.PortNumber inPort,
                                                                                    Set<org.onosproject.net.PortNumber> outPorts,
                                                                                    org.onosproject.net.DeviceId deviceId,
                                                                                    Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> labels)

Helper method to handle the different scenario (not encap, single hop, encap).

Parameters:

encapConstraint - the encapsulation constraint if it is present

intent - the link collection intent

inPort - the in port

outPorts - the out ports

deviceId - the current device

labels - the labels used by the encapsulation

Returns:

the forwarding instruction

createForwardingInstructions

protected LinkCollectionCompiler.ForwardingInstructions createForwardingInstructions(org.onosproject.net.intent.LinkCollectionIntent intent,
                                                                                     org.onosproject.net.PortNumber inPort,
                                                                                     org.onosproject.net.DeviceId deviceId,
                                                                                     Set<org.onosproject.net.PortNumber> outPorts)

Computes treatment and selector which will be used in the flow representation (Rule, Objective).

Parameters:

intent - the intent to compile

inPort - the input port of this device

deviceId - the current device

outPorts - the output ports of this device

Returns:

the forwarding instruction object which encapsulates treatment and selector

createForwardingInstructions

protected LinkCollectionCompiler.ForwardingInstructions createForwardingInstructions(org.onosproject.net.intent.LinkCollectionIntent intent,
                                                                                     org.onosproject.net.PortNumber inPort,
                                                                                     org.onlab.util.Identifier<?> inLabel,
                                                                                     org.onosproject.net.DeviceId deviceId,
                                                                                     Set<org.onosproject.net.PortNumber> outPorts,
                                                                                     Map<org.onosproject.net.ConnectPoint,org.onlab.util.Identifier<?>> outLabels,
                                                                                     org.onosproject.net.EncapsulationType type)

Computes treatment and selector which will be used in the flow representation (Rule, Objective).

Parameters:

intent - the intent to compile

inPort - the input port of this device

inLabel - the label associated to the input port

deviceId - the current device

outPorts - the output ports of this device

outLabels - the labels associated to the output port

type - the encapsulation type

Returns:

the forwarding instruction object which encapsulates treatment and selector

computePorts

protected void computePorts(org.onosproject.net.intent.LinkCollectionIntent intent,
                            com.google.common.collect.SetMultimap<org.onosproject.net.DeviceId,org.onosproject.net.PortNumber> inputPorts,
                            com.google.common.collect.SetMultimap<org.onosproject.net.DeviceId,org.onosproject.net.PortNumber> outputPorts)

Helper method to compute input and output ports for each device crossed in the path.

Parameters:

intent - the related intents

inputPorts - the input ports to compute

outputPorts - the output ports to compute

getIntentEncapConstraint

protected Optional<org.onosproject.net.intent.constraint.EncapsulationConstraint> getIntentEncapConstraint(org.onosproject.net.intent.LinkCollectionIntent intent)

Retrieves the encapsulation constraint from the link collection intent.

Parameters:

intent - the intent to analyze

Returns:

the encapsulation constraint