com.hp.sdn.teamcs

Class TeamControllerServiceAdapter

java.lang.Object

com.hp.sdn.teamcs.TeamControllerServiceAdapter

All Implemented Interfaces:

TeamControllerService

public class TeamControllerServiceAdapter
extends Object
implements TeamControllerService

An adapter for the TeamControllerService API, provided specifically for unit tests to use, to insulate themselves from changes in the API.

Author:

Shaun Wackerly

Constructor Summary

Constructors

Constructor and Description
TeamControllerServiceAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
MessageFuture	enablePort(DataPathId dpid, BigPortNumber port, boolean enable) Instructs the controller to enable or disable the given port on the specified datapath.
Set<DataPathInfo>	getAllDataPathInfo() Returns information describing each of the OpenFlow datapaths currently connected to the controller or team of controller.
Set<DataPathInfo>	getAllLocalDataPathInfo() Returns information describing each of the OpenFlow datapaths currently connected to the controller.
DataPathInfo	getDataPathInfo(DataPathId dpid) Returns information describing a specific OpenFlow datapath.
List<MBodyExperimenter>	getExperimenter(DataPathId dpid) Lists meters configured on the datapath.
List<MBodyFlowStats>	getFlows(DataPathId dpid, TableId tableId) Returns flows installed in the specified table of the given datapath.
List<MBodyGroupDescStats>	getGroupDescription(DataPathId dpid) Returns the groups description on the specified datapath.
MBodyGroupDescStats	getGroupDescription(DataPathId dpid, GroupId groupId) Returns the group description on the specified datapath and groupId.
MBodyGroupFeatures	getGroupFeatures(DataPathId dpid) Returns the supported group features for the specified datapath.
List<MBodyGroupStats>	getGroupStats(DataPathId dpid) Returns the groups statistics on the specified datapath.
MBodyGroupStats	getGroupStats(DataPathId dpid, GroupId groupId) Returns the group statistics on the specified datapath and groupId.
List<MBodyMeterConfig>	getMeterConfig(DataPathId dpid) Lists meters configured on the datapath.
MBodyMeterConfig	getMeterConfig(DataPathId dpid, MeterId meterId) Returns the meter configuration for the given meter ID, from the specified datapath.
MBodyMeterFeatures	getMeterFeatures(DataPathId dpid) Returns the meter features for the specified datapath.
List<MBodyMeterStats>	getMeterStats(DataPathId dpid) Lists meters configured on the datapath.
MBodyMeterStats	getMeterStats(DataPathId dpid, MeterId meterId) Returns the meter statistics for the given meter ID, from the specified datapath.
Port	getPort(DataPathId dpid, BigPortNumber portNumber) Returns the port description for the given port, from the specified datapath.
List<Port>	getPorts(DataPathId dpid) Returns the port description from the specified datapath.
List<MBodyPortStats>	getPortStats(DataPathId dpid) Returns the port statistics from the specified datapath.
MBodyPortStats	getPortStats(DataPathId dpid, BigPortNumber portNumber) Returns the port statistics for the given port, from the specified datapath.
Map<UUID,ControllerStats>	getStats() Returns statistical information about the controller.
List<MessageFuture>	send(List<OpenflowMessage> msgs, DataPathId dpid) Instructs the controller to send the specified list of messages (in order) to the specified datapath.
MessageFuture	send(OpenflowMessage msg, DataPathId dpid) Instructs the controller to send the specified message to the specified datapath.
void	sendFlowMod(OfmFlowMod flowMod, DataPathId dpid) Dispatches the OpenFlow FlowMod message to the given datapath via the Flow Tracker.
MessageFuture	sendGroupMod(OfmGroupMod groupMod, DataPathId dpid) Sends the given GROUP_MOD message to the specified datapath.
MessageFuture	sendMeterMod(OfmMeterMod meterMod, DataPathId dpid) Sends the OpenFlow METER_MOD message to the specified datapath.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeamControllerServiceAdapter

public TeamControllerServiceAdapter()

Method Detail

getAllDataPathInfo

public Set<DataPathInfo> getAllDataPathInfo()

Description copied from interface: TeamControllerService

Returns information describing each of the OpenFlow datapaths currently connected to the controller or team of controller.

Specified by:

getAllDataPathInfo in interface TeamControllerService

Returns:

information describing all connected datapaths

getAllLocalDataPathInfo

public Set<DataPathInfo> getAllLocalDataPathInfo()

Description copied from interface: TeamControllerService

Returns information describing each of the OpenFlow datapaths currently connected to the controller.

Specified by:

getAllLocalDataPathInfo in interface TeamControllerService

Returns:

information describing all connected datapaths

getDataPathInfo

public DataPathInfo getDataPathInfo(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns information describing a specific OpenFlow datapath. This may be null, if no such OpenFlow datapath is currently connected.

Specified by:

getDataPathInfo in interface TeamControllerService

Parameters:

dpid - the datapath id

Returns:

information describing the corresponding datapath

send

public MessageFuture send(OpenflowMessage msg,
                 DataPathId dpid)
                   throws OpenflowException

Description copied from interface: TeamControllerService

Instructs the controller to send the specified message to the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

send in interface TeamControllerService

Parameters:

msg - the OpenFlow message to send

dpid - the OpenFlow datapath to which the message is to be sent

Returns:

a list of message futures

Throws:

OpenflowException - if there was a problem encoding or sending the message

send

public List<MessageFuture> send(List<OpenflowMessage> msgs,
                       DataPathId dpid)
                         throws OpenflowException

Description copied from interface: TeamControllerService

Instructs the controller to send the specified list of messages (in order) to the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

send in interface TeamControllerService

Parameters:

msgs - the OpenFlow messages to send

dpid - the OpenFlow datapath to which the messages are to be sent

Returns:

a message future

Throws:

OpenflowException - if there was a problem encoding or sending the messages

getFlows

public List<MBodyFlowStats> getFlows(DataPathId dpid,
                            TableId tableId)

Description copied from interface: TeamControllerService

Returns flows installed in the specified table of the given datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

If the specified table ID is TableId.ALL or null, all flows from all tables will be returned. Note that table ID is ignored for OpenFlow 1.0 devices.

Specified by:

getFlows in interface TeamControllerService

Parameters:

dpid - the datapath from which the flows are requested

tableId - the ID of the flow table

Returns:

the list of flow statistics entries

sendFlowMod

public void sendFlowMod(OfmFlowMod flowMod,
               DataPathId dpid)
                 throws OpenflowException

Description copied from interface: TeamControllerService

Dispatches the OpenFlow FlowMod message to the given datapath via the Flow Tracker. In an HA mode, when two are more controllers are operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Adds the specified flow to the given datapath if the message's FlowModCommand is ADD. Deletes the specified flow from the given datapath if the message's FlowModCommand is DELETE.

Note that this call is synchronous; blocking until the flow has been accepted or an error occurred.

Specified by:

sendFlowMod in interface TeamControllerService

Parameters:

flowMod - the FlowMod message to send

dpid - the target datapath

Throws:

OpenflowException - if there was a problem encoding or sending the message

getMeterConfig

public List<MBodyMeterConfig> getMeterConfig(DataPathId dpid)

Description copied from interface: TeamControllerService

Lists meters configured on the datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getMeterConfig in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of meter configurations

getMeterConfig

public MBodyMeterConfig getMeterConfig(DataPathId dpid,
                              MeterId meterId)

Description copied from interface: TeamControllerService

Returns the meter configuration for the given meter ID, from the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getMeterConfig in interface TeamControllerService

Parameters:

dpid - the target datapath

meterId - the ID of the meter

Returns:

the meter configuration

getExperimenter

public List<MBodyExperimenter> getExperimenter(DataPathId dpid)

Description copied from interface: TeamControllerService

Lists meters configured on the datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getExperimenter in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of experimenter configurations

sendMeterMod

public MessageFuture sendMeterMod(OfmMeterMod meterMod,
                         DataPathId dpid)
                           throws OpenflowException

Description copied from interface: TeamControllerService

Sends the OpenFlow METER_MOD message to the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Adds the meter to the specified datapath if the message's command is ADD. Modifies the meter on the specified datapath if the message's command is MODIFY. Deletes the meter from the specified datapath if the message's command is DELETE.

Specified by:

sendMeterMod in interface TeamControllerService

Parameters:

meterMod - OpenFlow METER_MOD message to datapath

dpid - the target datapath

Returns:

a message future

Throws:

OpenflowException - if there was a problem sending the METER_MOD message

getGroupDescription

public MBodyGroupDescStats getGroupDescription(DataPathId dpid,
                                      GroupId groupId)

Description copied from interface: TeamControllerService

Returns the group description on the specified datapath and groupId. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getGroupDescription in interface TeamControllerService

Parameters:

dpid - the target datapath

groupId - the ID of the group

Returns:

group description statistics

getGroupDescription

public List<MBodyGroupDescStats> getGroupDescription(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the groups description on the specified datapath.

Specified by:

getGroupDescription in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of group description statistics

getGroupStats

public MBodyGroupStats getGroupStats(DataPathId dpid,
                            GroupId groupId)

Description copied from interface: TeamControllerService

Returns the group statistics on the specified datapath and groupId. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getGroupStats in interface TeamControllerService

Parameters:

dpid - the target datapath

groupId - the ID of the group

Returns:

group statistics object

getGroupStats

public List<MBodyGroupStats> getGroupStats(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the groups statistics on the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getGroupStats in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of group statistics

sendGroupMod

public MessageFuture sendGroupMod(OfmGroupMod groupMod,
                         DataPathId dpid)
                           throws OpenflowException

Description copied from interface: TeamControllerService

Sends the given GROUP_MOD message to the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Adds the group entry to the specified datapath if the message's command is ADD. Modifies the group entry on the specified datapath if the message's command is MODIFY. Deletes the group entry from the specified datapath if the message's command is DELETE.

Specified by:

sendGroupMod in interface TeamControllerService

Parameters:

groupMod - OpenFlow GROUP_MOD message to datapath

dpid - the target datapath

Returns:

a message future

Throws:

OpenflowException - if there was a problem sending the GROUP_MOD message

getPorts

public List<Port> getPorts(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the port description from the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getPorts in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of port statistics

getPort

public Port getPort(DataPathId dpid,
           BigPortNumber portNumber)

Description copied from interface: TeamControllerService

Returns the port description for the given port, from the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getPort in interface TeamControllerService

Parameters:

dpid - the target datapath

portNumber - the target port

Returns:

the port statistics

getStats

public Map<UUID,ControllerStats> getStats()

Description copied from interface: TeamControllerService

Returns statistical information about the controller.

Specified by:

getStats in interface TeamControllerService

Returns:

statistical information about the controller

getPortStats

public List<MBodyPortStats> getPortStats(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the port statistics from the specified datapath.

Note that this is a synchronous call that blocks until all the port statistics replies have returned from the datapath.

Specified by:

getPortStats in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of port statistics

getPortStats

public MBodyPortStats getPortStats(DataPathId dpid,
                          BigPortNumber portNumber)

Description copied from interface: TeamControllerService

Returns the port statistics for the given port, from the specified datapath.

Note that this is a synchronous call that blocks until the port statistics reply has returned from the datapath.

Specified by:

getPortStats in interface TeamControllerService

Parameters:

dpid - the target datapath

portNumber - the target port

Returns:

the port statistics

getMeterStats

public List<MBodyMeterStats> getMeterStats(DataPathId dpid)

Description copied from interface: TeamControllerService

Lists meters configured on the datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Specified by:

getMeterStats in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the list of meter descriptions

getMeterStats

public MBodyMeterStats getMeterStats(DataPathId dpid,
                            MeterId meterId)

Description copied from interface: TeamControllerService

Returns the meter statistics for the given meter ID, from the specified datapath. In an HA mode, when two are more controller operating in a team the implementation has to determine which controller manages the given datapath and send the request to appropriate controller.

Note that this is a synchronous call that blocks until the meter statistics reply has returned from the datapath.

Specified by:

getMeterStats in interface TeamControllerService

Parameters:

dpid - the target datapath

meterId - the target meter ID

Returns:

the meter statistics

getGroupFeatures

public MBodyGroupFeatures getGroupFeatures(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the supported group features for the specified datapath.

Note that this is a synchronous call that blocks until the group features reply has returned from the datapath.

Specified by:

getGroupFeatures in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the group features

getMeterFeatures

public MBodyMeterFeatures getMeterFeatures(DataPathId dpid)

Description copied from interface: TeamControllerService

Returns the meter features for the specified datapath.

Note that this is a synchronous call that blocks until the meter features reply has returned from the datapath.

Specified by:

getMeterFeatures in interface TeamControllerService

Parameters:

dpid - the target datapath

Returns:

the meter features

enablePort

public MessageFuture enablePort(DataPathId dpid,
                       BigPortNumber port,
                       boolean enable)

Description copied from interface: TeamControllerService

Instructs the controller to enable or disable the given port on the specified datapath. A message future is returned, to allow the caller to discover the outcome of the request once it has been satisfied.

Specified by:

enablePort in interface TeamControllerService

Parameters:

dpid - the target datapath

port - the target port

enable - true to enable; false to disable

Returns:

a message future