org.opendaylight.vtn.manager.internal.util.pathmap

Class PathMapUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.pathmap.PathMapUtils

public final class PathMapUtils
extends Object

PathMapUtils class is a collection of utility class methods for path map.

Method Summary

Modifier and Type	Method and Description
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathMap>	getIdentifier(Integer index) Create the instance identifier for the global path map specified by the given map index.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathMap>	getIdentifier(String name, Integer index) Create the instance identifier for the VTN path map specified by the given VTN name and map index.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathMap>	getIdentifier(VTenantIdentifier ident, Integer index) Create the instance identifier for the VTN path map specified by the given VTN identifier and map index.
static Integer	getIndex(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return the path map index in the given instance identifier.
static RpcException	getInvalidMapIndexException(Integer index, Throwable cause) Return a new RpcException that indicates the given path map index is invalid.
static RpcException	getNullMapIndexException() Return a new RpcException that indicates the path map ID is missing.
static boolean	isEmpty(VtnPathMapList vplist) Determine whether the given path map container is empty or not.
static boolean	isUpdated(VtnPathMap old, VtnPathMap vpm) Determine whether the specified path map was actually updated or not.
static void	log(org.slf4j.Logger logger, ChangedData<?> data) Record an informational log message that indicates a path map has been changed.
static void	log(org.slf4j.Logger logger, IdentifiedData<?> data, VtnUpdateType type) Record an informational log message that indicates a path map has been created or removed.
static VtnPathMap	readPathMap(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, Integer index) Read the path map associated with the given index in the global path map list.
static VtnPathMap	readPathMap(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, VTenantIdentifier ident, Integer index) Read the path map associated with the given index in the given VTN.
static List<VtnPathMap>	readPathMaps(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read the path maps in the global path map list.
static List<VtnPathMap>	readPathMaps(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, VTenantIdentifier ident) Read the VTN path maps in the given VTN.
static String	toString(VtnPathMap vpm) Return a string that describes the specified path map.
static VtnPathMapBuilder	toVtnPathMapBuilder(VtnPathMapConfig vpmc) Convert the given VtnPathMapConfig instance into a VtnPathMapBuilder instance.
static void	verifyMapIndex(Integer index) Ensure that the given map index is valid.
static void	verifyMapIndex(Set<Integer> set, Integer index) Ensure that there is not duplicate map index in the path map list.

Methods inherited from class java.lang.Object

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

Method Detail

getNullMapIndexException

public static RpcException getNullMapIndexException()

Return a new RpcException that indicates the path map ID is missing.

Returns:

An RpcException.

getInvalidMapIndexException

public static RpcException getInvalidMapIndexException(Integer index,
                                                       Throwable cause)

Return a new RpcException that indicates the given path map index is invalid.

Parameters:

index - The path map index.

cause - A throwable that indicates the cause of error.

Returns:

An RpcException.

toVtnPathMapBuilder

public static VtnPathMapBuilder toVtnPathMapBuilder(VtnPathMapConfig vpmc)
                                             throws RpcException

Convert the given VtnPathMapConfig instance into a VtnPathMapBuilder instance.

If the given instance does not contain the path policy ID, this method set zero as the path policy ID.

Parameters:

vpmc - A VtnPathMapConfig instance.

Returns:

A VtnPathMapBuilder instance that contains values in the given VtnPathMapConfig instance.

Throws:

RpcException - The given VtnPathMapConfig instance contains invalid data.

verifyMapIndex

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

Ensure that there is not duplicate map index in the path map list.

Parameters:

set - A set of map indices.

index - An index to be tested.

Throws:

RpcException - An error occurred.

verifyMapIndex

public static void verifyMapIndex(Integer index)
                           throws RpcException

Ensure that the given map index is valid.

Parameters:

index - An index to be tested.

Throws:

RpcException - The given map index is invalid.

getIndex

public static Integer getIndex(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return the path map index in the given instance identifier.

Parameters:

path - An InstanceIdentifier instance.

Returns:

The index of the path map if found. null if not found.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathMap> getIdentifier(Integer index)
                                                                                            throws RpcException

Create the instance identifier for the global path map specified by the given map index.

Parameters:

index - The index assigned to the global path map.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given map index is invalid.

getIdentifier

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

Create the instance identifier for the VTN path map specified by the given VTN name and map index.

This method is used to retrieve path map in existing VTN.

Parameters:

name - The name of the VTN.

index - The index assigned to the path map in the specified VTN.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given VTN name or map index is invalid.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathMap> getIdentifier(VTenantIdentifier ident,
                                                                                                   Integer index)
                                                                                            throws RpcException

Create the instance identifier for the VTN path map specified by the given VTN identifier and map index.

Parameters:

ident - The identifier for the target VTN.

index - The index assigned to the path map in the specified VTN.

Returns:

An InstanceIdentifier instance.

Throws:

RpcException - The given map index is invalid.

isEmpty

public static boolean isEmpty(VtnPathMapList vplist)

Determine whether the given path map container is empty or not.

Parameters:

vplist - A VtnPathMapList instance.

Returns:

true only if the given path map container is empty.

readPathMaps

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

Read the path maps in the global path map list.

Parameters:

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

Returns:

A list of all global path maps. Each element in the list is sorted by index in ascending order. An empty list is returned if no global path map is configured.

Throws:

VTNException - An error occurred.

readPathMap

public static VtnPathMap readPathMap(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                     Integer index)
                              throws VTNException

Read the path map associated with the given index in the global path map list.

Parameters:

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

index - The index that specifies the path map.

Returns:

A VtnPathMap instance if found. null if not found.

Throws:

VTNException - An error occurred.

readPathMaps

public static List<VtnPathMap> readPathMaps(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                            VTenantIdentifier ident)
                                     throws VTNException

Read the VTN path maps in the given VTN.

Parameters:

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

ident - The identifier for the target VTN.

Returns:

A list of all VTN path maps in the given VTN. Each element in the list is sorted by index in ascending order. An empty list is returned if no VTN path map is configured.

Throws:

VTNException - An error occurred.

readPathMap

public static VtnPathMap readPathMap(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                     VTenantIdentifier ident,
                                     Integer index)
                              throws VTNException

Read the path map associated with the given index in the given VTN.

Parameters:

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

ident - The identifier for the target VTN.

index - The index that specifies the path map.

Returns:

A VtnPathMap instance if found. null if not found.

Throws:

VTNException - An error occurred.

isUpdated

public static boolean isUpdated(@Nonnull
                                VtnPathMap old,
                                @Nonnull
                                VtnPathMap vpm)

Determine whether the specified path map was actually updated or not.

Note that this method expects that both before and after have the same index.

Parameters:

old - The path map before modification.

vpm - The path map after modification.

Returns:

true if the specified path map was actually updated. false otherwise.

toString

public static String toString(VtnPathMap vpm)

Return a string that describes the specified path map.

Parameters:

vpm - The path map. Note that this method expects that the specified path map is valid.

Returns:

A string that describes the specified path map.

log

public static void log(org.slf4j.Logger logger,
                       IdentifiedData<?> data,
                       VtnUpdateType type)

Record an informational log message that indicates a path map has been created or removed.

Parameters:

logger - A logger instance.

data - An IdentifiedData instance that contains a path map.

type - VtnUpdateType.CREATED on added, VtnUpdateType.REMOVED on removed.

log

public static void log(org.slf4j.Logger logger,
                       ChangedData<?> data)

Record an informational log message that indicates a path map has been changed.

Parameters:

logger - A logger instance.

data - An ChangedData instance that contains a path map.