org.opendaylight.vtn.manager.internal.util.flow.cond

Class FlowCondUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.cond.FlowCondUtils

public final class FlowCondUtils
extends Object

FlowCondUtils class is a collection of utility class methods for flow condition.

Method Summary

Modifier and Type	Method and Description
static VnodeName	checkName(String name) Verify the name of the flow condition.
static String	checkName(VnodeName vname) Verify the name of the flow condition.
static void	checkPresent(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, VnodeName vname) Determine whether the specified flow condition is present or not.
static void	checkPresent(VnodeName vname) Ensure the given vnode-name is not null.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition>	getIdentifier(String name) Create the instance identifier for the flow condition specified by the given name.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowMatch>	getIdentifier(String name, Integer index) Create the instance identifier for the flow match specified by the given flow condition name and match index.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition>	getIdentifier(VnodeName vname) Create the instance identifier for the flow condition specified by the given name.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowMatch>	getIdentifier(VnodeName vname, Integer index) Create the instance identifier for the flow match specified by the given flow condition name and match index.
static RpcException	getMatchIndexMissingException() Return a new RpcException that indicates the flow match index is missing.
static String	getName(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return the name of the flow condition configured in the given instance identifier.
static RpcException	getNotFoundException(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return a new RpcException that indicates the specified flow condition is not present.
static RpcException	getNotFoundException(String name) Return a new RpcException that indicates the specified flow condition is not present.
static RpcException	getNotFoundException(String name, Throwable cause) Return a new RpcException that indicates the specified flow condition is not present.
static VnodeName	getVnodeName(String name) Return a VnodeName instance that contains the given flow condition name.
static boolean	isEmpty(VtnFlowConditions root) Determine whether the given flow condition container is empty or not.
static VTNFlowCondition	readFlowCondition(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, String name) Read the flow condition specified by the given name from the MD-SAL datastore.
static List<VTNFlowCondition>	readFlowConditions(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read all the flow conditions from the MD-SAL datastore.
static VTNFlowMatch	readFlowMatch(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, String name, int idx) Read the flow match specified by the given index in the given flow condition from the MD-SAL datastore.
static void	verifyMatchIndex(Integer index) Verify the given index number for a flow match in a flow condition.
static void	verifyMatchIndex(Set<Integer> set, Integer index) Ensure that there is no duplicate match index in the match list.

Methods inherited from class java.lang.Object

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

Method Detail

getNotFoundException

public static RpcException getNotFoundException(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return a new RpcException that indicates the specified flow condition is not present.

Parameters:

path - An InstanceIdentifier instance that specifies the flow condition.

Returns:

An RpcException.

getNotFoundException

public static RpcException getNotFoundException(String name)

Return a new RpcException that indicates the specified flow condition is not present.

Parameters:

name - The name of the flow condition.

Returns:

An RpcException.

getNotFoundException

public static RpcException getNotFoundException(String name,
                                                Throwable cause)

Return a new RpcException that indicates the specified flow condition is not present.

Parameters:

name - The name of the flow condition.

cause - A Throwable which indicates the cause of error.

Returns:

An RpcException.

getMatchIndexMissingException

public static RpcException getMatchIndexMissingException()

Return a new RpcException that indicates the flow match index is missing.

Returns:

An RpcException.

checkName

public static VnodeName checkName(String name)
                           throws RpcException

Verify the name of the flow condition.

Parameters:

name - The name of the flow condition.

Returns:

A VnodeName instance that contains the given name.

Throws:

RpcException - The specified name is invalid.

checkName

public static String checkName(VnodeName vname)
                        throws RpcException

Verify the name of the flow condition.

Parameters:

vname - A VnodeName instance.

Returns:

Return the string in vname.

Throws:

RpcException - The specified name is invalid.

checkPresent

public static void checkPresent(VnodeName vname)
                         throws RpcException

Ensure the given vnode-name is not null.

Parameters:

vname - A VnodeName instance.

Throws:

RpcException - vname is null.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition> getIdentifier(String name)
                                                                                                  throws RpcException

Create the instance identifier for the flow condition specified by the given name.

This method is used to retrieve existing flow condition.

Parameters:

name - The name of the flow condition.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given flow condition name is invalid.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition> getIdentifier(VnodeName vname)

Create the instance identifier for the flow condition specified by the given name.

Parameters:

vname - A VnodeName instance that contains the name of the flow condition.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowMatch> getIdentifier(String name,
                                                                                                     Integer index)
                                                                                              throws RpcException

Create the instance identifier for the flow match specified by the given flow condition name and match index.

This method is used to retrieve flow match in existing flow condition.

Parameters:

name - The name of the flow condition.

index - The index assigned to the flow match in a flow condition.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given flow condition name or match index is invalid.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowMatch> getIdentifier(VnodeName vname,
                                                                                                     Integer index)
                                                                                              throws RpcException

Create the instance identifier for the flow match specified by the given flow condition name and match index.

This method is used to retrieve flow match in existing flow condition.

Parameters:

vname - A VnodeName instance that contains the name of the flow condition.

index - The index assigned to the flow match in a flow condition.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given flow condition name or match index is invalid.

getVnodeName

public static VnodeName getVnodeName(String name)
                              throws RpcException

Return a VnodeName instance that contains the given flow condition name.

This method is used to retrieve existing flow condition.

Parameters:

name - The name of the flow condition.

Returns:

A VnodeName instance that contains the given name.

Throws:

RpcException - The specified name is invalid.

getName

public static String getName(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return the name of the flow condition configured in the given instance identifier.

Parameters:

path - An InstanceIdentifier instance.

Returns:

The name of the flow condition if found. null if not found.

verifyMatchIndex

public static void verifyMatchIndex(Set<Integer> set,
                                    Integer index)
                             throws RpcException

Ensure that there is no duplicate match index in the match list.

Parameters:

set - A set of match indices.

index - An index to be tested.

Throws:

RpcException - An error occurred.

verifyMatchIndex

public static void verifyMatchIndex(Integer index)
                             throws RpcException

Verify the given index number for a flow match in a flow condition.

Parameters:

index - A match index to be verified.

Throws:

RpcException - The given match index is invalid.

isEmpty

public static boolean isEmpty(VtnFlowConditions root)

Determine whether the given flow condition container is empty or not.

Parameters:

root - A VtnFlowConditions instance.

Returns:

true only if the given flow condition container is empty.

checkPresent

public static void checkPresent(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                VnodeName vname)
                         throws VTNException

Determine whether the specified flow condition is present or not.

Parameters:

rtx - A ReadTransaction instance associated with the read transaction for the MD-SAL datastore.

vname - A VnodeName instance that contains the name of the target flow condition.

Throws:

RpcException - The specified flow condition is not present.

VTNException - Failed to read the MD-SAL datastore.

readFlowConditions

public static List<VTNFlowCondition> readFlowConditions(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)
                                                 throws VTNException

Read all the flow conditions from the MD-SAL datastore.

Parameters:

rtx - A ReadTransaction instance.

Returns:

A list of VTNFlowCondition instances.

Throws:

VTNException - An error occurred.

readFlowCondition

public static VTNFlowCondition readFlowCondition(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                 String name)
                                          throws VTNException

Read the flow condition specified by the given name from the MD-SAL datastore.

Parameters:

rtx - A ReadTransaction instance.

name - The name of the flow condition.

Returns:

A VTNFlowCondition instance.

Throws:

VTNException - An error occurred.

readFlowMatch

public static VTNFlowMatch readFlowMatch(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                         String name,
                                         int idx)
                                  throws VTNException

Read the flow match specified by the given index in the given flow condition from the MD-SAL datastore.

Parameters:

rtx - A ReadTransaction instance.

name - The name of the flow condition.

idx - The match index that specifies the flow match in the flow condition.

Returns:

A VTNFlowMatch instance. null is returned if no flow match is associated with the given match index in the flow condition.

Throws:

VTNException - An error occurred.