HIGUCHI Yuta
Committed by Gerrit Code Review

Documenting current limitation in OpenFlowOpticalSwitch.

- Background information can be found in ONOS-3736 and the following thread:
 https://gerrit.onosproject.org/#/c/6945/1

Change-Id: I47644b9045fb5aa6c371a25894fb5bee0121a3ac
...@@ -15,9 +15,27 @@ ...@@ -15,9 +15,27 @@
15 */ 15 */
16 package org.onosproject.openflow.controller; 16 package org.onosproject.openflow.controller;
17 17
18 +import java.util.List;
19 +
20 +import org.projectfloodlight.openflow.protocol.OFPortDesc;
21 +
22 +import com.google.common.annotations.Beta;
23 +
18 /** 24 /**
19 * A marker interface for optical switches, which require the ability to pass 25 * A marker interface for optical switches, which require the ability to pass
20 * port information to a Device provider. 26 * port information to a Device provider.
21 */ 27 */
22 public interface OpenFlowOpticalSwitch extends OpenFlowSwitch, WithTypedPorts { 28 public interface OpenFlowOpticalSwitch extends OpenFlowSwitch, WithTypedPorts {
29 +
30 + // OpenFlowOpticalSwitch only returns Ethernet ports.
31 + // This is a limitation due to issue described in ONOS-3796.
32 + // This method should return all port type once the limitation is fixed.
33 + /**
34 + * Returns a list of standard (Ethernet) ports.
35 + *
36 + * @return List of standard (Ethernet) ports
37 + */
38 + @Beta
39 + @Override
40 + abstract List<OFPortDesc> getPorts();
23 } 41 }
......