2 * ============LICENSE_START========================================================================
\r
3 * ONAP : tr-069-adapter
\r
4 * =================================================================================================
\r
5 * Copyright (C) 2020 CommScope Inc Intellectual Property.
\r
6 * =================================================================================================
\r
7 * This tr-069-adapter software file is distributed by CommScope Inc under the Apache License,
\r
8 * Version 2.0 (the "License"); you may not use this file except in compliance with the License. You
\r
9 * may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
\r
14 * either express or implied. See the License for the specific language governing permissions and
\r
15 * limitations under the License.
\r
16 * ===============LICENSE_END=======================================================================
\r
19 package org.commscope.tr069adapter.mapper.acs.impl;
\r
21 import java.util.ArrayList;
\r
22 import java.util.Iterator;
\r
23 import java.util.List;
\r
24 import java.util.Map;
\r
25 import org.commscope.tr069adapter.acs.common.DeviceInform;
\r
26 import org.commscope.tr069adapter.acs.common.DeviceRPCRequest;
\r
27 import org.commscope.tr069adapter.acs.common.DeviceRPCResponse;
\r
28 import org.commscope.tr069adapter.acs.common.ParameterDTO;
\r
29 import org.commscope.tr069adapter.acs.common.dto.ConfigurationData;
\r
30 import org.commscope.tr069adapter.acs.common.dto.TR069OperationCode;
\r
31 import org.commscope.tr069adapter.acs.common.dto.TR069OperationDetails;
\r
32 import org.commscope.tr069adapter.acs.common.inform.BootInform;
\r
33 import org.commscope.tr069adapter.acs.common.inform.BootstrapInform;
\r
34 import org.commscope.tr069adapter.mapper.MOMetaData;
\r
35 import org.commscope.tr069adapter.mapper.MapperConfigProperties;
\r
36 import org.commscope.tr069adapter.mapper.sync.SynchronizedRequestHandler;
\r
37 import org.commscope.tr069adapter.mapper.util.MOMetaDataUtil;
\r
38 import org.commscope.tr069adapter.mapper.util.NetconfToTr069MapperUtil;
\r
39 import org.slf4j.Logger;
\r
40 import org.slf4j.LoggerFactory;
\r
41 import org.slf4j.MDC;
\r
42 import org.springframework.beans.factory.annotation.Autowired;
\r
43 import org.springframework.http.HttpEntity;
\r
44 import org.springframework.http.HttpHeaders;
\r
45 import org.springframework.http.MediaType;
\r
46 import org.springframework.http.ResponseEntity;
\r
47 import org.springframework.stereotype.Component;
\r
48 import org.springframework.util.LinkedMultiValueMap;
\r
49 import org.springframework.util.MultiValueMap;
\r
50 import org.springframework.util.StringUtils;
\r
51 import org.springframework.web.client.RestTemplate;
\r
54 public class PnPPreProvisioningHandler {
\r
56 private static final Logger logger = LoggerFactory.getLogger(PnPPreProvisioningHandler.class);
\r
58 private static String clientString = "client";
\r
59 private static final String ADMIN_STATE = "AdminState";
\r
60 private static final String ENODEB_NAME = "X_0005B9_eNBName";
\r
63 SynchronizedRequestHandler syncHandler;
\r
66 MOMetaDataUtil moMetaDataUtil;
\r
69 MapperConfigProperties config;
\r
71 private RestTemplate restTemplate = new RestTemplate();
\r
74 * @param notification
\r
76 public void onDeviceNotification(DeviceInform notification) {
\r
77 String deviceId = null;
\r
79 if (notification instanceof BootstrapInform || notification instanceof BootInform) {
\r
80 logger.debug("Checking whether the PnP pre-configuration is enabled");
\r
81 if (isPreConfigureOnPnPEnabled()) {
\r
83 "Pre-configuration during Bootstrap or Boot is enabled, hence the configuration imported in Config DB shall be provisioned to the device");
\r
85 logger.debug("Pre-configuration on PnP is disabled!!!");
\r
90 if (notification instanceof BootstrapInform) {
\r
91 BootstrapInform bootstrapNotification = (BootstrapInform) notification;
\r
92 deviceId = bootstrapNotification.getDeviceDetails().getDeviceId();
\r
93 MDC.put(clientString, deviceId);
\r
94 logger.info("Bootstrap notification received");
\r
95 performPreProvisioning(deviceId,
\r
96 bootstrapNotification.getDeviceDetails().getSoftwareVersion(),
\r
97 bootstrapNotification.getDeviceDetails().getHardwareVersion(), false);
\r
99 } else if (notification instanceof BootInform) {
\r
100 BootInform bootNotification = (BootInform) notification;
\r
101 deviceId = bootNotification.getDeviceDetails().getDeviceId();
\r
102 MDC.put(clientString, deviceId);
\r
103 logger.info("Boot notification received");
\r
105 performPreProvisioning(deviceId, bootNotification.getDeviceDetails().getSoftwareVersion(),
\r
106 bootNotification.getDeviceDetails().getHardwareVersion(), true);
\r
109 logger.debug("Successfully completed provisioning of PnP mandatory parameters");
\r
111 MDC.remove(clientString);
\r
119 private void performPreProvisioning(String deviceId, String swVersion, String hwVersion,
\r
121 List<DeviceRPCRequest> deviceRPCRequestList =
\r
122 prepareNBIDeviceOperationrequest(deviceId, swVersion, hwVersion, isBoot);
\r
123 if (deviceRPCRequestList.isEmpty()) {
\r
124 logger.debug("No Operation requests exists to perform pre provision on the device");
\r
128 boolean isMandatoryProvFailed = false;
\r
129 for (DeviceRPCRequest deviceRPCRequest : deviceRPCRequestList) {
\r
130 logger.info("Performing PROVISION operation");
\r
131 DeviceRPCResponse deviceRPCResponse = syncHandler.performDeviceOperation(deviceRPCRequest);
\r
132 logger.debug("Received Provisioning Operation result");
\r
133 if (deviceRPCResponse != null && !StringUtils.isEmpty(deviceRPCResponse.getFaultString())) {
\r
134 logger.error("Device operation failed, Reason: {}", deviceRPCResponse.getFaultString());
\r
135 isMandatoryProvFailed = true;
\r
139 logger.debug("Provisioning is successful");
\r
142 if (isMandatoryProvFailed) {
\r
144 .debug("Mandatory provisioning has failed, hence provisioning Admin down on the device");
\r
145 provisionAdminDown(deviceRPCRequestList);
\r
146 logger.debug("AdminDown Provisioning is successful");
\r
150 private void provisionAdminDown(List<DeviceRPCRequest> deviceRPCRequestList) {
\r
151 DeviceRPCRequest adminDownOpRequest = null;
\r
152 for (DeviceRPCRequest nbiDeviceOperationRequest : deviceRPCRequestList) {
\r
153 ParameterDTO param = nbiDeviceOperationRequest.getOpDetails().getParmeters().get(0);
\r
154 if (param.getParamName().endsWith(ADMIN_STATE)) {
\r
155 adminDownOpRequest = nbiDeviceOperationRequest;
\r
159 if (adminDownOpRequest != null) {
\r
160 List<ParameterDTO> adminDownParams = adminDownOpRequest.getOpDetails().getParmeters();
\r
161 for (ParameterDTO adminDownParam : adminDownParams) {
\r
162 adminDownParam.setParamValue("0");
\r
164 DeviceRPCResponse deviceRPCResponse = syncHandler.performDeviceOperation(adminDownOpRequest);
\r
165 if (deviceRPCResponse == null || !StringUtils.isEmpty(deviceRPCResponse.getFaultString())) {
\r
166 logger.error("Device operation failed, Reason: {}", ((deviceRPCResponse == null)
\r
167 ? "Null Operation result" : deviceRPCResponse.getFaultString()));
\r
177 private List<DeviceRPCRequest> prepareNBIDeviceOperationrequest(String deviceId, String swVersion,
\r
178 String hwVersion, boolean isBoot) {
\r
179 logger.debug("Preparing the NBI Device Operation Request");
\r
180 List<DeviceRPCRequest> deviceRPCRequestList = new ArrayList<>();
\r
182 ConfigurationData configData = getDeviceConfigurationData(deviceId, swVersion, hwVersion);
\r
183 if (configData == null || configData.getParameterMONameValueMap().isEmpty()) {
\r
184 logger.debug("No configuration exists for the device");
\r
185 return deviceRPCRequestList;
\r
188 List<ParameterDTO> configParams = new ArrayList<>();
\r
189 List<ParameterDTO> adminStateParams = new ArrayList<>();
\r
190 Map<String, String> paramNameValueMap = configData.getParameterMONameValueMap();
\r
191 Iterator<String> iter = paramNameValueMap.keySet().iterator();
\r
192 while (iter.hasNext()) {
\r
193 String paramName = iter.next();
\r
194 String paramValue = paramNameValueMap.get(paramName);
\r
195 MOMetaData moMetaData = moMetaDataUtil.getMetaDataByTR69Name(paramName, swVersion, hwVersion);
\r
196 if ((isBoot && !paramName.endsWith(ADMIN_STATE)) || moMetaData == null)
\r
198 ParameterDTO parameterDTO = getParameterDTO(paramName, paramValue, moMetaData);
\r
200 if (paramName.endsWith(ADMIN_STATE)) {
\r
201 adminStateParams.add(parameterDTO);
\r
203 configParams.add(parameterDTO);
\r
205 logger.debug("Param -> {} Param Value: {}", paramName, paramValue);
\r
208 if (configParams.isEmpty() && adminStateParams.isEmpty()) {
\r
209 logger.debug("Empty parameters list from config db, hence not performing pre-provision");
\r
210 return deviceRPCRequestList;
\r
213 if (!configParams.isEmpty()) {
\r
214 deviceRPCRequestList.add(createNBIOperationRequest(deviceId, configParams));
\r
217 if (!adminStateParams.isEmpty()) {
\r
218 deviceRPCRequestList.add(createNBIOperationRequest(deviceId, adminStateParams));
\r
221 return deviceRPCRequestList;
\r
224 private ParameterDTO getParameterDTO(String paramName, String paramValue, MOMetaData moMetaData) {
\r
225 String dataType = moMetaData.getDataType();
\r
226 if (dataType.equals("boolean")) {
\r
227 if (paramValue.equalsIgnoreCase("true")) {
\r
229 } else if (paramValue.equalsIgnoreCase("false")) {
\r
233 ParameterDTO parameterDTO = new ParameterDTO(paramName, paramValue);
\r
234 parameterDTO.setDataType(dataType);
\r
236 return parameterDTO;
\r
244 private DeviceRPCRequest createNBIOperationRequest(String deviceId, List<ParameterDTO> params) {
\r
245 TR069OperationDetails opDetails = new TR069OperationDetails();
\r
246 opDetails.setOpCode(TR069OperationCode.SET_PARAMETER_VALUES);
\r
248 return NetconfToTr069MapperUtil.handleParamsOperation(params, opDetails, deviceId);
\r
256 private ConfigurationData getDeviceConfigurationData(String deviceId, String swVersion,
\r
257 String hwVersion) {
\r
258 String configDBURI = getConfigDBURI();
\r
260 "Device Configuration to be fetched from Config DB URI: {}, macId {}, swVersion {}, hwVersion {}",
\r
261 configDBURI, deviceId, swVersion, hwVersion);
\r
262 ConfigurationData configData = null;
\r
265 MultiValueMap<String, String> uriParams = new LinkedMultiValueMap<>();
\r
266 uriParams.add("macId", deviceId);
\r
267 uriParams.add("swVersion", swVersion);
\r
268 uriParams.add("hwVersion", hwVersion);
\r
269 HttpHeaders headers = new HttpHeaders();
\r
270 headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
\r
271 final HttpEntity<MultiValueMap<String, String>> entity = new HttpEntity<>(uriParams, headers);
\r
273 ResponseEntity<ConfigurationData> res =
\r
274 restTemplate.postForEntity(configDBURI, entity, ConfigurationData.class);
\r
275 configData = res.getBody();
\r
276 logger.debug("Successfully retrived config data for device id{} data {}", deviceId,
\r
278 } catch (Exception e) {
\r
279 logger.error("An exception occurred to get the initial device configuration, Reason: {}",
\r
288 private boolean isPreConfigureOnPnPEnabled() {
\r
289 boolean isEnabled = false;
\r
290 String preConfigureOnPnP = config.getPreConfigureOnPNP();
\r
291 if (preConfigureOnPnP != null && ("true".equalsIgnoreCase(preConfigureOnPnP)
\r
292 || "false".equalsIgnoreCase(preConfigureOnPnP))) {
\r
293 isEnabled = Boolean.valueOf(preConfigureOnPnP);
\r
302 private String getConfigDBURI() {
\r
303 return config.getConfigDBUri();
\r
308 * it will return the eNodBName if the configuration is imported
\r
312 public String getEnodeBName(String deviceId, String swVersion, String hwVersion) {
\r
313 String eNodeBName = null;
\r
314 if (isPreConfigureOnPnPEnabled()) {
\r
315 ConfigurationData configData = getDeviceConfigurationData(deviceId, swVersion, hwVersion);
\r
316 if (configData == null || configData.getParameterMONameValueMap().isEmpty()) {
\r
317 logger.debug("No configuration exists for the device");
\r
321 Map<String, String> paramNameValueMap = configData.getParameterMONameValueMap();
\r
322 Iterator<String> iter = paramNameValueMap.keySet().iterator();
\r
323 while (iter.hasNext()) {
\r
324 String paramName = iter.next();
\r
325 if (paramName.endsWith(ENODEB_NAME)) {
\r
326 eNodeBName = paramNameValueMap.get(paramName);
\r