[ONOS-4691] Refactoring OpticalPortOperator (2/3)
- Define ConfigOperator for a Port
- Refactor OpticalPortOperator as PortConfigOperator
- Add plug-in mechanism for PortConfigOperator on DeviceManager
- Move OpticalPortConfig, OpticalPortOperator to optical-model bundle
Change-Id: I5d416305b0c1b0e31e0ad64baa92d126303548bc
diff --git a/core/api/src/main/java/org/onosproject/net/config/PortConfigOperator.java b/core/api/src/main/java/org/onosproject/net/config/PortConfigOperator.java
new file mode 100644
index 0000000..47886b2
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/config/PortConfigOperator.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * 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.config;
+
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.PortDescription;
+
+import com.google.common.annotations.Beta;
+
+/**
+ * {@link ConfigOperator} for Port.
+ * <p>
+ * Note: We currently assumes {@link PortConfigOperator}s are commutative.
+ */
+@Beta
+public interface PortConfigOperator extends ConfigOperator {
+
+ /**
+ * Binds {@link NetworkConfigService} to use for retrieving configuration.
+ *
+ * @param networkConfigService the service to use
+ */
+ void bindService(NetworkConfigService networkConfigService);
+
+
+ /**
+ * Generates a PortDescription containing fields from a PortDescription and
+ * configuration.
+ *
+ * @param cp {@link ConnectPoint} representing the port.
+ * @param descr input {@link PortDescription}
+ * @return Combined {@link PortDescription}
+ */
+ PortDescription combine(ConnectPoint cp, PortDescription descr);
+
+ /**
+ * Generates a PortDescription containing fields from a PortDescription and
+ * configuration.
+ *
+ * @param did DeviceId which the port described by {@code descr} resides.
+ * @param descr input {@link PortDescription}
+ * @return Combined {@link PortDescription}
+ */
+ default PortDescription combine(DeviceId did, PortDescription descr) {
+ return combine(new ConnectPoint(did, descr.portNumber()), descr);
+ }
+
+}