org.opendaylight.vtn.manager.internal.util

Class ProtocolUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.ProtocolUtils

public final class ProtocolUtils
extends Object

ProtocolUtils class is a collection of utilities for network protocol handling.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MASK_ETHER_TYPE Mask value which represents valid bits in an ethernet type.
static long	MASK_VLAN_ID Mask value which represents a VLAN ID bits in a long integer.
static int	NBITS_VLAN_ID The number of bits in a valid VLAN ID.

Method Summary

Modifier and Type	Method and Description
static void	checkEtherType(int type) Check the given ethernet type.
static void	checkIcmpValue(Short value, String desc) Check the specified ICMP type or code value.
static void	checkIpDscp(short dscp) Check the specified IP DSCP field value.
static void	checkIpProtocol(short proto) Check the specified IP protocol number.
static void	checkPortNumber(int port) Check the specified port number of IP transport layer protocol.
static void	checkVlan(int vlan) Check the specified VLAN ID.
static void	checkVlan(short vlan) Check the specified VLAN ID.
static void	checkVlanPriority(short pri) Check the specified VLAN priority.
static int	dscpToTos(short dscp) Convert the given IP DSCP value into a TOS value.
static Integer	getEtherType(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetType etype) Return the ethernet type in the given EthernetType instance.
static Integer	getEtherType(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType etype) Return the ethernet type in the given EtherType instance.
static Short	getIpDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp dscp) Return the IP DSCP field value configured in the given Dscp instance.
static Integer	getPortNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port) Return the port number configured in the given PortNumber instance.
static Integer	getVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vid) Return the VLAN ID in the given VlanId instance.
static Short	getVlanPriority(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp pcp) Return the VLAN priority in the given VlanPcp instance.
static boolean	isDscpValid(short dscp) Determine whether the specified IP DSCP value is valid or not.
static boolean	isIcmpValueValid(short value) Determine whether the specified ICMP type or code value is valid or not.
static boolean	isPortNumberValid(int port) Determine whether the specified port number of transport layer protocol is valid or not.
static boolean	isVlanPriorityValid(short pri) Determine whether the specified VLAN priority value is valid or not.
static short	tosToDscp(int tos) Convert the given IP TOS value into a DSCP value.

Methods inherited from class java.lang.Object

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

Field Detail

NBITS_VLAN_ID

public static final int NBITS_VLAN_ID

The number of bits in a valid VLAN ID.

See Also:

Constant Field Values

MASK_ETHER_TYPE

public static final long MASK_ETHER_TYPE

Mask value which represents valid bits in an ethernet type.

See Also:

Constant Field Values

MASK_VLAN_ID

public static final long MASK_VLAN_ID

Mask value which represents a VLAN ID bits in a long integer.

See Also:

Constant Field Values

Method Detail

checkEtherType

public static void checkEtherType(int type)
                           throws RpcException

Check the given ethernet type.

Parameters:

type - The ethernet type to be checked.

Throws:

RpcException - The given ethernet type is invalid.

getEtherType

public static Integer getEtherType(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType etype)
                            throws RpcException

Return the ethernet type in the given EtherType instance.

Parameters:

etype - An EtherType instance.

Returns:

An Integer instance if the ethernet type is present in the given EtherType instance. Otherwise null.

Throws:

RpcException - The given ethernet type is invalid.

getEtherType

public static Integer getEtherType(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetType etype)
                            throws RpcException

Return the ethernet type in the given EthernetType instance.

Parameters:

etype - An EthernetType instance.

Returns:

An Integer instance if the ethernet type is present in the given EthernetType instance. Otherwise null.

Throws:

RpcException - The given ethernet type is invalid.

checkVlan

public static void checkVlan(short vlan)
                      throws RpcException

Check the specified VLAN ID.

Parameters:

vlan - VLAN ID.

Throws:

RpcException - The specified VLAN ID is invalid.

checkVlan

public static void checkVlan(int vlan)
                      throws RpcException

Check the specified VLAN ID.

Parameters:

vlan - VLAN ID.

Throws:

RpcException - The specified VLAN ID is invalid.

getVlanId

public static Integer getVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vid)
                         throws RpcException

Return the VLAN ID in the given VlanId instance.

Parameters:

vid - A VlanId instance.

Returns:

An Integer instance if the VLAN ID is present in the given VlanId instance. Otherwise null.

Throws:

RpcException - The given VLAN ID is invalid.

isVlanPriorityValid

public static boolean isVlanPriorityValid(short pri)

Determine whether the specified VLAN priority value is valid or not.

Parameters:

pri - A VLAN priority.

Returns:

true only if the given VLAN priority is valid.

checkVlanPriority

public static void checkVlanPriority(short pri)
                              throws RpcException

Check the specified VLAN priority.

Parameters:

pri - A VLAN priority.

Throws:

RpcException - The specified VLAN priority is invalid.

getVlanPriority

public static Short getVlanPriority(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp pcp)
                             throws RpcException

Return the VLAN priority in the given VlanPcp instance.

Parameters:

pcp - A VlanPcp instance.

Returns:

An Short instance if the VLAN priority is present in the given VlanPcp instance. Otherwise null.

Throws:

RpcException - The given VLAN priority is invalid.

checkIpProtocol

public static void checkIpProtocol(short proto)
                            throws RpcException

Check the specified IP protocol number.

Parameters:

proto - An IP protocol number.

Throws:

RpcException - The specified IP protocol number is invalid.

isDscpValid

public static boolean isDscpValid(short dscp)

Determine whether the specified IP DSCP value is valid or not.

Parameters:

dscp - A DSCP value.

Returns:

true only if the given DSCP value is valid.

checkIpDscp

public static void checkIpDscp(short dscp)
                        throws RpcException

Check the specified IP DSCP field value.

Parameters:

dscp - An IP DSCP field value.

Throws:

RpcException - The specified IP DSCP value is invalid.

getIpDscp

public static Short getIpDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp dscp)
                       throws RpcException

Return the IP DSCP field value configured in the given Dscp instance.

Parameters:

dscp - A Dscp instance.

Returns:

A Short instance if the DSCP value is present in the given Dscp instance. Otherwise null.

Throws:

RpcException - The given DSCP value is invalid.

dscpToTos

public static int dscpToTos(short dscp)

Convert the given IP DSCP value into a TOS value.

Parameters:

dscp - A DSCP value.

Returns:

A TOS value.

tosToDscp

public static short tosToDscp(int tos)

Convert the given IP TOS value into a DSCP value.

Parameters:

tos - A TOS value.

Returns:

A DSCP value.

isIcmpValueValid

public static boolean isIcmpValueValid(short value)

Determine whether the specified ICMP type or code value is valid or not.

Parameters:

value - An ICMP type or code.

Returns:

true only if the given value is valid.

checkIcmpValue

public static void checkIcmpValue(Short value,
                                  String desc)
                           throws RpcException

Check the specified ICMP type or code value.

Parameters:

value - An ICMP type or code.

desc - A brief description about the given value.

Throws:

RpcException - The specified value is invalid.

isPortNumberValid

public static boolean isPortNumberValid(int port)

Determine whether the specified port number of transport layer protocol is valid or not.

Parameters:

port - A port number.

Returns:

true only if the given port number is valid.

checkPortNumber

public static void checkPortNumber(int port)
                            throws RpcException

Check the specified port number of IP transport layer protocol.

Parameters:

port - A port number.

Throws:

RpcException - The specified port number is invalid.

getPortNumber

public static Integer getPortNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port)
                             throws RpcException

Return the port number configured in the given PortNumber instance.

Parameters:

port - A PortNumber instance.

Returns:

An Integer instance if the port number is present in the given PortNumber instance. Otherwise null.

Throws:

RpcException - The given port number is invalid.