org.opendaylight.vtn.manager.internal.util.vnode

Class VTNMacMapConfig

java.lang.Object

org.opendaylight.vtn.manager.internal.util.vnode.VTNMacMapConfig

public final class VTNMacMapConfig
extends Object

VTNMacMapConfig describes configuration information about a MAC mapping configured in a vBridge.

Constructor Summary

Constructors

Constructor and Description
VTNMacMapConfig() Construct an empty MAC mapping configuration.
VTNMacMapConfig(VtnMacMapConfig vmmc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	containsMacAddress(NavigableSet<MacVlan> set, long addr) Determine whether the specified MAC address is contained in the given set or not.
boolean	equals(Object o) Determine whether the given object is identical to this object.
Set<MacVlan>	getAllowedHosts() Return a set of hosts to be mapped by MAC mapping.
static RpcException	getAlreadyMappedException(long mac) Create an exception that indicates the specified MAC address is already mapped to this vBridge.
Set<MacVlan>	getDeniedHosts() Return a set of hosts not to be mapped by MAC mapping.
static RpcException	getDuplicateMacAddressException(long mac) Create an exception that indicates the same MAC address is configured in the allowed host set.
int	hashCode() Return the hash code of this object.
boolean	isEmpty() Determine whether the MAC mapping configuration is empty or not.
MacMapConfig	toMacMapConfig() Convert this instance into a MacMapConfig instance.
MacMapChange	update(VtnUpdateOperationType op, List<VlanHostDesc> allowed, List<VlanHostDesc> denied) Update the MAC mapping configuration.
MacMapChange	update(VtnUpdateOperationType op, VtnAclType aclType, List<VlanHostDesc> hosts) Update the specified access control list.
void	verify() Verify the contents of this instance.
static MacVlan	verifyDeniedHost(MacVlan mv) Verify a host information in the denied host set.
static MacVlan	verifyDeniedHost(VlanHostDesc host) Verify a host information in the denied host set.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNMacMapConfig

public VTNMacMapConfig()

Construct an empty MAC mapping configuration.

VTNMacMapConfig

public VTNMacMapConfig(VtnMacMapConfig vmmc)
                throws RpcException

Construct a new instance.

Parameters:

vmmc - A VtnMacMapConfig instance.

Throws:

RpcException - vmmc contains invalid configuration.

Method Detail

getDuplicateMacAddressException

public static RpcException getDuplicateMacAddressException(long mac)

Create an exception that indicates the same MAC address is configured in the allowed host set.

Parameters:

mac - A MAC address.

Returns:

A RpcException instance.

getAlreadyMappedException

public static RpcException getAlreadyMappedException(long mac)

Create an exception that indicates the specified MAC address is already mapped to this vBridge.

Parameters:

mac - A MAC address.

Returns:

A RpcException instance.

verifyDeniedHost

public static MacVlan verifyDeniedHost(VlanHostDesc host)
                                throws RpcException

Verify a host information in the denied host set.

Parameters:

host - A VlanHostDesc instance.

Returns:

A MacVlan instance converted from host.

Throws:

RpcException - The given host information cannot be added to the denied host set.

verifyDeniedHost

public static MacVlan verifyDeniedHost(MacVlan mv)
                                throws RpcException

Verify a host information in the denied host set.

Parameters:

mv - A MacVlan instance.

Returns:

The given instance.

Throws:

RpcException - The given host information cannot be added to the denied host set.

containsMacAddress

public static boolean containsMacAddress(NavigableSet<MacVlan> set,
                                         long addr)

Determine whether the specified MAC address is contained in the given set or not.

Parameters:

set - A set of MacVlan instances.

addr - A MAC address to be tested.

Returns:

true is returned only if the MAC address specified by addr is contained in set.

getAllowedHosts

public Set<MacVlan> getAllowedHosts()

Return a set of hosts to be mapped by MAC mapping.

Returns:

A set of hosts to be mapped by MAC mapping.

getDeniedHosts

public Set<MacVlan> getDeniedHosts()

Return a set of hosts not to be mapped by MAC mapping.

Returns:

A set of hosts not to be mapped by MAC mapping.

toMacMapConfig

public MacMapConfig toMacMapConfig()

Convert this instance into a MacMapConfig instance.

Returns:

A MacMapConfig instance.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

isEmpty

public boolean isEmpty()

Determine whether the MAC mapping configuration is empty or not.

Returns:

true only if this MAC mapping configuration is empty.

update

public MacMapChange update(VtnUpdateOperationType op,
                           List<VlanHostDesc> allowed,
                           List<VlanHostDesc> denied)
                    throws RpcException

Update the MAC mapping configuration.

This method updates both the allowed and denied host set. Note that the caller must discard this instance if this method throws an exception.

Parameters:

op - A VtnUpdateOperationType instance which indicates how to update the MAC mapping configuration.

allowed - A list of VlanHostDesc instances that indicates the changes made to the allowed host set.

denied - A list of VlanHostDesc instances that indicates the changes made to the denied host set.

Returns:

A MacMapChange instance if the configuration has been changed. null if not changed.

Throws:

RpcException - An error occurred.

update

public MacMapChange update(VtnUpdateOperationType op,
                           VtnAclType aclType,
                           List<VlanHostDesc> hosts)
                    throws RpcException

Update the specified access control list.

Note that the caller must discard this instance if this method throws an exception.

Parameters:

op - A VtnUpdateOperationType instance which indicates how to change the MAC mapping configuration.

aclType - The type of access control list.

hosts - A list of VlanHostDesc instances.

Returns:

A MacMapChange instance if the configuration has been changed. null if not changed.

Throws:

RpcException - An error occurred.

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.