org.onosproject.vpls.config

Interface VplsConfigService

All Known Implementing Classes:

VplsConfigImpl

public interface VplsConfigService

Provides information about the VPLS configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static Class<VplsAppConfig>	CONFIG_CLASS

Method Summary

Modifier and Type	Method and Description
void	addIface(String vplsName, String iface) Adds a network interface to a VPLS.
void	addVpls(String vplsName, Set<String> ifaces, String encap) Adds a VPLS to the configuration.
Set<Interface>	allIfaces() Retrieves the interfaces without IP configured, so compatible with VPLS, from the interface service.
void	cleanVplsConfig() Cleans up the VPLS configuration.
org.onosproject.net.EncapsulationType	encap(String vplsName) Returns the encapsulation type in use for a given VPLS.
Map<String,org.onosproject.net.EncapsulationType>	encapByVplsName() Returns the VPLS names and associated encapsulation type.
Set<Interface>	ifaces() Retrieves the interfaces associated to a VPLS.
Set<Interface>	ifaces(String vplsName) Retrieves the interfaces associated to the VPLS specified.
com.google.common.collect.SetMultimap<String,Interface>	ifacesByVplsName() Returns the VPLS names and associated interfaces from the configuration.
com.google.common.collect.SetMultimap<String,Interface>	ifacesByVplsName(org.onlab.packet.VlanId vlan, org.onosproject.net.ConnectPoint connectPoint) Returns the list of interfaces grouped by VPLS name, given a VLAN Id and a connect point.
void	removeIface(String iface) Removes a network interface from a VPLS.
void	removeVpls(String vplsName) Removes a VPLS from the configuration.
void	setEncap(String vplsName, String encap) Sets an encapsulation parameter for a VPLS.
Set<String>	vplsAffectedByApi() Retrieves the VPLS names modified from CLI.
Set<String>	vplsNames() Retrieves all VPLS names.
Set<String>	vplsNamesOld() Retrieves all VPLS names from the old config.

Field Detail

CONFIG_CLASS

static final Class<VplsAppConfig> CONFIG_CLASS

Method Detail

addVpls

void addVpls(String vplsName,
             Set<String> ifaces,
             String encap)

Adds a VPLS to the configuration.

Parameters:

vplsName - the name of the VPLS

ifaces - the interfaces associated with the VPLS

encap - the encapsulation type

removeVpls

void removeVpls(String vplsName)

Removes a VPLS from the configuration.

Parameters:

vplsName - the name of the VPLS to be removed

addIface

void addIface(String vplsName,
              String iface)

Adds a network interface to a VPLS.

Parameters:

vplsName - the name of the VPLS

iface - the network interface to be added to the VPLS

setEncap

void setEncap(String vplsName,
              String encap)

Sets an encapsulation parameter for a VPLS.

Parameters:

vplsName - the name of the VPLS

encap - the encapsulation used (i.e. MPLS or VLAN) or

encap

org.onosproject.net.EncapsulationType encap(String vplsName)

Returns the encapsulation type in use for a given VPLS.

Parameters:

vplsName - the name of the VPLS

Returns:

the encapsulation type in use, if any

removeIface

void removeIface(String iface)

Removes a network interface from a VPLS.

Parameters:

iface - the network interface to be removed from the VPLS

cleanVplsConfig

void cleanVplsConfig()

Cleans up the VPLS configuration. Removes all VPLSs.

vplsAffectedByApi

Set<String> vplsAffectedByApi()

Retrieves the VPLS names modified from CLI.

Returns:

the VPLS names modified from CLI

allIfaces

Set<Interface> allIfaces()

Retrieves the interfaces without IP configured, so compatible with VPLS, from the interface service.

Returns:

the set of interfaces configured, compatible with VPLS

ifaces

Set<Interface> ifaces()

Retrieves the interfaces associated to a VPLS.

Returns:

the set of interfaces associated to a VPLS

ifaces

Set<Interface> ifaces(String vplsName)

Retrieves the interfaces associated to the VPLS specified.

Parameters:

vplsName - the name of the VPLS

Returns:

the set of interfaces associated to the VPLS specified

vplsNames

Set<String> vplsNames()

Retrieves all VPLS names.

Returns:

a set of VPLS names

vplsNamesOld

Set<String> vplsNamesOld()

Retrieves all VPLS names from the old config.

Returns:

a set of VPLS names

ifacesByVplsName

com.google.common.collect.SetMultimap<String,Interface> ifacesByVplsName()

Returns the VPLS names and associated interfaces from the configuration.

Returns:

a map of VPLS names and associated interfaces

ifacesByVplsName

com.google.common.collect.SetMultimap<String,Interface> ifacesByVplsName(org.onlab.packet.VlanId vlan,
                                                                         org.onosproject.net.ConnectPoint connectPoint)

Returns the list of interfaces grouped by VPLS name, given a VLAN Id and a connect point.

Parameters:

vlan - the VLAN Id

connectPoint - the connect point

Returns:

a map of VPLS names and associated interfaces; null otherwise

encapByVplsName

Map<String,org.onosproject.net.EncapsulationType> encapByVplsName()

Returns the VPLS names and associated encapsulation type.

Returns:

a map of VPLS names and associated encapsulation type