org.opendaylight.controller.sal.networkconfig.bridgedomain

Interface IPluginInBridgeDomainConfigService

All Known Subinterfaces:

IBridgeDomainConfigService

public interface IPluginInBridgeDomainConfigService

This interface defines bridge domain configuration service methods to be implemented by protocol plugins

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.utils.Status	addBridgeDomainConfig(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, Map<ConfigConstants,Object> params) add Bridge Domain Configuration
org.opendaylight.controller.sal.utils.Status	addPort(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, String portIdentifier, Map<ConfigConstants,Object> params) Add a port to a bridge domain
org.opendaylight.controller.sal.utils.Status	addPortConfig(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, String portIdentifier, Map<ConfigConstants,Object> params) add Port Configuration
org.opendaylight.controller.sal.utils.Status	createBridgeDomain(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, Map<ConfigConstants,Object> params) Create a Bridge Domain
org.opendaylight.controller.sal.utils.Status	deleteBridgeDomain(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier) Delete a Bridge Domain
org.opendaylight.controller.sal.utils.Status	deletePort(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, String portIdentifier) Delete a Port from a bridge domain
Map<ConfigConstants,Object>	getBridgeDomainConfigs(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier) Returns Bridge Domain Configurations
org.opendaylight.controller.sal.core.Node	getBridgeDomainNode(org.opendaylight.controller.sal.core.Node configNode, String bridgeIdentifier) Returns a Node dedicated to a Bridge Domain (if available) that is created using createBridgeDomain.
List<String>	getBridgeDomains(org.opendaylight.controller.sal.core.Node node) Returns the configured Bridge Domains
org.opendaylight.controller.sal.core.NodeConnector	getNodeConnector(org.opendaylight.controller.sal.core.Node configNode, String bridgeIdentifier, String portIdentifier) Returns a NodeConnector mapped to a Port (if available) that is created using addPort.
Map<ConfigConstants,Object>	getPortConfigs(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, String portIdentifier) Returns Port Configurations
org.opendaylight.controller.sal.utils.Status	removeBridgeDomainConfig(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, Map<ConfigConstants,Object> params) Delete Bridge Domain Configuration
org.opendaylight.controller.sal.utils.Status	removePortConfig(org.opendaylight.controller.sal.core.Node node, String bridgeIdentifier, String portIdentifier, Map<ConfigConstants,Object> params) Delete Port Configuration

Method Detail

createBridgeDomain

org.opendaylight.controller.sal.utils.Status createBridgeDomain(org.opendaylight.controller.sal.core.Node node,
                                                              String bridgeIdentifier,
                                                              Map<ConfigConstants,Object> params)
                                                                throws BridgeDomainConfigServiceException

Create a Bridge Domain

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

params - Map representation of config name (ConfigConstants) and Parameter value (represented as Object).

Returns:

Status.StatusCode.SUCCESS if bridge domain is created successfully. Failure Status otherwise.

Throws:

BridgeDomainConfigServiceException

deleteBridgeDomain

org.opendaylight.controller.sal.utils.Status deleteBridgeDomain(org.opendaylight.controller.sal.core.Node node,
                                                              String bridgeIdentifier)

Delete a Bridge Domain

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

Returns:

Status.StatusCode.SUCCESS if bridge domain is deleted successfully. Failure Status otherwise.

getBridgeDomains

List<String> getBridgeDomains(org.opendaylight.controller.sal.core.Node node)

Returns the configured Bridge Domains

Parameters:

node - Node serving this configuration service

Returns:

List of Bridge Domain Identifiers

addBridgeDomainConfig

org.opendaylight.controller.sal.utils.Status addBridgeDomainConfig(org.opendaylight.controller.sal.core.Node node,
                                                                 String bridgeIdentifier,
                                                                 Map<ConfigConstants,Object> params)

add Bridge Domain Configuration

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

params - Map representation of config Name (ConfigConstants) and config value(represented as Object).

Returns:

Status.StatusCode.SUCCESS if bridge domain configuration is added successfully. Failure Status otherwise.

removeBridgeDomainConfig

org.opendaylight.controller.sal.utils.Status removeBridgeDomainConfig(org.opendaylight.controller.sal.core.Node node,
                                                                    String bridgeIdentifier,
                                                                    Map<ConfigConstants,Object> params)

Delete Bridge Domain Configuration

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

params - Map representation of config name (ConfigConstants) and Parameter value (represented as Object).

Returns:

Status.StatusCode.SUCCESS if bridge domain configuration is deleted successfully. Failure Status otherwise.

getBridgeDomainConfigs

Map<ConfigConstants,Object> getBridgeDomainConfigs(org.opendaylight.controller.sal.core.Node node,
                                                 String bridgeIdentifier)

Returns Bridge Domain Configurations

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

Returns:

Map representation of config Name (ConfigConstants) and config value(represented as Object).

getBridgeDomainNode

org.opendaylight.controller.sal.core.Node getBridgeDomainNode(org.opendaylight.controller.sal.core.Node configNode,
                                                            String bridgeIdentifier)

Returns a Node dedicated to a Bridge Domain (if available) that is created using createBridgeDomain.

Parameters:

configNode - Node serving this configuration service.

bridgeIdentifier - Name of the bridge domain that would map to a dedicated Node

Returns:

Node dedicated to a bridge domain that is created using createBridgeDomain. returns null if there is no such dedicated node is available or represented.

addPort

org.opendaylight.controller.sal.utils.Status addPort(org.opendaylight.controller.sal.core.Node node,
                                                   String bridgeIdentifier,
                                                   String portIdentifier,
                                                   Map<ConfigConstants,Object> params)

Add a port to a bridge domain

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

portIdentifier - String representation of a Port.

params - Map representation of config name (ConfigConstants) and Parameter value (represented as Object).

Returns:

Status.StatusCode.SUCCESS if a port is added successfully. Failure Status otherwise.

deletePort

org.opendaylight.controller.sal.utils.Status deletePort(org.opendaylight.controller.sal.core.Node node,
                                                      String bridgeIdentifier,
                                                      String portIdentifier)

Delete a Port from a bridge domain

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

portIdentifier - String representation of a Port.

Returns:

Status.StatusCode.SUCCESS if a port is added successfully. Failure Status otherwise.

addPortConfig

org.opendaylight.controller.sal.utils.Status addPortConfig(org.opendaylight.controller.sal.core.Node node,
                                                         String bridgeIdentifier,
                                                         String portIdentifier,
                                                         Map<ConfigConstants,Object> params)

add Port Configuration

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

portIdentifier - String representation of a Port.

params - Map representation of config name (ConfigConstants) and Parameter value (represented as Object).

Returns:

Status.StatusCode.SUCCESS if a port configuration is added successfully. Failure Status otherwise.

removePortConfig

org.opendaylight.controller.sal.utils.Status removePortConfig(org.opendaylight.controller.sal.core.Node node,
                                                            String bridgeIdentifier,
                                                            String portIdentifier,
                                                            Map<ConfigConstants,Object> params)

Delete Port Configuration

Parameters:

node - Node serving this configuration service

portIdentifier - String representation of a Port.

config - Map representation of ConfigName and Configuration Value in Strings.

Returns:

Status.StatusCode.SUCCESS if a port configuration is removed successfully. Failure Status otherwise.

getPortConfigs

Map<ConfigConstants,Object> getPortConfigs(org.opendaylight.controller.sal.core.Node node,
                                         String bridgeIdentifier,
                                         String portIdentifier)

Returns Port Configurations

Parameters:

node - Node serving this configuration service

bridgeIdentifier - String representation of a Bridge Domain

portIdentifier - String representation of a Port.

Returns:

Map representation of Configuration Name (ConfigConstants) and Configuration value (represented as Object).

getNodeConnector

org.opendaylight.controller.sal.core.NodeConnector getNodeConnector(org.opendaylight.controller.sal.core.Node configNode,
                                                                  String bridgeIdentifier,
                                                                  String portIdentifier)

Returns a NodeConnector mapped to a Port (if available) that is created using addPort.

Parameters:

configNode - Node serving this configuration service.

bridgeIdentifier - Name of the bridge domain that would map to a dedicated Node

portIdentifier - String representation of a Port.

Returns:

NodeConnector that is mapped to a port created using addPort. returns null if there is no such nodeConnector is available or mapped.