org.opendaylight.controller.containermanager

Class ContainerFlowConfig

java.lang.Object

org.opendaylight.controller.configuration.ConfigurationObject

org.opendaylight.controller.containermanager.ContainerFlowConfig

All Implemented Interfaces:

Serializable

public class ContainerFlowConfig
extends org.opendaylight.controller.configuration.ConfigurationObject
implements Serializable

Flow Specification Java Object for Container Manager Represents a container flow configuration information for Container Manager. Objects of this class are serialized to and de-serialized from binary files through java serialization API when saving to/reading from Container manager startup configuration file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContainerFlowConfig() Instantiates a new container flow config.
ContainerFlowConfig(ContainerFlowConfig containerFlowConfig)
ContainerFlowConfig(String name, String srcIP, String dstIP, String proto, String srcPort, String dstPort) Instantiates a new container flow config.
ContainerFlowConfig(String name, String dlVlan, String srcIP, String dstIP, String proto, String srcPort, String dstPort)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	equalsByMatch(ContainerFlowConfig that) equalsByMatch
boolean	equalsByName(String name) Equals by Flow Spec name.
String	getDstIP() Returns the Destination IP Address.
Short	getDstIPMaskLen() Returns the Destination IP Address mask length.
InetAddress	getDstIPNum() Returns the Destination IP Address.
String	getDstPort() Returns Destination Layer4 Port.
Short	getDstPortNum() Returns Destination Layer4 Port number.
List<org.opendaylight.controller.sal.match.Match>	getMatches() Returns the matches.
String	getName() Returns the name of this Flow Specification
String	getProtocol() Returns the protocol.
Short	getProtoNum() Get the IP protocol value
String	getSrcIP() Returns the Source IP Address.
Short	getSrcIPMaskLen() Returns the Source IP Address mask length.
InetAddress	getSrcIPNum() Returns the Source IP Address.
String	getSrcPort() Returns Source Layer4 Port.
Short	getSrcPortNum() Returns Source Layer4 Port number.
String	getVlan() Returns the vlan id.
Set<Short>	getVlanList() Returns the vlan id number for all vlans specified
int	hashCode()
boolean	isUnidirectional()
boolean	overlap(ContainerFlowConfig other) Returns whether this container flow overlap with the passed one This is true when any two of the resulting matches for the two container flow configurations intersect.
String	toString()
org.opendaylight.controller.sal.utils.Status	validate() Checks if this flow specification configuration is valid.

Methods inherited from class org.opendaylight.controller.configuration.ConfigurationObject

getRegularExpression, isValidResourceName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerFlowConfig

public ContainerFlowConfig()

Instantiates a new container flow config.

ContainerFlowConfig

public ContainerFlowConfig(String name,
                   String srcIP,
                   String dstIP,
                   String proto,
                   String srcPort,
                   String dstPort)

Instantiates a new container flow config.

Parameters:

name - Flow Spec configuration name

container - Container Name

srcIP - Source IP Address

dstIP - Destination IP Address

proto - Protocol

srcPort - Source Layer4 Port

dstPort - Destination Layer4 Port

ContainerFlowConfig

public ContainerFlowConfig(String name,
                   String dlVlan,
                   String srcIP,
                   String dstIP,
                   String proto,
                   String srcPort,
                   String dstPort)

ContainerFlowConfig

public ContainerFlowConfig(ContainerFlowConfig containerFlowConfig)

Method Detail

getName

public String getName()

Returns the name of this Flow Specification

Returns:

the name of the Flow Specification

getVlan

public String getVlan()

Returns the vlan id.

Returns:

the Vlan Id

getSrcIP

public String getSrcIP()

Returns the Source IP Address.

Returns:

the Source IP Address

getDstIP

public String getDstIP()

Returns the Destination IP Address.

Returns:

the Destination IP Address

getProtocol

public String getProtocol()

Returns the protocol.

Returns:

the protocol

getSrcPort

public String getSrcPort()

Returns Source Layer4 Port.

Returns:

Source Layer4 Port

getDstPort

public String getDstPort()

Returns Destination Layer4 Port.

Returns:

Destination Layer4 Port

isUnidirectional

public boolean isUnidirectional()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsByName

public boolean equalsByName(String name)

Equals by Flow Spec name.

Parameters:

name - flow spec name for comparison

Returns:

true, if successful

equalsByMatch

public boolean equalsByMatch(ContainerFlowConfig that)

equalsByMatch

Parameters:

that - ContainerFlowConfig for comparison

Returns:

true, if any match is equal

getVlanList

public Set<Short> getVlanList()

Returns the vlan id number for all vlans specified

Returns:

the vlan id number for all vlans specified

getSrcIPMaskLen

public Short getSrcIPMaskLen()

Returns the Source IP Address mask length.

Returns:

the Source IP Address mask length

getDstIPMaskLen

public Short getDstIPMaskLen()

Returns the Destination IP Address mask length.

Returns:

the Destination IP Address mask length

getSrcIPNum

public InetAddress getSrcIPNum()

Returns the Source IP Address.

Returns:

the Source IP Address

getDstIPNum

public InetAddress getDstIPNum()

Returns the Destination IP Address.

Returns:

the Destination IP Address

getSrcPortNum

public Short getSrcPortNum()

Returns Source Layer4 Port number.

Returns:

Source Layer4 Port number

getDstPortNum

public Short getDstPortNum()

Returns Destination Layer4 Port number.

Returns:

Destination Layer4 Port number

getProtoNum

public Short getProtoNum()

Get the IP protocol value

Returns:

the protocol

overlap

public boolean overlap(ContainerFlowConfig other)

Returns whether this container flow overlap with the passed one This is true when any two of the resulting matches for the two container flow configurations intersect.

Parameters:

other - the other container flow config with which checking the overlap

Returns:

true if the two configurations overlap, false otherwise

validate

public org.opendaylight.controller.sal.utils.Status validate()

Checks if this flow specification configuration is valid.

Returns:

true, if is valid

getMatches

public List<org.opendaylight.controller.sal.match.Match> getMatches()

Returns the matches. If unidirectional flag is set, there will be only one match per vlan in the list If unidirectional flag is unset there will be two matches per vlan in the list, only if the specified flow has an intrinsic direction. For Ex. if the cFlow only has the protocol field configured, no matter if unidirectional flag is set or not, only one match per vlan will be returned The client just has to iterate over the returned list

Returns:

the matches

toString

public String toString()

Overrides:

toString in class Object