AbstractYangModelRegistrator updated to allow apps to attach end-points to the service models

Change-Id: I2f893d0f77730cecae961bb9233aefe3c49cf4b1
diff --git a/apps/l3vpn/netl3vpn/BUCK b/apps/l3vpn/netl3vpn/BUCK
index d4d436a..4028606 100644
--- a/apps/l3vpn/netl3vpn/BUCK
+++ b/apps/l3vpn/netl3vpn/BUCK
@@ -5,6 +5,7 @@
   '//core/store/serializers:onos-core-serializers',
   '//lib:onos-yang-model',
   '//lib:onos-yang-runtime',
+  '//apps/yang:onos-apps-yang',
 ]
 
 TEST_DEPS = [
diff --git a/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/L3VpnModelRegistrator.java b/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/L3VpnModelRegistrator.java
new file mode 100644
index 0000000..d7c6702
--- /dev/null
+++ b/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/L3VpnModelRegistrator.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2017-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.l3vpn.netl3vpn.impl;
+
+import com.google.common.collect.ImmutableMap;
+import org.apache.felix.scr.annotations.Component;
+import org.onosproject.yang.AbstractYangModelRegistrator;
+import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev20130715.IetfInetTypes;
+import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.IetfL3VpnSvc;
+import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev20130715.IetfYangTypes;
+import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.l3vpn.svc.ext.rev20160730.L3VpnSvcExt;
+import org.onosproject.yang.model.DefaultYangModuleId;
+import org.onosproject.yang.model.YangModuleId;
+import org.onosproject.yang.runtime.AppModuleInfo;
+import org.onosproject.yang.runtime.DefaultAppModuleInfo;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Representation of L3VPN model registrator which registers L3VPN service
+ * model.
+ */
+@Component(immediate = true)
+public class L3VpnModelRegistrator extends AbstractYangModelRegistrator {
+
+    /**
+     * Creates L3VPN model registrator.
+     */
+    public L3VpnModelRegistrator() {
+        super(IetfL3VpnSvc.class, getAppInfo());
+    }
+
+    private static Map<YangModuleId, AppModuleInfo> getAppInfo() {
+        Map<YangModuleId, AppModuleInfo> appInfo = new HashMap<>();
+        appInfo.put(new DefaultYangModuleId("ietf-inet-types", "2013-00-15"),
+                    new DefaultAppModuleInfo(IetfInetTypes.class, null));
+        appInfo.put(new DefaultYangModuleId("ietf-l3vpn-svc", "2016-00-30"),
+                    new DefaultAppModuleInfo(IetfL3VpnSvc.class, null));
+        appInfo.put(new DefaultYangModuleId("ietf-yang-types", "2013-00-15"),
+                    new DefaultAppModuleInfo(IetfYangTypes.class, null));
+        appInfo.put(new DefaultYangModuleId("l3vpn-svc-ext", "2016-00-30"),
+                    new DefaultAppModuleInfo(L3VpnSvcExt.class, null));
+        return ImmutableMap.copyOf(appInfo);
+    }
+}
diff --git a/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/NetL3VpnManager.java b/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/NetL3VpnManager.java
index 67c6237..7d427ba 100644
--- a/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/NetL3VpnManager.java
+++ b/apps/l3vpn/netl3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/impl/NetL3VpnManager.java
@@ -53,9 +53,7 @@
 import org.onosproject.net.Port;
 import org.onosproject.net.device.DeviceService;
 import org.onosproject.net.driver.DriverService;
-import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev20130715.IetfInetTypes;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev20140508.ietfinterfaces.devices.device.Interfaces;
-import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.IetfL3VpnSvc;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.ietfl3vpnsvc.DefaultL3VpnSvc;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.ietfl3vpnsvc.L3VpnSvc;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.ietfl3vpnsvc.accessvpnpolicy.VpnAttachment;
@@ -76,8 +74,6 @@
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.ietfl3vpnsvc.siterouting.RoutingProtocols;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.l3vpn.svc.rev20160730.ietfl3vpnsvc.siterouting.routingprotocols.RoutingProtocol;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.instance.rev20160623.ietfnetworkinstance.devices.device.NetworkInstances;
-import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev20130715.IetfYangTypes;
-import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.l3vpn.svc.ext.rev20160730.L3VpnSvcExt;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.l3vpn.svc.ext.rev20160730.l3vpnsvcext.l3vpnsvc.sites.site.sitenetworkaccesses.sitenetworkaccess.bearer.DefaultAugmentedL3VpnBearer;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.l3vpn.svc.ext.rev20160730.l3vpnsvcext.l3vpnsvc.sites.site.sitenetworkaccesses.sitenetworkaccess.bearer.requestedtype.DefaultAugmentedL3VpnRequestedType;
 import org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.l3vpn.svc.ext.rev20160730.l3vpnsvcext.requestedtypegrouping.requestedtypeprofile.RequestedTypeChoice;
@@ -92,12 +88,6 @@
 import org.onosproject.yang.model.NodeKey;
 import org.onosproject.yang.model.ResourceData;
 import org.onosproject.yang.model.ResourceId;
-import org.onosproject.yang.model.YangModel;
-import org.onosproject.yang.model.YangModuleId;
-import org.onosproject.yang.runtime.DefaultAppModuleInfo;
-import org.onosproject.yang.runtime.DefaultModelRegistrationParam;
-import org.onosproject.yang.runtime.ModelRegistrationParam;
-import org.onosproject.yang.runtime.YangModelRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -145,7 +135,6 @@
 import static org.onosproject.l3vpn.netl3vpn.impl.NetL3VpnUtil.getVpnBgpDelModObj;
 import static org.onosproject.l3vpn.netl3vpn.impl.NetL3VpnUtil.getVpnCreateModObj;
 import static org.onosproject.l3vpn.netl3vpn.impl.NetL3VpnUtil.getVpnDelModObj;
-import static org.onosproject.yang.runtime.helperutils.YangApacheUtils.getYangModel;
 
 /**
  * The IETF net l3vpn manager implementation.
@@ -177,9 +166,6 @@
     protected DeviceService deviceService;
 
     @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    protected YangModelRegistry modelRegistry;
-
-    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
     protected ModelConverter modelConverter;
 
     @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
@@ -200,27 +186,21 @@
 
     private ApplicationId appId;
 
-    private ModelRegistrationParam regParam;
-
     private ResourceId id;
 
     private ResourceId module;
 
     private ResourceId sites;
 
-    private boolean isElectedLeader = false;
+    private boolean isElectedLeader;
 
     @Activate
     protected void activate() {
         appId = coreService.registerApplication(APP_ID);
         l3VpnIdGen = coreService.getIdGenerator(L3_VPN_ID_TOPIC);
-
         localNodeId = clusterService.getLocalNode().id();
-
         leadershipService.addListener(leadershipEventListener);
         leadershipService.runForLeadership(appId.name());
-
-        registerModel();
         getResourceId();
         configService.addListener(configListener);
         log.info("Started");
@@ -228,51 +208,12 @@
 
     @Deactivate
     protected void deactivate() {
-        modelRegistry.unregisterModel(regParam);
         configService.removeListener(configListener);
-
         leadershipService.withdraw(appId.name());
         leadershipService.removeListener(leadershipEventListener);
-
         log.info("Stopped");
     }
 
-    private void registerModel() {
-        YangModel model = getYangModel(IetfInetTypes.class);
-        Iterator<YangModuleId> it = model.getYangModulesId().iterator();
-
-        //Create model registration param.
-        ModelRegistrationParam.Builder b =
-                DefaultModelRegistrationParam.builder().setYangModel(model);
-
-        YangModuleId id;
-        while (it.hasNext()) {
-            id = it.next();
-            switch (id.moduleName()) {
-                case "ietf-inet-types":
-                    b.addAppModuleInfo(id, new DefaultAppModuleInfo(
-                            IetfInetTypes.class, null));
-                    break;
-                case "ietf-l3vpn-svc":
-                    b.addAppModuleInfo(id, new DefaultAppModuleInfo(
-                            IetfL3VpnSvc.class, null));
-                    break;
-                case "ietf-yang-types":
-                    b.addAppModuleInfo(id, new DefaultAppModuleInfo(
-                            IetfYangTypes.class, null));
-                    break;
-                case "l3vpn-svc-ext":
-                    b.addAppModuleInfo(id, new DefaultAppModuleInfo(
-                            L3VpnSvcExt.class, null));
-                    break;
-                default:
-                    break;
-            }
-        }
-        regParam = b.build();
-        modelRegistry.registerModel(regParam);
-    }
-
     /**
      * Returns id as string. If the id is not in the freed list a new id is
      * generated else the id from the freed list is used.
diff --git a/apps/yang/src/main/java/org/onosproject/yang/AbstractYangModelRegistrator.java b/apps/yang/src/main/java/org/onosproject/yang/AbstractYangModelRegistrator.java
index 55e2a06..9180e16 100644
--- a/apps/yang/src/main/java/org/onosproject/yang/AbstractYangModelRegistrator.java
+++ b/apps/yang/src/main/java/org/onosproject/yang/AbstractYangModelRegistrator.java
@@ -22,12 +22,17 @@
 import org.apache.felix.scr.annotations.Reference;
 import org.apache.felix.scr.annotations.ReferenceCardinality;
 import org.onosproject.yang.model.YangModel;
+import org.onosproject.yang.model.YangModuleId;
+import org.onosproject.yang.runtime.AppModuleInfo;
 import org.onosproject.yang.runtime.DefaultModelRegistrationParam;
 import org.onosproject.yang.runtime.ModelRegistrationParam;
+import org.onosproject.yang.runtime.ModelRegistrationParam.Builder;
 import org.onosproject.yang.runtime.YangModelRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.Map;
+
 import static org.onosproject.yang.runtime.helperutils.YangApacheUtils.getYangModel;
 
 /**
@@ -38,10 +43,9 @@
 
     private final Logger log = LoggerFactory.getLogger(getClass());
     private final Class<?> loaderClass;
-
     @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
     protected YangModelRegistry modelRegistry;
-
+    private Map<YangModuleId, AppModuleInfo> appInfo;
     private YangModel model;
     private ModelRegistrationParam registrationParam;
 
@@ -49,21 +53,46 @@
      * Creates a model registrator primed with the class-loader of the specified
      * class.
      *
-     * @param loaderClass class whose class loader is to be used for locating schema data
+     * @param loaderClass class whose class loader is to be used for locating
+     *                    schema data
      */
     protected AbstractYangModelRegistrator(Class<?> loaderClass) {
         this.loaderClass = loaderClass;
     }
 
+    /**
+     * Creates a model registrator primed with the class-loader of the specified
+     * class and application info.
+     *
+     * @param loaderClass class whose class loader is to be used for locating
+     *                    schema data
+     * @param appInfo     application information
+     */
+    protected AbstractYangModelRegistrator(Class<?> loaderClass,
+                                           Map<YangModuleId, AppModuleInfo> appInfo) {
+        this.loaderClass = loaderClass;
+        this.appInfo = appInfo;
+    }
+
     @Activate
     protected void activate() {
         model = getYangModel(loaderClass);
-        registrationParam = DefaultModelRegistrationParam.builder()
-                .setYangModel(model).build();
+        ModelRegistrationParam.Builder b =
+                DefaultModelRegistrationParam.builder().setYangModel(model);
+        registrationParam = getAppInfo(b).setYangModel(model).build();
         modelRegistry.registerModel(registrationParam);
         log.info("Started");
     }
 
+    private ModelRegistrationParam.Builder getAppInfo(Builder b) {
+        if (appInfo != null) {
+            appInfo.entrySet().stream().filter(
+                    entry -> model.getYangModule(entry.getKey()) != null).forEach(
+                    entry -> b.addAppModuleInfo(entry.getKey(), entry.getValue()));
+        }
+        return b;
+    }
+
     @Deactivate
     protected void deactivate() {
         modelRegistry.unregisterModel(registrationParam);