etri.sdn.controller.module.topologymanager

Interface ITopologyService

All Superinterfaces:

IService

All Known Implementing Classes:

OFMTopologyManager

public interface ITopologyService
extends IService

This interface is used to define a service that OFMTopologyManager should implement.

Author:

SaeHyong Park (labry@etri.re.kr)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ITopologyListener listener)
NodePortTuple	getAllowedIncomingBroadcastPort(long src, short srcPort) If the src broadcast domain port is not allowed for incoming broadcast, this method provides the topologically equivalent incoming broadcast-allowed src port.
NodePortTuple	getAllowedIncomingBroadcastPort(long src, short srcPort, boolean tunnelEnabled)
NodePortTuple	getAllowedOutgoingBroadcastPort(long src, short srcPort, long dst, short dstPort) If the dst is not allowed by the higher-level topology, this method provides the topologically equivalent broadcast port.
NodePortTuple	getAllowedOutgoingBroadcastPort(long src, short srcPort, long dst, short dstPort, boolean tunnelEnabled)
java.util.Set<NodePortTuple>	getBlockedPorts() Returns a set of blocked ports.
java.util.Set<NodePortTuple>	getBroadcastDomainPorts() Gets the set of ports that belong to a broadcast domain.
java.util.Set<java.lang.Short>	getBroadcastPorts(long targetSw, long src, short srcPort) Get broadcast ports on a target switch for a given attachmentpoint point port.
java.util.Set<java.lang.Short>	getBroadcastPorts(long targetSw, long src, short srcPort, boolean tunnelEnabled)
NodePortTuple	getIncomingSwitchPort(long src, short srcPort, long dst, short dstPort)
NodePortTuple	getIncomingSwitchPort(long src, short srcPort, long dst, short dstPort, boolean tunnelEnabled)
long	getL2DomainId(long switchId) Returns the identifier of the L2 domain of a given switch.
long	getL2DomainId(long switchId, boolean tunnelEnabled)
java.util.List<ILinkDiscoveryListener.LDUpdate>	getLastLinkUpdates() ITopologyListener provides topologyChanged notification, but not *what* the changes were.
java.util.Date	getLastUpdateTime()
long	getOpenflowDomainId(long switchId)
long	getOpenflowDomainId(long switchId, boolean tunnelEnabled)
NodePortTuple	getOutgoingSwitchPort(long src, short srcPort, long dst, short dstPort) Get the proper outgoing switchport for a given pair of src-dst switchports.
NodePortTuple	getOutgoingSwitchPort(long src, short srcPort, long dst, short dstPort, boolean tunnelEnabled)
java.util.Set<java.lang.Integer>	getPorts(long sw) Switch methods
java.util.Set<java.lang.Integer>	getPortsWithLinks(long sw) Gets a list of ports on a given switch that are known to topology.
java.util.Set<java.lang.Integer>	getPortsWithLinks(long sw, boolean tunnelEnabled)
java.util.Set<NodePortTuple>	getTunnelPorts()
boolean	inSameL2Domain(long switch1, long switch2) Queries whether two switches are in the same island.
boolean	inSameL2Domain(long switch1, long switch2, boolean tunnelEnabled)
boolean	inSameOpenflowDomain(long switch1, long switch2) Queries whether two switches are in the same cluster.
boolean	inSameOpenflowDomain(long switch1, long switch2, boolean tunnelEnabled)
boolean	isAllowed(long sw, short portId)
boolean	isAllowed(long sw, short portId, boolean tunnelEnabled)
boolean	isAttachmentPointPort(long switchid, short port) Query to determine if devices must be learned on a given switch port.
boolean	isAttachmentPointPort(long switchid, short port, boolean tunnelEnabled)
boolean	isBroadcastDomainPort(long sw, short port)
boolean	isBroadcastDomainPort(long sw, short port, boolean tunnelEnabled)
boolean	isConsistent(long oldSw, short oldPort, long newSw, short newPort) Indicates if an attachment point on the new switch port is consistent with the attachment point on the old switch port or not.
boolean	isConsistent(long oldSw, short oldPort, long newSw, short newPort, boolean tunnelEnabled)
boolean	isIncomingBroadcastAllowed(long sw, short portId)
boolean	isIncomingBroadcastAllowed(long sw, short portId, boolean tunnelEnabled)
boolean	isInSameBroadcastDomain(long s1, short p1, long s2, short p2) Indicates if the two switch ports are connected to the same broadcast domain or not.
boolean	isInSameBroadcastDomain(long s1, short p1, long s2, short p2, boolean tunnelEnabled)

Method Detail

addListener

void addListener(ITopologyListener listener)

getLastUpdateTime

java.util.Date getLastUpdateTime()

isAttachmentPointPort

boolean isAttachmentPointPort(long switchid,
                            short port)

Query to determine if devices must be learned on a given switch port.

isAttachmentPointPort

boolean isAttachmentPointPort(long switchid,
                            short port,
                            boolean tunnelEnabled)

getOpenflowDomainId

long getOpenflowDomainId(long switchId)

getOpenflowDomainId

long getOpenflowDomainId(long switchId,
                       boolean tunnelEnabled)

getL2DomainId

long getL2DomainId(long switchId)

Returns the identifier of the L2 domain of a given switch.

Parameters:

switchId - The DPID of the switch in long form

Returns:

The DPID of the switch that is the key for the cluster

getL2DomainId

long getL2DomainId(long switchId,
                 boolean tunnelEnabled)

inSameOpenflowDomain

boolean inSameOpenflowDomain(long switch1,
                           long switch2)

Queries whether two switches are in the same cluster.

Parameters:

switch1 -

switch2 -

Returns:

true if the switches are in the same cluster

inSameOpenflowDomain

boolean inSameOpenflowDomain(long switch1,
                           long switch2,
                           boolean tunnelEnabled)

inSameL2Domain

boolean inSameL2Domain(long switch1,
                     long switch2)

Queries whether two switches are in the same island. Currently, island and cluster are the same. In future, islands could be different than clusters.

Parameters:

switch1 -

switch2 -

Returns:

True of they are in the same island, false otherwise

inSameL2Domain

boolean inSameL2Domain(long switch1,
                     long switch2,
                     boolean tunnelEnabled)

isBroadcastDomainPort

boolean isBroadcastDomainPort(long sw,
                            short port)

isBroadcastDomainPort

boolean isBroadcastDomainPort(long sw,
                            short port,
                            boolean tunnelEnabled)

isAllowed

boolean isAllowed(long sw,
                short portId)

isAllowed

boolean isAllowed(long sw,
                short portId,
                boolean tunnelEnabled)

isConsistent

boolean isConsistent(long oldSw,
                   short oldPort,
                   long newSw,
                   short newPort)

Indicates if an attachment point on the new switch port is consistent with the attachment point on the old switch port or not.

isConsistent

boolean isConsistent(long oldSw,
                   short oldPort,
                   long newSw,
                   short newPort,
                   boolean tunnelEnabled)

isInSameBroadcastDomain

boolean isInSameBroadcastDomain(long s1,
                              short p1,
                              long s2,
                              short p2)

Indicates if the two switch ports are connected to the same broadcast domain or not.

Parameters:

s1 -

p1 -

s2 -

p2 -

Returns:

true if two switch port is in the same broadcast domain, false otherwise

isInSameBroadcastDomain

boolean isInSameBroadcastDomain(long s1,
                              short p1,
                              long s2,
                              short p2,
                              boolean tunnelEnabled)

getPortsWithLinks

java.util.Set<java.lang.Integer> getPortsWithLinks(long sw)

Gets a list of ports on a given switch that are known to topology.

Parameters:

sw - The switch DPID in long

Returns:

The set of ports on this switch

getPortsWithLinks

java.util.Set<java.lang.Integer> getPortsWithLinks(long sw,
                                                 boolean tunnelEnabled)

getBroadcastPorts

java.util.Set<java.lang.Short> getBroadcastPorts(long targetSw,
                                               long src,
                                               short srcPort)

Get broadcast ports on a target switch for a given attachmentpoint point port.

getBroadcastPorts

java.util.Set<java.lang.Short> getBroadcastPorts(long targetSw,
                                               long src,
                                               short srcPort,
                                               boolean tunnelEnabled)

isIncomingBroadcastAllowed

boolean isIncomingBroadcastAllowed(long sw,
                                 short portId)

isIncomingBroadcastAllowed

boolean isIncomingBroadcastAllowed(long sw,
                                 short portId,
                                 boolean tunnelEnabled)

getOutgoingSwitchPort

NodePortTuple getOutgoingSwitchPort(long src,
                                  short srcPort,
                                  long dst,
                                  short dstPort)

Get the proper outgoing switchport for a given pair of src-dst switchports.

getOutgoingSwitchPort

NodePortTuple getOutgoingSwitchPort(long src,
                                  short srcPort,
                                  long dst,
                                  short dstPort,
                                  boolean tunnelEnabled)

getIncomingSwitchPort

NodePortTuple getIncomingSwitchPort(long src,
                                  short srcPort,
                                  long dst,
                                  short dstPort)

getIncomingSwitchPort

NodePortTuple getIncomingSwitchPort(long src,
                                  short srcPort,
                                  long dst,
                                  short dstPort,
                                  boolean tunnelEnabled)

getAllowedOutgoingBroadcastPort

NodePortTuple getAllowedOutgoingBroadcastPort(long src,
                                            short srcPort,
                                            long dst,
                                            short dstPort)

If the dst is not allowed by the higher-level topology, this method provides the topologically equivalent broadcast port.

Parameters:

src -

dst -

Returns:

the allowed broadcast port

getAllowedOutgoingBroadcastPort

NodePortTuple getAllowedOutgoingBroadcastPort(long src,
                                            short srcPort,
                                            long dst,
                                            short dstPort,
                                            boolean tunnelEnabled)

getAllowedIncomingBroadcastPort

NodePortTuple getAllowedIncomingBroadcastPort(long src,
                                            short srcPort)

If the src broadcast domain port is not allowed for incoming broadcast, this method provides the topologically equivalent incoming broadcast-allowed src port.

Parameters:

src -

srcPort -

Returns:

the allowed broadcast port

getAllowedIncomingBroadcastPort

NodePortTuple getAllowedIncomingBroadcastPort(long src,
                                            short srcPort,
                                            boolean tunnelEnabled)

getBroadcastDomainPorts

java.util.Set<NodePortTuple> getBroadcastDomainPorts()

Gets the set of ports that belong to a broadcast domain.

Returns:

The set of ports that belong to a broadcast domain.

getTunnelPorts

java.util.Set<NodePortTuple> getTunnelPorts()

getBlockedPorts

java.util.Set<NodePortTuple> getBlockedPorts()

Returns a set of blocked ports. The set of blocked ports is the union of all the blocked ports across all instances.

Returns:

Set

getLastLinkUpdates

java.util.List<ILinkDiscoveryListener.LDUpdate> getLastLinkUpdates()

ITopologyListener provides topologyChanged notification, but not *what* the changes were. This method returns the delta in the linkUpdates between the current and the previous topology instance.

Returns:

List

getPorts

java.util.Set<java.lang.Integer> getPorts(long sw)

Switch methods