org.projectfloodlight.openflow.types

Class IPv6Address

java.lang.Object

org.projectfloodlight.openflow.types.IPAddress<IPv6Address>

org.projectfloodlight.openflow.types.IPv6Address

All Implemented Interfaces:

Comparable<IPv6Address>, Writeable, OFValueType<IPv6Address>, PrimitiveSinkable

public class IPv6Address
extends IPAddress<IPv6Address>
implements Writeable

IPv6 address object. Instance controlled, immutable. Internal representation: two 64 bit longs (not that you'd have to know).

Author:

Andreas Wundsam <andreas.wundsam@teleteach.de>

Field Summary

Fields

Modifier and Type	Field and Description
static IPv6Address	FULL_MASK
static int	LENGTH
static IPv6Address	NO_MASK
static IPv6Address	NONE
static org.projectfloodlight.openflow.types.IPv6Address.Reader	READER

Method Summary

Methods

Modifier and Type	Method and Description
IPv6Address	and(IPv6Address other) Perform a low level AND operation on the bits of two IPAddress objects
IPv6Address	applyMask(IPv6Address mask)
int	asCidrMaskLength() If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).
int	compareTo(IPv6Address o)
boolean	equals(Object obj)
byte[]	getBytes() Returns the raw IP address of this IPAddress object.
IPVersion	getIpVersion() Returns the Internet Protocol (IP) version of this object
int	getLength()
int	getUnsignedShortWord(int i)
int	getZeroCompressStart() get the index of the first word where to apply IPv6 zero compression
int	hashCode()
boolean	isBroadcast() Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4
boolean	isCidrMask() Checks if this IPAddress represents a valid CIDR style netmask, i.e., it has a set of leading "1" bits followed by only "0" bits
boolean	isLinkLocal() Returns true if the IPAddress is a link local address.
boolean	isLoopback() Returns true if the IPAddress is a loopback address.
boolean	isModifiedEui64Derived(MacAddress macAddress) Returns true if the second (lower-order) 64-bit block of this address is equal to the Modified EUI-64 format interface identifier that corresponds to the specified MAC address.
boolean	isMulticast() IPv6 multicast addresses are defined by the prefix ff00::/8
boolean	isReserved()
boolean	isUnspecified() Returns true if the IPAddress is unspecified.
IPv6Address	not() Returns a new IPAddress object with the bits inverted
static IPv6Address	of(byte[] address) Returns an IPv6Address object that represents the given IP address.
static IPv6Address	of(Inet6Address address) Returns an IPv6Address object that represents the given IP address.
static IPv6Address	of(IPv6AddressWithMask network, MacAddress macAddress) Returns an IPv6Address object that represents the given MAC address in the specified network.
static IPv6Address	of(long raw1, long raw2) Returns an IPv6Address object that represents the given IP address.
static IPv6Address	of(String string) Returns an IPv6Address object that represents the given IP address.
static IPv6Address	ofCidrMaskLength(int cidrMaskLength) Returns an IPv6Address object that represents the CIDR subnet mask of the given prefix length.
IPv6Address	or(IPv6Address other) Perform a low level OR operation on the bits of two IPAddress objects
void	putTo(com.google.common.hash.PrimitiveSink sink)
static IPv6Address	read16Bytes(io.netty.buffer.ByteBuf c)
Inet6Address	toInetAddress() Returns an InetAddress object representing this IP address.
String	toString()
String	toString(boolean zeroCompression, boolean leadingZeros)
IPv6AddressWithMask	withMask(IPv6Address mask) Returns an IPv6AddressWithMask object that represents this IP address masked by the given IP address mask.
IPv6AddressWithMask	withMaskOfLength(int cidrMaskLength) Returns an IPv6AddressWithMask object that represents this IP address masked by the CIDR subnet mask of the given prefix length.
void	write16Bytes(io.netty.buffer.ByteBuf c)
void	writeTo(io.netty.buffer.ByteBuf bb)

Methods inherited from class org.projectfloodlight.openflow.types.IPAddress

fromInetAddress, of

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH

public static final int LENGTH

See Also:

Constant Field Values

NONE

public static final IPv6Address NONE

NO_MASK

public static final IPv6Address NO_MASK

FULL_MASK

public static final IPv6Address FULL_MASK

READER

public static final org.projectfloodlight.openflow.types.IPv6Address.Reader READER

Method Detail

getIpVersion

public IPVersion getIpVersion()

Description copied from class: IPAddress

Returns the Internet Protocol (IP) version of this object

Specified by:

getIpVersion in class IPAddress<IPv6Address>

Returns:

the Internet Protocol (IP) version of this object

isCidrMask

public boolean isCidrMask()

Description copied from class: IPAddress

Checks if this IPAddress represents a valid CIDR style netmask, i.e., it has a set of leading "1" bits followed by only "0" bits

Specified by:

isCidrMask in class IPAddress<IPv6Address>

Returns:

true if this represents a valid CIDR style netmask, false otherwise

asCidrMaskLength

public int asCidrMaskLength()

Description copied from class: IPAddress

If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).

Specified by:

asCidrMaskLength in class IPAddress<IPv6Address>

Returns:

length of CIDR mask if this represents a valid CIDR mask

isUnspecified

public boolean isUnspecified()

Description copied from class: IPAddress

Returns true if the IPAddress is unspecified.

The unspecified addresses, also known as the wildcard addresses, refer to:

• the IPv4Address of 0.0.0.0
• the IPv6Address of ::

Specified by:

isUnspecified in class IPAddress<IPv6Address>

Returns:

true if the IPAddress is unspecified, false otherwise

isLoopback

public boolean isLoopback()

Description copied from class: IPAddress

Returns true if the IPAddress is a loopback address.

Loopback addresses refer to:

• any IPv4Address within 127.0.0.0/8
• the IPv6Address of ::1

Specified by:

isLoopback in class IPAddress<IPv6Address>

Returns:

true if the IPAddress is a loopback address, false otherwise

isLinkLocal

public boolean isLinkLocal()

Description copied from class: IPAddress

Returns true if the IPAddress is a link local address.

Link local addresses refer to:

• any IPv4Address within 169.254.0.0/16
• any IPv6Address within fe80::/10

Specified by:

isLinkLocal in class IPAddress<IPv6Address>

Returns:

true if the IPAddress is a link local address, false otherwise

isBroadcast

public boolean isBroadcast()

Description copied from class: IPAddress

Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4

Specified by:

isBroadcast in class IPAddress<IPv6Address>

Returns:

boolean true or false

isMulticast

public boolean isMulticast()

IPv6 multicast addresses are defined by the prefix ff00::/8

Specified by:

isMulticast in class IPAddress<IPv6Address>

Returns:

boolean true or false

isReserved

public boolean isReserved()

isModifiedEui64Derived

public boolean isModifiedEui64Derived(@Nonnull
                             MacAddress macAddress)

Returns true if the second (lower-order) 64-bit block of this address is equal to the Modified EUI-64 format interface identifier that corresponds to the specified MAC address.

Refer to the followings for the details of conversions between MAC addresses and Modified EUI-64 format interface identifiers:

• RFC 7042 - Section 2.2.1
• RFC 5342 - Section 2.2.1 (Obsoleted by RFC 7042)
• RFC 4291 - Appendix A

This method assumes the second (lower-order) 64-bit block to be a 64-bit interface identifier, which may not always be true.

Parameters:

macAddress - the MAC address to check

Returns:

boolean true or false

and

public IPv6Address and(IPv6Address other)

Description copied from class: IPAddress

Perform a low level AND operation on the bits of two IPAddress objects

Specified by:

and in class IPAddress<IPv6Address>

Parameters:

other - IPAddress

Returns:

new IPAddress object after the AND oper

or

public IPv6Address or(IPv6Address other)

Description copied from class: IPAddress

Perform a low level OR operation on the bits of two IPAddress objects

Specified by:

or in class IPAddress<IPv6Address>

Parameters:

other - IPAddress

Returns:

new IPAddress object after the AND oper

not

public IPv6Address not()

Description copied from class: IPAddress

Returns a new IPAddress object with the bits inverted

Specified by:

not in class IPAddress<IPv6Address>

Returns:

IPAddress

of

@Nonnull
public static IPv6Address of(@Nonnull
                     byte[] address)

Returns an IPv6Address object that represents the given IP address. The argument is in network byte order: the highest order byte of the address is in address[0].

The address byte array must be 16 bytes long (128 bits long).

Similar to InetAddress.getByAddress(byte[]).

Parameters:

address - the raw IP address in network byte order

Returns:

an IPv6Address object that represents the given raw IP address

Throws:

NullPointerException - if the given address was null

IllegalArgumentException - if the given address was of an invalid byte array length

See Also:

InetAddress.getByAddress(byte[])

of

@Nonnull
public static IPv6Address of(@Nonnull
                     String string)
                      throws IllegalArgumentException

Returns an IPv6Address object that represents the given IP address. The argument is in the conventional string representation of IPv6 addresses.

Expects up to 8 groups of 16-bit hex words seperated by colons (e.g., 2001:db8:85a3:8d3:1319:8a2e:370:7348).

Supports zero compression (e.g., 2001:db8::7348). Does not currently support embedding a dotted-quad IPv4 address into the IPv6 address (e.g., 2001:db8::192.168.0.1).

Parameters:

string - the IP address in the conventional string representation of IPv6 addresses

Returns:

an IPv6Address object that represents the given IP address

Throws:

NullPointerException - if the given string was null

IllegalArgumentException - if the given string was not a valid IPv6 address

of

@Nonnull
public static IPv6Address of(long raw1,
                     long raw2)

Returns an IPv6Address object that represents the given IP address. The arguments are the two 64-bit integers representing the first (higher-order) and second (lower-order) 64-bit blocks of the IP address.

Parameters:

raw1 - the first (higher-order) 64-bit block of the IP address

raw2 - the second (lower-order) 64-bit block of the IP address

Returns:

an IPv6Address object that represents the given raw IP address

of

@Nonnull
public static IPv6Address of(@Nonnull
                     Inet6Address address)

Returns an IPv6Address object that represents the given IP address. The argument is given as an Inet6Address object.

Parameters:

address - the IP address as an Inet6Address object

Returns:

an IPv6Address object that represents the given IP address

Throws:

NullPointerException - if the given Inet6Address was null

of

@Nonnull
public static IPv6Address of(@Nonnull
                     IPv6AddressWithMask network,
                     @Nonnull
                     MacAddress macAddress)

Returns an IPv6Address object that represents the given MAC address in the specified network.

The first (higher-order) 64-bit block of the returned address will be the network prefix derived from the specified network. The specified network must satisfy the followings:

• isCidrMask() == true
• 0 <= asCidrMaskLength() <= 64

The second (lower-order) 64-bit block of the returned address will be equal to the Modified EUI-64 format interface identifier that corresponds to the specified MAC address.

Refer to the followings for the details of conversions between MAC addresses and Modified EUI-64 format interface identifiers:

• RFC 7042 - Section 2.2.1
• RFC 5342 - Section 2.2.1 (Obsoleted by RFC 7042)
• RFC 4291 - Appendix A

Parameters:

network - the IPv6 network

macAddress - the MAC address

Returns:

an IPv6Address object that represents the given MAC address in the specified network

Throws:

IllegalArgumentException - if the specified network does not meet the aforementioned requirements

ofCidrMaskLength

@Nonnull
public static IPv6Address ofCidrMaskLength(int cidrMaskLength)

Returns an IPv6Address object that represents the CIDR subnet mask of the given prefix length.

Parameters:

cidrMaskLength - the prefix length of the CIDR subnet mask (i.e. the number of leading one-bits), where 0 <= cidrMaskLength <= 128

Returns:

an IPv6Address object that represents the CIDR subnet mask of the given prefix length

Throws:

IllegalArgumentException - if the given prefix length was invalid

withMask

@Nonnull
public IPv6AddressWithMask withMask(@Nonnull
                                   IPv6Address mask)

Returns an IPv6AddressWithMask object that represents this IP address masked by the given IP address mask.

Specified by:

withMask in class IPAddress<IPv6Address>

Parameters:

mask - the IPv6Address object that represents the mask

Returns:

an IPv6AddressWithMask object that represents this IP address masked by the given mask

Throws:

NullPointerException - if the given mask was null

withMaskOfLength

@Nonnull
public IPv6AddressWithMask withMaskOfLength(int cidrMaskLength)

Returns an IPv6AddressWithMask object that represents this IP address masked by the CIDR subnet mask of the given prefix length.

Specified by:

withMaskOfLength in class IPAddress<IPv6Address>

Parameters:

cidrMaskLength - the prefix length of the CIDR subnet mask (i.e. the number of leading one-bits), where 0 <= cidrMaskLength <= 128

Returns:

an IPv6AddressWithMask object that represents this IP address masked by the CIDR subnet mask of the given prefix length

Throws:

IllegalArgumentException - if the given prefix length was invalid

See Also:

ofCidrMaskLength(int)

getBytes

public byte[] getBytes()

Description copied from class: IPAddress

Returns the raw IP address of this IPAddress object. The result is in network byte order: the highest order byte of the address is in getBytes()[0].

Similar to InetAddress.getAddress()

Specified by:

getBytes in class IPAddress<IPv6Address>

Returns:

the raw IP address of this object

See Also:

InetAddress.getAddress()

getLength

public int getLength()

Specified by:

getLength in interface OFValueType<IPv6Address>

toInetAddress

@Nonnull
public Inet6Address toInetAddress()

Description copied from class: IPAddress

Returns an InetAddress object representing this IP address.

The resulting InetAddress object:

• will not carry a hostname
• will not carry a non-zero scope ID or scoped interface, in the case of Inet6Address

Specified by:

toInetAddress in class IPAddress<IPv6Address>

Returns:

an InetAddress object representing this IP address

toString

public String toString()

Specified by:

toString in class IPAddress<IPv6Address>

getUnsignedShortWord

public int getUnsignedShortWord(int i)

getZeroCompressStart

public int getZeroCompressStart()

get the index of the first word where to apply IPv6 zero compression

Returns:

the index

toString

public String toString(boolean zeroCompression,
              boolean leadingZeros)

hashCode

public int hashCode()

Specified by:

hashCode in class IPAddress<IPv6Address>

equals

public boolean equals(Object obj)

Specified by:

equals in class IPAddress<IPv6Address>

write16Bytes

public void write16Bytes(io.netty.buffer.ByteBuf c)

read16Bytes

public static IPv6Address read16Bytes(io.netty.buffer.ByteBuf c)
                               throws OFParseError

Throws:

OFParseError

applyMask

public IPv6Address applyMask(IPv6Address mask)

Specified by:

applyMask in interface OFValueType<IPv6Address>

compareTo

public int compareTo(IPv6Address o)

Specified by:

compareTo in interface Comparable<IPv6Address>

putTo

public void putTo(com.google.common.hash.PrimitiveSink sink)

Specified by:

putTo in interface PrimitiveSinkable

writeTo

public void writeTo(io.netty.buffer.ByteBuf bb)

Specified by:

writeTo in interface Writeable