org.onosproject.scalablegateway.api

Interface ScalableGatewayService

All Known Implementing Classes:

ScalableGatewayManager

public interface ScalableGatewayService

ScalableGateWay Service Interface.

Method Summary

Modifier and Type	Method and Description
boolean	addGatewayNode(GatewayNode gatewayNode) Adds gateway node in scalableGW application.
boolean	deleteGatewayNode(GatewayNode gatewayNode) Removes gateway node in scalableGW application.
List<org.onosproject.net.DeviceId>	getGatewayDeviceIds() Returns the list of gateway`s device identifiers.
org.onosproject.core.GroupId	getGatewayGroupId(org.onosproject.net.DeviceId srcDeviceId) Returns group id for gateway load balance.
GatewayNode	getGatewayNode(org.onosproject.net.DeviceId deviceId) Returns gateway node with the given device identifier.
List<GatewayNode>	getGatewayNodes() Returns the list of gateway node information with the given device identifier.
org.onosproject.net.PortNumber	getUplinkPort(org.onosproject.net.DeviceId deviceId) Returns the uplink port number of the gateway with the supplied device ID.

Method Detail

getGatewayNode

GatewayNode getGatewayNode(org.onosproject.net.DeviceId deviceId)

Returns gateway node with the given device identifier.

Parameters:

deviceId - The gateway node deviceId

Returns:

The gateway node information

getUplinkPort

org.onosproject.net.PortNumber getUplinkPort(org.onosproject.net.DeviceId deviceId)

Returns the uplink port number of the gateway with the supplied device ID.

Parameters:

deviceId - the gateway node device id

Returns:

the external interface port number

getGatewayGroupId

org.onosproject.core.GroupId getGatewayGroupId(org.onosproject.net.DeviceId srcDeviceId)

Returns group id for gateway load balance. If the group does not exist in the supplied source device, creates one.

Parameters:

srcDeviceId - source device id

Returns:

The group id

getGatewayNodes

List<GatewayNode> getGatewayNodes()

Returns the list of gateway node information with the given device identifier.

Returns:

The list of gateway node information

getGatewayDeviceIds

List<org.onosproject.net.DeviceId> getGatewayDeviceIds()

Returns the list of gateway`s device identifiers.

Returns:

The list of device identifier]

addGatewayNode

boolean addGatewayNode(GatewayNode gatewayNode)

Adds gateway node in scalableGW application.

Parameters:

gatewayNode - Target gateway node

Returns:

Result of method call

deleteGatewayNode

boolean deleteGatewayNode(GatewayNode gatewayNode)

Removes gateway node in scalableGW application.

Parameters:

gatewayNode - Target gateway node

Returns:

Result of method call