org.opendaylight.controller.containermanager

Interface IContainerManager

public interface IContainerManager

Container Manager provides an ability for the Network Administrators to partitions a production network into smaller, isolated and manageable networks. IContainerManager interface exposes these Container management capabilities via the supported APIs

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.utils.Status	addContainer(ContainerConfig configObject) Create a Container
org.opendaylight.controller.sal.utils.Status	addContainerEntry(String containerName, List<String> portList) Adds resources to a given container.
org.opendaylight.controller.sal.utils.Status	addContainerFlows(String containerName, List<ContainerFlowConfig> configObject) Adds/Removes a container flow
boolean	doesContainerExist(String ContainerId) Check for the existence of a container
ContainerConfig	getContainerConfig(String containerName) Get the configuration object for the specified container
List<ContainerConfig>	getContainerConfigList() Get the list of ContainerConfig objects representing all the containers that have been configured previously.
List<String>	getContainerFlowNameList(String containerName) Get an the list of names of the container flows that have been configured previously on the given containerName
Map<String,List<ContainerFlowConfig>>	getContainerFlows() Get an array of ContainerFlowConfig objects representing all the container flows that have been configured previously.
List<ContainerFlowConfig>	getContainerFlows(String containerName) Get an array of ContainerFlowConfig objects representing all the container flows that have been configured previously on the given containerName
List<String>	getContainerNameList() Returns a list of container names that currently exist.
List<String>	getContainerNames() Returns a list of the existing containers.
boolean	hasNonDefaultContainer() Returns true if there are any non-default Containers present.
boolean	inContainerMode() Returns whether the controller is running in container mode
org.opendaylight.controller.sal.utils.Status	removeContainer(ContainerConfig configObject) Remove a container
org.opendaylight.controller.sal.utils.Status	removeContainer(String containerName) Remove a container
org.opendaylight.controller.sal.utils.Status	removeContainerEntry(String containerName, List<String> portList) Remove a resource from a given container.
org.opendaylight.controller.sal.utils.Status	removeContainerFlows(String containerName, List<ContainerFlowConfig> configObject) Remove a container flow
org.opendaylight.controller.sal.utils.Status	removeContainerFlows(String containerName, Set<String> name) Remove a container flow

Method Detail

addContainer

org.opendaylight.controller.sal.utils.Status addContainer(ContainerConfig configObject)

Create a Container

Parameters:

configObject - ContainerConfig object that carries name of the Container to be created

Returns:

returns the status code of adding a container

removeContainer

org.opendaylight.controller.sal.utils.Status removeContainer(ContainerConfig configObject)

Remove a container

Parameters:

configObject - ContainerConfig object that carries the name of the Container to be removed

Returns:

returns the status code of removing a container

removeContainer

org.opendaylight.controller.sal.utils.Status removeContainer(String containerName)

Remove a container

Parameters:

containerName - the container name

Returns:

returns the status code of removing a container

addContainerEntry

org.opendaylight.controller.sal.utils.Status addContainerEntry(String containerName,
                                                             List<String> portList)

Adds resources to a given container. Updates the container data based on new resources added

Parameters:

configObject - refer to ContainerConfig

Returns:

returns the status code of adding a container entry

removeContainerEntry

org.opendaylight.controller.sal.utils.Status removeContainerEntry(String containerName,
                                                                List<String> portList)

Remove a resource from a given container. Updates the container data based on new resources removed.

Parameters:

configObject - refer to ContainerConfig

Returns:

returns the status code of removing a container entry

addContainerFlows

org.opendaylight.controller.sal.utils.Status addContainerFlows(String containerName,
                                                             List<ContainerFlowConfig> configObject)

Adds/Removes a container flow

Parameters:

configObject - refer to ContainerConfig

Returns:

returns the status code of adding a container flow

removeContainerFlows

org.opendaylight.controller.sal.utils.Status removeContainerFlows(String containerName,
                                                                List<ContainerFlowConfig> configObject)

Remove a container flow

Parameters:

configObject - refer to ContainerConfig

Returns:

returns the status of removing a container flow

removeContainerFlows

org.opendaylight.controller.sal.utils.Status removeContainerFlows(String containerName,
                                                                Set<String> name)

Remove a container flow

Parameters:

containerName - the name of the container

name - the name of the container flow

Returns:

the status of the request

getContainerConfigList

List<ContainerConfig> getContainerConfigList()

Get the list of ContainerConfig objects representing all the containers that have been configured previously.

Returns:

the lsit of ContainerConfig objects configured so far

getContainerConfig

ContainerConfig getContainerConfig(String containerName)

Get the configuration object for the specified container

Parameters:

containerName - the name of the container

Returns:

a copy of the ContainerConfig object for the specified container if present, null otherwise

getContainerNameList

List<String> getContainerNameList()

Returns a list of container names that currently exist.

Returns:

array of String container names

doesContainerExist

boolean doesContainerExist(String ContainerId)

Check for the existence of a container

Parameters:

ContainerId - Name of the Container

Returns:

true if it exists, false otherwise

getContainerFlows

Map<String,List<ContainerFlowConfig>> getContainerFlows()

Get an array of ContainerFlowConfig objects representing all the container flows that have been configured previously.

Returns:

array of ContainerFlowConfig

getContainerFlows

List<ContainerFlowConfig> getContainerFlows(String containerName)

Get an array of ContainerFlowConfig objects representing all the container flows that have been configured previously on the given containerName

Parameters:

containerName - the container name

Returns:

array of ContainerFlowConfig

getContainerFlowNameList

List<String> getContainerFlowNameList(String containerName)

Get an the list of names of the container flows that have been configured previously on the given containerName

Parameters:

containerName - the container name

Returns:

the array containing the names of the container flows configured on the specified container

hasNonDefaultContainer

boolean hasNonDefaultContainer()

Returns true if there are any non-default Containers present.

Returns:

true if any non-default container is present false otherwise.

getContainerNames

List<String> getContainerNames()

Returns a list of the existing containers.

Returns:

List of Container name strings.

inContainerMode

boolean inContainerMode()

Returns whether the controller is running in container mode

Returns:

true if controller is in container mode, false otherwise