Cleaning up and enhancing driver subsystem and the flow objective subsystem.
Change-Id: Ica600ef1aaa46d19e764cd7a197454a4e0f85a08
diff --git a/core/api/src/main/java/org/onosproject/net/flowobjective/FlowObjectiveService.java b/core/api/src/main/java/org/onosproject/net/flowobjective/FlowObjectiveService.java
index dc5e5e1..14af2b8 100644
--- a/core/api/src/main/java/org/onosproject/net/flowobjective/FlowObjectiveService.java
+++ b/core/api/src/main/java/org/onosproject/net/flowobjective/FlowObjectiveService.java
@@ -21,14 +21,36 @@
import java.util.concurrent.Future;
/**
- * Created by ash on 07/04/15.
+ * Service for programming data plane flow rules in manner independent of
+ * specific device table pipeline configuration.
*/
public interface FlowObjectiveService {
- Future<Boolean> filter(DeviceId deviceId, Collection<FilteringObjective> filterObjectives);
+ /**
+ * Installs the filtering rules onto the specified device.
+ *
+ * @param deviceId device identifier
+ * @param filteringObjectives the collection of filters
+ * @return a future indicating the success of the operation
+ */
+ Future<Boolean> filter(DeviceId deviceId, Collection<FilteringObjective> filteringObjectives);
+ /**
+ * Installs the forwarding rules onto the specified device.
+ *
+ * @param deviceId device identifier
+ * @param forwardingObjectives the collection of forwarding objectives
+ * @return a future indicating the success of the operation
+ */
Future<Boolean> forward(DeviceId deviceId, Collection<ForwardingObjective> forwardingObjectives);
+ /**
+ * Installs the next hop elements into the specified device.
+ *
+ * @param deviceId device identifier
+ * @param nextObjectives the collection of next objectives
+ * @return a future indicating the success of the operation
+ */
Future<Boolean> next(DeviceId deviceId, Collection<NextObjective> nextObjectives);
}