org.opendaylight.openflowplugin.impl.util

Class AddressNormalizationUtil

java.lang.Object

org.opendaylight.openflowplugin.impl.util.AddressNormalizationUtil

public final class AddressNormalizationUtil
extends Object

Utility class used for converting OpenFlow port numbers, Ipv4 and Ipv6 addresses to normalized format.

Method Summary

Modifier and Type	Method and Description
static String	normalizeInetAddressWithMask(InetAddress address, byte[] mask) Convert arbitrary mask to prefix mask and append it to textual representation of Inet address.
static InetAddress	normalizeIpAddress(byte[] address, byte[] mask) Normalize generic IP address and arbitrary mask in byte array format and apply arbitrary mask to IP address.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix	normalizeIpv4Address(byte[] address, byte[] mask) Normalize Ipv4 address and arbitrary mask in byte array format and apply arbitrary mask to Ipv4 address.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix	normalizeIpv4Arbitrary(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipv4Address, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad ipv4Mask) Normalize Ipv4 address and arbitrary mask and apply arbitrary mask to Ipv4 address.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix	normalizeIpv4Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix ipv4Prefix) Normalize Ipv4 address with prefix mask (ex.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix	normalizeIpv6Address(byte[] address, byte[] mask) Normalize Ipv6 address and arbitrary mask in byte array format and apply arbitrary mask to Ipv6 address.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address	normalizeIpv6AddressWithoutMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address ipv6Address) Normalize ipv 6 address without mask.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix	normalizeIpv6Arbitrary(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address ipv6Address, Ipv6ArbitraryMask ipv4Mask) Normalize Ipv6 address and arbitrary mask and apply arbitrary mask to Ipv6 address.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix	normalizeIpv6Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix ipv6Prefix) Normalize Ipv6 address with prefix mask (ex.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	normalizeMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress macAddress) Convert MAC address to it's lower case format.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	normalizeMacAddressMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress macAddress) Convert MAC address mask to it's lower case format and if it is full F mask, return null.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri	normalizeProtocolAgnosticPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri port, short protocolVersion) Extract port number from URI and convert it to OpenFlow specific textual representation.

Methods inherited from class java.lang.Object

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

Method Detail

normalizeProtocolAgnosticPort

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri normalizeProtocolAgnosticPort(@Nullable
                                                                                                                                             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri port,
                                                                                                                                             short protocolVersion)

Extract port number from URI and convert it to OpenFlow specific textual representation.

Parameters:

port - the OpenFlow port

protocolVersion - the OpenFLow protocol version

Returns:

normalized uri

normalizeIpv6Prefix

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix normalizeIpv6Prefix(@Nullable
                                                                                                                                          org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix ipv6Prefix)

Normalize Ipv6 address with prefix mask (ex. 1234:5678:9ABC::/76) and apply prefix mask to Ipv6 address.

Parameters:

ipv6Prefix - the Ipv6 prefix

Returns:

normalized Ipv6 prefix

normalizeIpv6Arbitrary

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix normalizeIpv6Arbitrary(@Nullable
                                                                                                                                             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address ipv6Address,
                                                                                                                                             @Nullable
                                                                                                                                             Ipv6ArbitraryMask ipv4Mask)

Normalize Ipv6 address and arbitrary mask and apply arbitrary mask to Ipv6 address.

Parameters:

ipv6Address - the Ipv4 address

ipv4Mask - the Ipv4 mask

Returns:

normalized Ipv6 prefix

normalizeIpv6AddressWithoutMask

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address normalizeIpv6AddressWithoutMask(@Nullable
                                                                                                                                                       org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address ipv6Address)

Normalize ipv 6 address without mask.

Parameters:

ipv6Address - the Ipv6 address

Returns:

normalized Ipv6 address

normalizeIpv4Prefix

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix normalizeIpv4Prefix(@Nullable
                                                                                                                                          org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix ipv4Prefix)

Normalize Ipv4 address with prefix mask (ex. 192.168.0.1/24) and apply prefix mask to Ipv4 address.

Parameters:

ipv4Prefix - the Ipv4 prefix

Returns:

normalized Ipv4 prefix

normalizeIpv4Arbitrary

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix normalizeIpv4Arbitrary(@Nullable
                                                                                                                                             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipv4Address,
                                                                                                                                             @Nullable
                                                                                                                                             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad ipv4Mask)

Normalize Ipv4 address and arbitrary mask and apply arbitrary mask to Ipv4 address.

Parameters:

ipv4Address - the Ipv4 address

ipv4Mask - the Ipv4 mask

Returns:

normalized Ipv4 prefix

normalizeIpv4Address

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix normalizeIpv4Address(@Nullable
                                                                                                                                           byte[] address,
                                                                                                                                           @Nullable
                                                                                                                                           byte[] mask)

Normalize Ipv4 address and arbitrary mask in byte array format and apply arbitrary mask to Ipv4 address.

Parameters:

address - Ipv4 address byte array

mask - Ipv4 mask byte array

Returns:

normalized Ipv4 prefix

normalizeIpv6Address

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix normalizeIpv6Address(@Nullable
                                                                                                                                           byte[] address,
                                                                                                                                           @Nullable
                                                                                                                                           byte[] mask)

Normalize Ipv6 address and arbitrary mask in byte array format and apply arbitrary mask to Ipv6 address.

Parameters:

address - Ipv6 address byte array

mask - Ipv6 mask byte array

Returns:

normalized Ipv6 prefix

normalizeIpAddress

@Nullable
public static InetAddress normalizeIpAddress(@Nullable
                                                       byte[] address,
                                                       @Nullable
                                                       byte[] mask)

Normalize generic IP address and arbitrary mask in byte array format and apply arbitrary mask to IP address.

Parameters:

address - address byte array

mask - mask byte array

Returns:

normalized Inet address

normalizeInetAddressWithMask

@Nullable
public static String normalizeInetAddressWithMask(@Nullable
                                                            InetAddress address,
                                                            @Nullable
                                                            byte[] mask)

Convert arbitrary mask to prefix mask and append it to textual representation of Inet address.

Parameters:

address - the address

mask - the mask

Returns:

the string

normalizeMacAddress

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress normalizeMacAddress(@Nullable
                                                                                                                                          org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress macAddress)

Convert MAC address to it's lower case format.

Parameters:

macAddress - the MAC address

Returns:

normalized MAC address

normalizeMacAddressMask

@Nullable
public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress normalizeMacAddressMask(@Nullable
                                                                                                                                              org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress macAddress)

Convert MAC address mask to it's lower case format and if it is full F mask, return null.

Parameters:

macAddress - the MAC address

Returns:

normalized MAC address