org.opendaylight.vtn.manager.neutron.impl

Class VTNManagerService

java.lang.Object

org.opendaylight.vtn.manager.neutron.impl.VTNManagerService

public final class VTNManagerService
extends Object

VTNManagerService provides interfaces to control VTN Manager.

Constructor Summary

Constructors

Constructor and Description
VTNManagerService(MdsalUtils md, org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry rpc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VbridgeConfig	getBridgeConfig(String tname, String bname) Return the current configuration of the specified vBridge.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VbridgeConfig>	getBridgeConfigPath(String tname, String bname) Return an instance identifier that specifies the vBridge configuration.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Vtn>	getTenantPath(String tname) Return an instance identifier that specifies the VTN.
boolean	hasBridge(String tname) Determine whether the specified VTN contains at least one vBridge or not.
int	removeBridge(String tname, String bname) Remove the specified vBridge.
int	removeInterface(RemoveVinterfaceInput input) Remove the specified virtual interface.
int	removePortMap(RemovePortMapInput input) Remove the port mapping configuration from the specified virtual interface.
int	removeTenant(String name) Remove the specified VTN.
int	setPortMap(SetPortMapInput input) Configure a port mapping into the virtual interface specified by the given RPC input.
int	updateBridge(String tname, String bname, String desc, VnodeUpdateMode mode) Create or update the specified vBridge.
int	updateInterface(UpdateVinterfaceInput input) Create or update the specified virtual interface.
int	updateTenant(String name, VnodeUpdateMode mode) Create or update a VTN with default parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNManagerService

public VTNManagerService(MdsalUtils md,
                         org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry rpc)

Construct a new instance.

Parameters:

md - A MdsalUtils instance.

rpc - A RpcConsumerRegistry instance.

Method Detail

getTenantPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Vtn> getTenantPath(String tname)

Return an instance identifier that specifies the VTN.

Parameters:

tname - The name of the VTN.

Returns:

An InstanceIdentifier instance.

getBridgeConfigPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VbridgeConfig> getBridgeConfigPath(String tname,
                                                                                                            String bname)

Return an instance identifier that specifies the vBridge configuration.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

Returns:

An InstanceIdentifier instance.

updateTenant

public int updateTenant(String name,
                        VnodeUpdateMode mode)

Create or update a VTN with default parameters.

Parameters:

name - The name of the VTN.

mode - A VnodeUpdateMode instance that specifies how to update the VTN. null implies VnodeUpdateMode.UPDATE.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

removeTenant

public int removeTenant(String name)

Remove the specified VTN.

Parameters:

name - The name of the VTN.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

hasBridge

public boolean hasBridge(String tname)

Determine whether the specified VTN contains at least one vBridge or not.

Parameters:

tname - The name of the VTN.

Returns:

true if the specified VTN contains at least one vBridge. false otherwise.

updateBridge

public int updateBridge(String tname,
                        String bname,
                        String desc,
                        VnodeUpdateMode mode)

Create or update the specified vBridge.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

desc - A brief description about the vBridge.

mode - A VnodeUpdateMode instance that specifies how to update the vBridge. null implies VnodeUpdateMode.UPDATE.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

removeBridge

public int removeBridge(String tname,
                        String bname)

Remove the specified vBridge.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

getBridgeConfig

public VbridgeConfig getBridgeConfig(String tname,
                                     String bname)

Return the current configuration of the specified vBridge.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

Returns:

A VbridgeConfig instance if the specified vBridge is present. null otherwise.

updateInterface

public int updateInterface(UpdateVinterfaceInput input)

Create or update the specified virtual interface.

Parameters:

input - A UpdateVinterfaceInput instance.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

removeInterface

public int removeInterface(RemoveVinterfaceInput input)

Remove the specified virtual interface.

Parameters:

input - A RemoveVinterfaceInput instance.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

setPortMap

public int setPortMap(SetPortMapInput input)

Configure a port mapping into the virtual interface specified by the given RPC input.

Parameters:

input - A SetPortMapInput instance.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.

removePortMap

public int removePortMap(RemovePortMapInput input)

Remove the port mapping configuration from the specified virtual interface.

Parameters:

input - A RemovePortMapInput instance.

Returns:

A HTTP status code that indicates the result. HttpURLConnection.HTTP_OK indicates successful completion.