org.openflow.protocol

Class Wildcards

java.lang.Object

org.openflow.protocol.Wildcards

public class Wildcards
extends Object

a more user friendly representation of the wildcards bits in an OpenFlow match. The Wildcards object is

• immutable (i.e., threadsafe)
• instance managed (don't instantiate it yourself), instead call "of"

You can construct a Wildcard object from either its integer representation

Wildcard.of(0x3820e0);

Or start with either an empty or full wildcard, and select/unselect foo.

Wildcard w = Wildcards.NONE .set(Flag.DL_SRC, Flag. DL_DST, Flag.DL_VLAN_PCP) .setNwDstMask(8) .setNwSrcMask(8);

Remember: Wildcards objects are immutable. set... operations have NO EFFECT on the current wildcard object. You HAVE to use the returned changed object.

Author:

Andreas Wundsam

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Wildcards.Flag enum type for the binary flags that can be set in the wildcards field of an OFMatch.

Field Summary

Fields

Modifier and Type	Field and Description
static Wildcards	EXACT
static Wildcards	FULL
static Wildcards	INPORT_L2_MATCH
static int	INT_INPORT_L2_MATCH

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getInt() return the OpenFlow 'wire' integer representation of these wildcards
int	getNwDstMask() return the nw dst mask in normal CIDR style, e.g., 8 means x.x.x.x/8 means 8 bits wildcarded
int	getNwSrcMask() return the nw src mask in normal CIDR style, e.g., 8 means x.x.x.x/8 means 8 bits wildcarded
EnumSet<Wildcards.Flag>	getWildcardedFlags() return all wildcard flags that are fully wildcarded as an EnumSet.
int	hashCode()
Wildcards	inverted() return a Wildcard object that is inverted to this wildcard object.
boolean	isExact() is this a wildcard of an exact match
boolean	isFull() is this a wildcard set that has all flags set + and full (/0) nw_src and nw_dst wildcarding ?
boolean	isWildcarded(Wildcards.Flag flag)
Wildcards	matchOn(Wildcards.Flag... setFlags) return a Wildcards object that matches on exactly the given flags
Wildcards	matchOn(Wildcards.Flag flag) return a Wildcards object that matches on exactly the given flag
Wildcards	matchOn(Wildcards.Flag flag, Wildcards.Flag flag2) return a Wildcards object that matches on exactly the given flags
static Wildcards	of(int paramFlags) return a wildcard object matching the given int flags.
static Wildcards	of(Wildcards.Flag... setFlags) convience method return a wildcard for an arbitrary number of set flags
static Wildcards	of(Wildcards.Flag setFlag) convience method return a wildcard for exactly one set flag
static Wildcards	of(Wildcards.Flag setFlag, Wildcards.Flag setFlag2) convience method return a wildcard for exactly two set flags
static Wildcards	ofMatches(Wildcards.Flag... setFlags) convience method return a wildcard for an ofmatch that amtch on an arbitrary number of set flags
static Wildcards	ofMatches(Wildcards.Flag setFlag) convience method return a wildcards for ofmatches that match on one flag
static Wildcards	ofMatches(Wildcards.Flag setFlag, Wildcards.Flag setFlag2) convience method return a wildcard for for an ofmatch that match on two flags
static int	sanitizeInt(int flags) return the OpenFlow 'wire' integer representation of these wildcards.
String	toJava() a Java expression that constructs 'this' wildcards set
String	toString()
Wildcards	wildcard(Wildcards.Flag... setFlags) return a Wildcards object that has the given flags wildcarded
Wildcards	wildcard(Wildcards.Flag flag) return a Wildcards object that has the given flags set
Wildcards	wildcard(Wildcards.Flag flag, Wildcards.Flag flag2) return a Wildcards object that has the given flags set
Wildcards	withNwDstMask(int dstCidrMask) return a Wildcard object that has the given nwDstCidrMask set.
Wildcards	withNwSrcMask(int srcCidrMask) return a Wildcard object that has the given nwSrcCidrMask set.

Methods inherited from class java.lang.Object

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

Field Detail

FULL

public static final Wildcards FULL

EXACT

public static final Wildcards EXACT

INT_INPORT_L2_MATCH

public static final int INT_INPORT_L2_MATCH

See Also:

Constant Field Values

INPORT_L2_MATCH

public static final Wildcards INPORT_L2_MATCH

Method Detail

of

public static Wildcards of(int paramFlags)

return a wildcard object matching the given int flags. May reuse / cache frequently used wildcard instances. Don't rely on it though (use equals not ==).

Parameters:

flags -

Returns:

of

public static Wildcards of(Wildcards.Flag setFlag)

convience method return a wildcard for exactly one set flag

of

public static Wildcards of(Wildcards.Flag setFlag,
           Wildcards.Flag setFlag2)

convience method return a wildcard for exactly two set flags

of

public static Wildcards of(Wildcards.Flag... setFlags)

convience method return a wildcard for an arbitrary number of set flags

ofMatches

public static Wildcards ofMatches(Wildcards.Flag setFlag)

convience method return a wildcards for ofmatches that match on one flag

ofMatches

public static Wildcards ofMatches(Wildcards.Flag setFlag,
                  Wildcards.Flag setFlag2)

convience method return a wildcard for for an ofmatch that match on two flags

ofMatches

public static Wildcards ofMatches(Wildcards.Flag... setFlags)

convience method return a wildcard for an ofmatch that amtch on an arbitrary number of set flags

wildcard

public Wildcards wildcard(Wildcards.Flag flag)

return a Wildcards object that has the given flags set

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

wildcard

public Wildcards wildcard(Wildcards.Flag flag,
                 Wildcards.Flag flag2)

return a Wildcards object that has the given flags set

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

wildcard

public Wildcards wildcard(Wildcards.Flag... setFlags)

return a Wildcards object that has the given flags wildcarded

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

matchOn

public Wildcards matchOn(Wildcards.Flag flag)

return a Wildcards object that matches on exactly the given flag

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

matchOn

public Wildcards matchOn(Wildcards.Flag flag,
                Wildcards.Flag flag2)

return a Wildcards object that matches on exactly the given flags

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

matchOn

public Wildcards matchOn(Wildcards.Flag... setFlags)

return a Wildcards object that matches on exactly the given flags

NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

getNwSrcMask

public int getNwSrcMask()

return the nw src mask in normal CIDR style, e.g., 8 means x.x.x.x/8 means 8 bits wildcarded

getNwDstMask

public int getNwDstMask()

return the nw dst mask in normal CIDR style, e.g., 8 means x.x.x.x/8 means 8 bits wildcarded

withNwSrcMask

public Wildcards withNwSrcMask(int srcCidrMask)

return a Wildcard object that has the given nwSrcCidrMask set. NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

Parameters:

srcCidrMask - source mask to set in normal CIDR notation, i.e., 8 means x.x.x.x/8

Returns:

a modified object

withNwDstMask

public Wildcards withNwDstMask(int dstCidrMask)

return a Wildcard object that has the given nwDstCidrMask set. NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

Parameters:

dstCidrMask - dest mask to set in normal CIDR notation, i.e., 8 means x.x.x.x/8

Returns:

a modified object

inverted

public Wildcards inverted()

return a Wildcard object that is inverted to this wildcard object. NOTE: NOT a mutator function. 'this' wildcard object stays unmodified.

Returns:

a modified object

isWildcarded

public boolean isWildcarded(Wildcards.Flag flag)

getWildcardedFlags

public EnumSet<Wildcards.Flag> getWildcardedFlags()

return all wildcard flags that are fully wildcarded as an EnumSet. Do not modify. Note: some flags (like NW_SRC and NW_DST) that are partially wildcarded are not returned in this set.

Returns:

the EnumSet of wildcards

getInt

public int getInt()

return the OpenFlow 'wire' integer representation of these wildcards

sanitizeInt

public static int sanitizeInt(int flags)

return the OpenFlow 'wire' integer representation of these wildcards. Sanitize nw_src and nw_dst to be max. 32 (values > 32 are technically possible, but don't make semantic sense)

isFull

public boolean isFull()

is this a wildcard set that has all flags set + and full (/0) nw_src and nw_dst wildcarding ?

isExact

public boolean isExact()

is this a wildcard of an exact match

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toJava

public String toJava()

a Java expression that constructs 'this' wildcards set