VTNConfigImpl (vtn 0.6.4-SNAPSHOT API)

java.lang.Object
- org.opendaylight.vtn.manager.internal.config.VTNConfigImpl

All Implemented Interfaces:

VTNConfig
```
public final class VTNConfigImpl
extends Object
implements VTNConfig
```
Implementation of VTNConfig interface.
This class has XML bindings, so an instance of this class can be serialized as XML.

Constructor Summary

Constructors
Constructor and Description
`VTNConfigImpl()` Construct a new instance which contains default parameter values.
`VTNConfigImpl(EtherAddress mac)` Construct a new instance which contains default parameter values.
`VTNConfigImpl(VtnConfig vcfg)` Construct a new instance.
`VTNConfigImpl(VtnConfig vcfg, EtherAddress mac)` Construct a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static VtnConfigBuilder`	`builder(EtherAddress mac)` Create a new `VtnConfigBuilder` instance filled with default values.
`static VtnConfigBuilder`	`builder(VtnConfig vcfg, EtherAddress mac)` Create a new `VtnConfigBuilder` instance that contains the given parameters.
`static String`	`diff(VTNConfig oldConf, VTNConfig newConf)` Create a diff of the given two configuration.
`boolean`	`equals(Object o)` Determine whether the given object is identical to this object.
`static VtnConfigBuilder`	`fillDefault(VtnConfigBuilder builder, EtherAddress mac)` Fill the given configuration with default values.
`int`	`getBulkFlowModTimeout()` Return the number of milliseconds to wait for completion of bulk FLOW_MOD requests.
`EtherAddress`	`getControllerMacAddress()` Return MAC address of the controller used as source MAC address of ARP packet.
`int`	`getFlowModTimeout()` Return the number of milliseconds to wait for completion of a single FLOW_MOD request.
`int`	`getInitTimeout()` Return the number of milliseconds to wait for another controller in the cluster to complete initialization.
`Integer`	`getJaxbBulkFlowModTimeout()` Deprecated. Only for JAXB. Use `getBulkFlowModTimeout()` instead.
`Integer`	`getJaxbFlowModTimeout()` Deprecated. Only for JAXB. Use `getFlowModTimeout()` instead.
`Integer`	`getJaxbInitTimeout()` Deprecated. Only for JAXB. Use `getInitTimeout()` instead.
`Integer`	`getJaxbL2FlowPriority()` Deprecated. Only for JAXB. Use `getL2FlowPriority()` instead.
`Integer`	`getJaxbMaxRedirections()` Deprecated. Only for JAXB. Use `getMaxRedirections()` instead.
`Integer`	`getJaxbTopologyWait()` Deprecated. Only for JAXB. Use `getTopologyWait()` instead.
`VtnConfigBuilder`	`getJaxbValue()` Return a `VtnConfigBuilder` that contains values loaded via JAXB.
`int`	`getL2FlowPriority()` Return priority value for layer 2 flow entries.
`int`	`getMaxRedirections()` Return the maximum number of packet redirections per a flow.
`int`	`getTopologyWait()` Return the number of milliseconds to wait for completion of inter-switch link detection by topology-manager.
`int`	`hashCode()` Return the hash code of this object.
`boolean`	`isHostTracking()` Return a boolean value that determines whether to enable host tracking in the vBridge.
`VtnConfig`	`toVtnConfig()` Convert this instance into a `VtnConfig` instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VTNConfigImpl
```
public VTNConfigImpl()
```
    Construct a new instance which contains default parameter values.
    Note that this constructor never configures MAC address of the local node.
  - VTNConfigImpl
```
public VTNConfigImpl(EtherAddress mac)
```
    Construct a new instance which contains default parameter values.
    
    Parameters:
    
    mac - MAC address of the local node.
  - VTNConfigImpl
```
public VTNConfigImpl(VtnConfig vcfg)
```
    Construct a new instance.
    
    Parameters:
    
    vcfg - A VtnConfig instance.
  - VTNConfigImpl
```
public VTNConfigImpl(VtnConfig vcfg,
                     EtherAddress mac)
```
    Construct a new instance.
    
    Parameters:
    
    vcfg - A VtnConfig instance.
    
    mac - MAC address of the local node. This parameter is used only if a non null value is specified and MAC address is not configured in vcfg.
- Method Detail
  - fillDefault
```
public static VtnConfigBuilder fillDefault(VtnConfigBuilder builder,
                                           EtherAddress mac)
```
    Fill the given configuration with default values.
    
    Parameters:
    
    builder - A VtnConfigBuilder instance.
    
    mac - MAC address of the local node.
    
    Returns:
    
    builder is always returned.
  - builder
```
public static VtnConfigBuilder builder(EtherAddress mac)
```
    Create a new VtnConfigBuilder instance filled with default values.
    
    Parameters:
    
    mac - MAC address of the local node.
    
    Returns:
    
    A VtnConfigBuilder instance.
  - builder
```
public static VtnConfigBuilder builder(VtnConfig vcfg,
                                       EtherAddress mac)
```
    Create a new VtnConfigBuilder instance that contains the given parameters.
    - If a null is specified to vcfg, this method returns a VtnConfigBuilder instance filled with default values.
    - If a VtnConfig is specified to vcfg, this method returns a VtnConfigBuilder instance which contains the given parameter. Missing parameters in vcfg will be filled with default values.
    Parameters:
    
    vcfg - A VtnConfig instance or null.
    
    mac - MAC address of the local node.
    
    Returns:
    
    A VtnConfigBuilder instance.
  - diff
```
public static String diff(VTNConfig oldConf,
                          VTNConfig newConf)
```
    Create a diff of the given two configuration.
    
    Parameters:
    
    oldConf - Old configuration.
    
    newConf - New configuration.
    
    Returns:
    
    A string that represents difference of the given two instances. null if the given two instances are identical.
  - toVtnConfig
```
public VtnConfig toVtnConfig()
```
    Convert this instance into a VtnConfig instance.
    
    Returns:
    
    A VtnConfig instance.
  - getJaxbValue
```
public VtnConfigBuilder getJaxbValue()
```
    Return a VtnConfigBuilder that contains values loaded via JAXB.
    
    Returns:
    
    A VtnConfigBuilder instance if this instance is created by JAXB. Note that an empty VtnConfigBuilder is returned if no value is configured via JAXB.
  - equals
```
public boolean equals(Object o)
```
    Determine whether the given object is identical to this object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - An object to be compared.
    
    Returns:
    
    true if identical. Otherwise false.
  - hashCode
```
public int hashCode()
```
    Return the hash code of this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code.
  - getJaxbTopologyWait
```
public Integer getJaxbTopologyWait()
```
    Deprecated. Only for JAXB. Use getTopologyWait() instead.
    
    Return an Integer instance which represents the current value of "topology-wait".
    
    Returns:
    
    An Integer value or null.
  - getJaxbL2FlowPriority
```
public Integer getJaxbL2FlowPriority()
```
    Deprecated. Only for JAXB. Use getL2FlowPriority() instead.
    
    Return an Integer instance which represents the current value of "l2-flow-priority".
    
    Returns:
    
    An Integer value or null.
  - getJaxbFlowModTimeout
```
public Integer getJaxbFlowModTimeout()
```
    Deprecated. Only for JAXB. Use getFlowModTimeout() instead.
    
    Return an Integer instance which represents the current value of "flow-mod-timeout".
    
    Returns:
    
    An Integer value or null.
  - getJaxbBulkFlowModTimeout
```
public Integer getJaxbBulkFlowModTimeout()
```
    Deprecated. Only for JAXB. Use getBulkFlowModTimeout() instead.
    
    Return an Integer instance which represents the current value of "bulk-flow-mod-timeout".
    
    Returns:
    
    An Integer value or null.
  - getJaxbInitTimeout
```
public Integer getJaxbInitTimeout()
```
    Deprecated. Only for JAXB. Use getInitTimeout() instead.
    
    Return an Integer instance which represents the current value of "init-timeout".
    
    Returns:
    
    An Integer value or null.
  - getJaxbMaxRedirections
```
public Integer getJaxbMaxRedirections()
```
    Deprecated. Only for JAXB. Use getMaxRedirections() instead.
    
    Return an Integer instance which represents the current value of "max-redirections".
    
    Returns:
    
    An Integer value or null.
  - getTopologyWait
```
public int getTopologyWait()
```
    Return the number of milliseconds to wait for completion of inter-switch link detection by topology-manager.
    
    Specified by:
    
    getTopologyWait in interface VTNConfig
    
    Returns:
    
    The number of milliseconds to wait for completion of inter-switch link detection.
  - getL2FlowPriority
```
public int getL2FlowPriority()
```
    Return priority value for layer 2 flow entries.
    
    Specified by:
    
    getL2FlowPriority in interface VTNConfig
    
    Returns:
    
    Priority value for layer 2 flow entries.
  - getFlowModTimeout
```
public int getFlowModTimeout()
```
    Return the number of milliseconds to wait for completion of a single FLOW_MOD request.
    
    Specified by:
    
    getFlowModTimeout in interface VTNConfig
    
    Returns:
    
    The number of milliseconds to wait.
  - getBulkFlowModTimeout
```
public int getBulkFlowModTimeout()
```
    Return the number of milliseconds to wait for completion of bulk FLOW_MOD requests.
    
    Specified by:
    
    getBulkFlowModTimeout in interface VTNConfig
    
    Returns:
    
    The number of milliseconds to wait.
  - getInitTimeout
```
public int getInitTimeout()
```
    Return the number of milliseconds to wait for another controller in the cluster to complete initialization.
    
    Specified by:
    
    getInitTimeout in interface VTNConfig
    
    Returns:
    
    The number of milliseconds to wait.
  - getMaxRedirections
```
public int getMaxRedirections()
```
    Return the maximum number of packet redirections per a flow.
    
    Specified by:
    
    getMaxRedirections in interface VTNConfig
    
    Returns:
    
    The maximum number of packet redirections per a flow.
  - isHostTracking
```
public boolean isHostTracking()
```
    Return a boolean value that determines whether to enable host tracking in the vBridge.
    
    Specified by:
    
    isHostTracking in interface VTNConfig
    
    Returns:
    
    true if host tracking in the vBridge is enabled. false otherwise.
  - getControllerMacAddress
```
public EtherAddress getControllerMacAddress()
```
    Return MAC address of the controller used as source MAC address of ARP packet.
    
    Specified by:
    
    getControllerMacAddress in interface VTNConfig
    
    Returns:
    
    An EtherAddress instance.

Class VTNConfigImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VTNConfigImpl

VTNConfigImpl

VTNConfigImpl

VTNConfigImpl

Method Detail

fillDefault

builder

builder

diff

toVtnConfig

getJaxbValue

equals

hashCode

getJaxbTopologyWait

getJaxbL2FlowPriority

getJaxbFlowModTimeout

getJaxbBulkFlowModTimeout

getJaxbInitTimeout

getJaxbMaxRedirections

getTopologyWait

getL2FlowPriority

getFlowModTimeout

getBulkFlowModTimeout

getInitTimeout

getMaxRedirections

isHostTracking

getControllerMacAddress