org.opendaylight.vtn.manager.internal.inventory.xml

Class XmlStaticTopologyConfig<T extends org.opendaylight.yangtools.yang.binding.ChildOf<VtnStaticTopology>>

java.lang.Object

org.opendaylight.vtn.manager.internal.inventory.xml.XmlStaticTopologyConfig<T>

Type Parameters:

T - The type of MD-SAL container associated with this class.

Direct Known Subclasses:

XmlStaticEdgePorts, XmlStaticSwitchLinks

public abstract class XmlStaticTopologyConfig<T extends org.opendaylight.yangtools.yang.binding.ChildOf<VtnStaticTopology>>
extends Object

XmlStaticTopologyConfig describes a XML file which specifies the static network topology configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlStaticTopologyConfig() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
abstract T	getConfig() Return a MD-SAL container which contains the configuration in this instance.
abstract Class<T>	getContainerType() Return a class which indicates the type of MD-SAL container associated with this class.
abstract String	getXmlConfigKey() Return a string which represents the configuration file key associated with this class.
abstract Class<? extends XmlStaticTopologyConfig<T>>	getXmlType() Return a class which indicates the type of this class.
void	load(VtnStaticTopologyBuilder builder, org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx) Load the static network topology configuration from XML file.
abstract XmlStaticTopologyConfig<T>	newInstance(T conf) Construct a new instance that contains the given configuration.
void	save(T conf) Save the given static network topology configuration into the XML file.
abstract void	setConfig(VtnStaticTopologyBuilder builder, T conf) Set the given configuration into the given MD-SAL container builder instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlStaticTopologyConfig

protected XmlStaticTopologyConfig()

Construct a new instance.

Method Detail

load

public final void load(VtnStaticTopologyBuilder builder,
                       org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx)
                throws VTNException

Load the static network topology configuration from XML file.

This method loads the configuration from the XML file, and store loaded configuration into the MD-SAL config DS and the given VtnStaticTopologyBuilder instance.

Parameters:

builder - A VtnStaticTopologyBuilder instance.

tx - A ReadWriteTransaction instance.

Throws:

VTNException - An error occurred.

save

public final void save(T conf)

Save the given static network topology configuration into the XML file.

Parameters:

conf - A MD-SAL container which contains the configuration to be saved. null means that the configuration file should be deleted.

getContainerType

public abstract Class<T> getContainerType()

Return a class which indicates the type of MD-SAL container associated with this class.

Returns:

A class instance which specifies the MD-SAL container type.

getXmlType

public abstract Class<? extends XmlStaticTopologyConfig<T>> getXmlType()

Return a class which indicates the type of this class.

Returns:

A class which indicates the type of this class.

getXmlConfigKey

public abstract String getXmlConfigKey()

Return a string which represents the configuration file key associated with this class.

Returns:

A string which represents the configuration file key.

setConfig

public abstract void setConfig(VtnStaticTopologyBuilder builder,
                               T conf)

Set the given configuration into the given MD-SAL container builder instance.

Parameters:

builder - A VtnStaticTopologyBuilder instance.

conf - A MD-SAL container which contains the configuration.

getConfig

public abstract T getConfig()

Return a MD-SAL container which contains the configuration in this instance.

Returns:

A MD-SAL container which contains the configuration.

newInstance

public abstract XmlStaticTopologyConfig<T> newInstance(T conf)

Construct a new instance that contains the given configuration.

Parameters:

conf - A MD-SAL container which contains the configuration.

Returns:

An instance of this class.