Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yang; |
| 18 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 19 | import org.osgi.service.component.annotations.Activate; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 20 | import org.osgi.service.component.annotations.Deactivate; |
| 21 | import org.osgi.service.component.annotations.Reference; |
| 22 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 23 | import org.onosproject.yang.model.YangModel; |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 24 | import org.onosproject.yang.model.YangModuleId; |
| 25 | import org.onosproject.yang.runtime.AppModuleInfo; |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 26 | import org.onosproject.yang.runtime.DefaultModelRegistrationParam; |
| 27 | import org.onosproject.yang.runtime.ModelRegistrationParam; |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 28 | import org.onosproject.yang.runtime.ModelRegistrationParam.Builder; |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 29 | import org.onosproject.yang.runtime.YangModelRegistry; |
| 30 | import org.slf4j.Logger; |
| 31 | import org.slf4j.LoggerFactory; |
| 32 | |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 33 | import java.util.Map; |
| 34 | |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 35 | import static org.onosproject.yang.runtime.helperutils.YangApacheUtils.getYangModel; |
| 36 | |
| 37 | /** |
| 38 | * Abstract base for self-registering YANG models. |
| 39 | */ |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 40 | public abstract class AbstractYangModelRegistrator { |
| 41 | |
Thomas Vachuska | 803278e | 2017-10-06 11:11:58 -0700 | [diff] [blame] | 42 | protected final Logger log = LoggerFactory.getLogger(getClass()); |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 43 | private final Class<?> loaderClass; |
Thomas Vachuska | c307d21 | 2017-07-31 13:57:20 -0700 | [diff] [blame] | 44 | |
Sean Condon | cf2751f | 2017-11-28 17:29:30 +0000 | [diff] [blame] | 45 | protected Map<YangModuleId, AppModuleInfo> appInfo; |
Sean Condon | d911af9 | 2017-07-19 18:05:27 +0100 | [diff] [blame] | 46 | protected YangModel model; |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 47 | private ModelRegistrationParam registrationParam; |
| 48 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 49 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Thomas Vachuska | c307d21 | 2017-07-31 13:57:20 -0700 | [diff] [blame] | 50 | protected YangModelRegistry modelRegistry; |
| 51 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 52 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Thomas Vachuska | c307d21 | 2017-07-31 13:57:20 -0700 | [diff] [blame] | 53 | protected YangClassLoaderRegistry sourceResolver; |
| 54 | |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 55 | /** |
Thomas Vachuska | 00875fd | 2018-10-23 13:39:00 -0700 | [diff] [blame] | 56 | * Binds the specified YANG model registry. |
| 57 | * |
| 58 | * @param registry model registry |
| 59 | */ |
| 60 | protected void bindModelRegistry(YangModelRegistry registry) { |
| 61 | this.modelRegistry = registry; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Unbinds the specified YANG model registry. |
| 66 | * |
| 67 | * @param registry model registry |
| 68 | */ |
| 69 | protected void unbindModelRegistry(YangModelRegistry registry) { |
| 70 | this.modelRegistry = null; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Binds the specified YANG source resolver registry. |
| 75 | * |
| 76 | * @param resolver model source resolver |
| 77 | */ |
| 78 | protected void bindSourceResolver(YangClassLoaderRegistry resolver) { |
| 79 | this.sourceResolver = resolver; |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Unbinds the specified YANG source resolver registry. |
| 84 | * |
| 85 | * @param resolver model source resolver |
| 86 | */ |
| 87 | protected void unbindSourceResolver(YangClassLoaderRegistry resolver) { |
| 88 | this.sourceResolver = null; |
| 89 | } |
| 90 | |
| 91 | /** |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 92 | * Creates a model registrator primed with the class-loader of the specified |
| 93 | * class. |
| 94 | * |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 95 | * @param loaderClass class whose class loader is to be used for locating |
| 96 | * schema data |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 97 | */ |
| 98 | protected AbstractYangModelRegistrator(Class<?> loaderClass) { |
| 99 | this.loaderClass = loaderClass; |
| 100 | } |
| 101 | |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 102 | /** |
| 103 | * Creates a model registrator primed with the class-loader of the specified |
| 104 | * class and application info. |
| 105 | * |
| 106 | * @param loaderClass class whose class loader is to be used for locating |
| 107 | * schema data |
| 108 | * @param appInfo application information |
| 109 | */ |
| 110 | protected AbstractYangModelRegistrator(Class<?> loaderClass, |
| 111 | Map<YangModuleId, AppModuleInfo> appInfo) { |
| 112 | this.loaderClass = loaderClass; |
| 113 | this.appInfo = appInfo; |
| 114 | } |
| 115 | |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 116 | @Activate |
| 117 | protected void activate() { |
Yuta HIGUCHI | d5c2296 | 2018-05-11 15:04:34 -0700 | [diff] [blame] | 118 | log.info("Starting..."); |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 119 | model = getYangModel(loaderClass); |
Yuta HIGUCHI | d5c2296 | 2018-05-11 15:04:34 -0700 | [diff] [blame] | 120 | log.info("ModelId: {}", model.getYangModelId()); |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 121 | ModelRegistrationParam.Builder b = |
| 122 | DefaultModelRegistrationParam.builder().setYangModel(model); |
| 123 | registrationParam = getAppInfo(b).setYangModel(model).build(); |
Thomas Vachuska | c307d21 | 2017-07-31 13:57:20 -0700 | [diff] [blame] | 124 | sourceResolver.registerClassLoader(model.getYangModelId(), loaderClass.getClassLoader()); |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 125 | modelRegistry.registerModel(registrationParam); |
| 126 | log.info("Started"); |
| 127 | } |
| 128 | |
Sean Condon | d911af9 | 2017-07-19 18:05:27 +0100 | [diff] [blame] | 129 | protected ModelRegistrationParam.Builder getAppInfo(Builder b) { |
Gaurav Agrawal | 8dbd273 | 2017-04-14 18:57:30 +0530 | [diff] [blame] | 130 | if (appInfo != null) { |
| 131 | appInfo.entrySet().stream().filter( |
| 132 | entry -> model.getYangModule(entry.getKey()) != null).forEach( |
| 133 | entry -> b.addAppModuleInfo(entry.getKey(), entry.getValue())); |
| 134 | } |
| 135 | return b; |
| 136 | } |
| 137 | |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 138 | @Deactivate |
| 139 | protected void deactivate() { |
| 140 | modelRegistry.unregisterModel(registrationParam); |
Thomas Vachuska | c307d21 | 2017-07-31 13:57:20 -0700 | [diff] [blame] | 141 | sourceResolver.unregisterClassLoader(model.getYangModelId()); |
Thomas Vachuska | 73436b5 | 2017-03-22 19:50:47 -0700 | [diff] [blame] | 142 | log.info("Stopped"); |
| 143 | } |
| 144 | } |