org.opendaylight.vtn.manager.internal.util.pathpolicy

Class PathPolicyUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.pathpolicy.PathPolicyUtils

public final class PathPolicyUtils
extends Object

PathPolicyUtils class is a collection of utility class methods for path policy.

Field Summary

Fields

Modifier and Type	Field and Description
static long	COST_UNDEF The pseudo link cost value which represents the cost is not defined.
static Long	DEFAULT_LINK_COST Default link cost used when the path policy does not exist.
static int	DEFAULT_POLICY The path policy ID associated with the system default routing policy.

Method Summary

Modifier and Type	Method and Description
static RpcException	getDuplicatePortException(Object loc) Return a new RpcException that indicates duplicate port descriptor is detected.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathPolicy>	getIdentifier(Integer id) Create the instance identifier for the specified path policy.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathCost>	getIdentifier(Integer id, VtnPortDesc vdesc) Create the instance identifier for the specified path cost configuration.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathCost>	getIdentifier(int id, VtnPathCostConfig vpc) Create the instance identifier for the specified path cost information.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathPolicy>	getIdentifier(VtnPathPolicyConfig vpp) Create the instance identifier for the given VtnPathPolicyConfig instance.
static RpcException	getInvalidCostException(Long cost, Throwable cause) Return a new RpcException that indicates the given link cost valud is invalid.
static RpcException	getInvalidDefaultCostException(Long cost, Throwable cause) Return a new RpcException that indicates the given default cost valud is invalid.
static RpcException	getInvalidPolicyIdException(Integer id, Throwable cause) Return a new RpcException that indicates the given path policy ID is invalid.
static RpcException	getNoSwitchPortException() Return a new RpcException that indicates no switch port is specified.
static RpcException	getNotFoundException(Integer id) Return a new RpcException that indicates the specified path policy is not present.
static RpcException	getNotFoundException(Integer id, Throwable cause) Return a new RpcException that indicates the specified path policy is not present.
static RpcException	getNullPathCostException() Return a new RpcException that indicates the path cost configuration is null.
static RpcException	getNullPolicyIdException() Return a new RpcException that indicates the path policy ID is missing.
static VtnPathCostBuilder	newBuilder(VtnPathCostConfig vpcc) Create a new VtnPathCostBuilder instance that contains the given path cost configuration.
static VtnPathPolicyBuilder	newBuilder(VtnPathPolicyConfig vppc) Create a new VtnPathPolicyBuilder instance that contains the given path policy configuration.
static VtnPathCost	readVtnPathCost(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, int id, VtnPortDesc vdesc) Read the cost information associated with the given port location in the given path policy.
static List<VtnPathPolicy>	readVtnPathPolicies(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read all the path policies from the MD-SAL datastore.
static VtnPathPolicy	readVtnPathPolicy(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, Integer id) Read path policy configuration specified by the given ID.
static void	setCost(VtnPathCostBuilder builder, Long cost) Set the path cost into the given path cost builder.
static void	setDefaultCost(VtnPathPolicyBuilder builder, Long cost) Set the default cost into the given path policy builder.
static void	setId(VtnPathPolicyBuilder builder, Integer id) Set the path policy identifier into the given path policy builder.
static void	setPortDesc(VtnPathCostBuilder builder, VtnPortDesc vdesc) Set the switch port descriptor into the given path cost builder.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLICY

public static final int DEFAULT_POLICY

The path policy ID associated with the system default routing policy.

See Also:

Constant Field Values

DEFAULT_LINK_COST

public static final Long DEFAULT_LINK_COST

Default link cost used when the path policy does not exist.

COST_UNDEF

public static final long COST_UNDEF

The pseudo link cost value which represents the cost is not defined.

See Also:

Constant Field Values

Method Detail

getNotFoundException

public static RpcException getNotFoundException(Integer id)

Return a new RpcException that indicates the specified path policy is not present.

Parameters:

id - The identifier of the path policy.

Returns:

An RpcException.

getNotFoundException

public static RpcException getNotFoundException(Integer id,
                                                Throwable cause)

Return a new RpcException that indicates the specified path policy is not present.

Parameters:

id - The identifier of the path policy.

cause - A Throwable which indicates the cause of error.

Returns:

An RpcException.

getInvalidPolicyIdException

public static RpcException getInvalidPolicyIdException(Integer id,
                                                       Throwable cause)

Return a new RpcException that indicates the given path policy ID is invalid.

Parameters:

id - The identifier of the path policy.

cause - A throwable that indicates the cause of error.

Returns:

An RpcException.

getInvalidDefaultCostException

public static RpcException getInvalidDefaultCostException(Long cost,
                                                          Throwable cause)

Return a new RpcException that indicates the given default cost valud is invalid.

Parameters:

cost - Value for default cost.

cause - A throwable that indicates the cause of error.

Returns:

An RpcException.

getInvalidCostException

public static RpcException getInvalidCostException(Long cost,
                                                   Throwable cause)

Return a new RpcException that indicates the given link cost valud is invalid.

Parameters:

cost - Link cost.

cause - A throwable that indicates the cause of error.

Returns:

An RpcException.

getNullPolicyIdException

public static RpcException getNullPolicyIdException()

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

Returns:

An RpcException.

getNullPathCostException

public static RpcException getNullPathCostException()

Return a new RpcException that indicates the path cost configuration is null.

Returns:

An RpcException.

getDuplicatePortException

public static RpcException getDuplicatePortException(Object loc)

Return a new RpcException that indicates duplicate port descriptor is detected.

Parameters:

loc - An object that represents the switch port location.

Returns:

An RpcException.

getNoSwitchPortException

public static RpcException getNoSwitchPortException()

Return a new RpcException that indicates no switch port is specified.

Returns:

An RpcException.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathPolicy> getIdentifier(Integer id)

Create the instance identifier for the specified path policy.

Parameters:

id - The identifier of the path policy.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathPolicy> getIdentifier(VtnPathPolicyConfig vpp)

Create the instance identifier for the given VtnPathPolicyConfig instance.

Parameters:

vpp - A VtnPathPolicyConfig instance.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathCost> getIdentifier(Integer id,
                                                                                                    VtnPortDesc vdesc)

Create the instance identifier for the specified path cost configuration.

Parameters:

id - The identifier of the path policy.

vdesc - A VtnPortDesc instance.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPathCost> getIdentifier(int id,
                                                                                                    VtnPathCostConfig vpc)

Create the instance identifier for the specified path cost information.

Parameters:

id - The identifier of the path policy.

vpc - A VtnPathCostConfig instance.

Returns:

An InstanceIdentifier instance.

setId

public static void setId(VtnPathPolicyBuilder builder,
                         Integer id)
                  throws RpcException

Set the path policy identifier into the given path policy builder.

Parameters:

builder - A VtnPathPolicyBuilder instance.

id - The identifier for the path policy.

Throws:

RpcException - The given path policy ID is invalid.

NullPointerException - builder is null.

setDefaultCost

public static void setDefaultCost(VtnPathPolicyBuilder builder,
                                  Long cost)
                           throws RpcException

Set the default cost into the given path policy builder.

Parameters:

builder - A VtnPathPolicyBuilder instance.

cost - The default cost value.

Throws:

RpcException - The given default cost is invalid.

NullPointerException - builder is null.

setCost

public static void setCost(VtnPathCostBuilder builder,
                           Long cost)
                    throws RpcException

Set the path cost into the given path cost builder.

Parameters:

builder - A VtnPathCostBuilder instance.

cost - The path cost value.

Throws:

RpcException - The given path cost is invalid.

NullPointerException - builder is null.

setPortDesc

public static void setPortDesc(VtnPathCostBuilder builder,
                               VtnPortDesc vdesc)
                        throws RpcException

Set the switch port descriptor into the given path cost builder.

Parameters:

builder - A VtnPathCostBuilder instance.

vdesc - The switch port descriptor.

Throws:

RpcException - The given switch port descriptor is invalid.

NullPointerException - builder is null.

newBuilder

public static VtnPathPolicyBuilder newBuilder(VtnPathPolicyConfig vppc)
                                       throws RpcException

Create a new VtnPathPolicyBuilder instance that contains the given path policy configuration.

Parameters:

vppc - A VtnPathPolicyConfig instance that contains the path policy configuration.

Returns:

A VtnPathPolicyBuilder instance.

Throws:

RpcException - The given configuration contains invalid value.

NullPointerException - vppc is null.

newBuilder

public static VtnPathCostBuilder newBuilder(VtnPathCostConfig vpcc)
                                     throws RpcException

Create a new VtnPathCostBuilder instance that contains the given path cost configuration.

Parameters:

vpcc - A VtnPathCostConfig instance that contains the path cost configuration.

Returns:

A VtnPathCostBuilder instance.

Throws:

RpcException - The given configuration contains invalid value.

readVtnPathPolicies

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

Read all the path policies from the MD-SAL datastore.

Parameters:

rtx - A ReadTransaction instance.

Returns:

A list of VtnPathPolicy instances.

Throws:

VTNException - An error occurred.

readVtnPathPolicy

public static VtnPathPolicy readVtnPathPolicy(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                              Integer id)
                                       throws VTNException

Read path policy configuration specified by the given ID.

Parameters:

rtx - A ReadTransaction instance.

id - The path policy identifier.

Returns:

A VtnPathPolicy instance.

Throws:

VTNException - An error occurred.

readVtnPathCost

public static VtnPathCost readVtnPathCost(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                          int id,
                                          VtnPortDesc vdesc)
                                   throws VTNException

Read the cost information associated with the given port location in the given path policy.

Parameters:

rtx - A ReadTransaction instance.

id - The path policy identifier.

vdesc - A VtnPortDesc instance if found. null if not found.

Returns:

A VtnPathCost instance.

Throws:

VTNException - An error occurred.