Move deprecated flow batch APIs to a less obvious place
Change-Id: I8078aadbafad1e5a339d74859bed94e25c9c6e8c
diff --git a/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEntry.java b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEntry.java
new file mode 100644
index 0000000..905af60
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEntry.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.flow.oldbatch;
+
+import org.onosproject.net.flow.BatchOperationEntry;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.oldbatch.FlowRuleBatchEntry.FlowRuleOperation;
+
+@Deprecated
+/**
+ * @deprecated in Drake release - no longer a public API
+ */
+public class FlowRuleBatchEntry
+ extends BatchOperationEntry<FlowRuleOperation, FlowRule> {
+
+ private final Long id; // FIXME: consider using Optional<Long>
+
+ public FlowRuleBatchEntry(FlowRuleOperation operator, FlowRule target) {
+ super(operator, target);
+ this.id = null;
+ }
+
+ public FlowRuleBatchEntry(FlowRuleOperation operator, FlowRule target, Long id) {
+ super(operator, target);
+ this.id = id;
+ }
+
+ public Long id() {
+ return id;
+ }
+
+ public enum FlowRuleOperation {
+ ADD,
+ REMOVE,
+ MODIFY
+ }
+
+}
diff --git a/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEvent.java b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEvent.java
new file mode 100644
index 0000000..ab41753
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchEvent.java
@@ -0,0 +1,117 @@
+/*
+ * Copyright 2014-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.flow.oldbatch;
+
+import org.onosproject.event.AbstractEvent;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.flow.CompletedBatchOperation;
+
+@Deprecated
+/**
+ * Describes flow rule batch event.
+ *
+ * @deprecated in Drake release - no longer a public API
+ */
+public final class FlowRuleBatchEvent extends AbstractEvent<FlowRuleBatchEvent.Type, FlowRuleBatchRequest> {
+
+
+ /**
+ * Type of flow rule events.
+ */
+ public enum Type {
+
+ // Request has been forwarded to MASTER Node
+ /**
+ * Signifies that a batch operation has been initiated.
+ */
+ BATCH_OPERATION_REQUESTED,
+
+ // MASTER Node has pushed the batch down to the Device
+ // (e.g., Received barrier reply)
+ /**
+ * Signifies that a batch operation has completed.
+ */
+ BATCH_OPERATION_COMPLETED,
+ }
+
+ private final CompletedBatchOperation result;
+ private final DeviceId deviceId;
+
+ /**
+ * Constructs a new FlowRuleBatchEvent.
+ *
+ * @param request batch operation request
+ * @param deviceId the device this batch will be processed on
+ * @return event.
+ */
+ public static FlowRuleBatchEvent requested(FlowRuleBatchRequest request, DeviceId deviceId) {
+ FlowRuleBatchEvent event = new FlowRuleBatchEvent(Type.BATCH_OPERATION_REQUESTED, request, deviceId);
+ return event;
+ }
+
+ /**
+ * Constructs a new FlowRuleBatchEvent.
+ * @param request batch operation request.
+ * @param result completed batch operation result.
+ * @return event.
+ */
+ public static FlowRuleBatchEvent completed(FlowRuleBatchRequest request, CompletedBatchOperation result) {
+ FlowRuleBatchEvent event = new FlowRuleBatchEvent(Type.BATCH_OPERATION_COMPLETED, request, result);
+ return event;
+ }
+
+ /**
+ * Returns the result of this batch operation.
+ * @return batch operation result.
+ */
+ public CompletedBatchOperation result() {
+ return result;
+ }
+
+ /**
+ * Returns the deviceId for this batch.
+ * @return device id
+ */
+ public DeviceId deviceId() {
+ return deviceId;
+ }
+
+ /**
+ * Creates an event of a given type and for the specified flow rule batch.
+ *
+ * @param type flow rule batch event type
+ * @param request event flow rule batch subject
+ * @param result the result of the batch operation
+ */
+ private FlowRuleBatchEvent(Type type, FlowRuleBatchRequest request, CompletedBatchOperation result) {
+ super(type, request);
+ this.result = result;
+ this.deviceId = result.deviceId();
+ }
+
+ /**
+ * Creates an event of a given type and for the specified flow rule batch.
+ *
+ * @param type flow rule batch event type
+ * @param request event flow rule batch subject
+ * @param deviceId the device id for this batch
+ */
+ private FlowRuleBatchEvent(Type type, FlowRuleBatchRequest request, DeviceId deviceId) {
+ super(type, request);
+ this.result = null;
+ this.deviceId = deviceId;
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchOperation.java b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchOperation.java
new file mode 100644
index 0000000..d252e6a
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchOperation.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2014-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.flow.oldbatch;
+
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.flow.BatchOperation;
+
+import java.util.Collection;
+
+@Deprecated
+/**
+ * Class used with the flow subsystem to process per device
+ * batches.
+ *
+ * @deprecated in Drake release - no longer a public API
+ */
+public class FlowRuleBatchOperation
+ extends BatchOperation<FlowRuleBatchEntry> {
+
+ /**
+ * This id is used to cary to id of the original
+ * FlowOperations and track where this batch operation
+ * came from. The id is unique cluster wide.
+ */
+ private final long id;
+ private final DeviceId deviceId;
+
+ public FlowRuleBatchOperation(Collection<FlowRuleBatchEntry> operations,
+ DeviceId deviceId, long flowOperationId) {
+ super(operations);
+ this.id = flowOperationId;
+ this.deviceId = deviceId;
+ }
+
+ public DeviceId deviceId() {
+ return this.deviceId;
+ }
+
+ public long id() {
+ return id;
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchRequest.java b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchRequest.java
new file mode 100644
index 0000000..33539e4
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/FlowRuleBatchRequest.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2014-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.flow.oldbatch;
+
+import java.util.List;
+import java.util.Set;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Lists;
+import org.onosproject.net.DeviceId;
+
+@Deprecated
+/**
+ * @deprecated in Drake release - no longer a public API
+ */
+public class FlowRuleBatchRequest {
+
+ /**
+ * This id is used to carry to id of the original
+ * FlowOperations and track where this batch operation
+ * came from. The id is unique cluster wide.
+ */
+ private final long batchId;
+
+ private final Set<FlowRuleBatchEntry> ops;
+
+ public FlowRuleBatchRequest(long batchId, Set<FlowRuleBatchEntry> ops) {
+ this.batchId = batchId;
+ this.ops = ImmutableSet.copyOf(ops);
+ }
+
+ public Set<FlowRuleBatchEntry> ops() {
+ return ops;
+ }
+
+ public FlowRuleBatchOperation asBatchOperation(DeviceId deviceId) {
+ List<FlowRuleBatchEntry> entries = Lists.newArrayList();
+ entries.addAll(ops);
+ return new FlowRuleBatchOperation(entries, deviceId, batchId);
+ }
+
+ public long batchId() {
+ return batchId;
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/net/flow/oldbatch/package-info.java b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/package-info.java
new file mode 100644
index 0000000..20cb7a3
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/flow/oldbatch/package-info.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Flow rule model & related services API definitions.
+ *
+ * <p>
+ * The figure below depicts the general interactions between different
+ * components of the intent subsystem.<br>
+ * <img src="doc-files/flow-design.png" alt="ONOS flow rule subsystem design">
+ * </p>
+ */
+package org.onosproject.net.flow.oldbatch;