ves-nf-oam-adopter/ves-nf-oam-adopter-snmp-manager/src/main/java/org/o/ran/oam/nf/oam/adopter/snmp/manager/SnmpMappingConfigurationProvider.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  O-RAN-SC
   4  *  ================================================================================
   5  *  Copyright © 2021 AT&T Intellectual Property. All rights reserved.
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.o.ran.oam.nf.oam.adopter.snmp.manager;
  21
  22 import static java.util.Objects.requireNonNull;
  23
  24 import com.fasterxml.jackson.databind.ObjectMapper;
  25 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
  26 import java.io.IOException;
  27 import java.io.StringWriter;
  28 import java.net.URI;
  29 import java.nio.file.Paths;
  30 import javax.annotation.PostConstruct;
  31 import org.apache.commons.configuration2.YAMLConfiguration;
  32 import org.apache.commons.configuration2.builder.ConfigurationBuilderEvent;
  33 import org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder;
  34 import org.apache.commons.configuration2.builder.fluent.Parameters;
  35 import org.apache.commons.configuration2.ex.ConfigurationException;
  36 import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.VesMappingConfiguration;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.springframework.beans.factory.annotation.Value;
  40 import org.springframework.stereotype.Service;
  41
  42 /**
  43  * Reads and listens for changes on snmp mapping configuration.
  44  */
  45 @Service
  46 public class SnmpMappingConfigurationProvider {
  47     private static final Logger LOG = LoggerFactory.getLogger(SnmpMappingConfigurationProvider.class);
  48
  49     private static final ObjectMapper YAML_READER = new ObjectMapper(new YAMLFactory());
  50     @Value("${snmp-manager.mapping-config-path:#{null}}")
  51     private String mappingFilePath;
  52     private ReloadingFileBasedConfigurationBuilder<YAMLConfiguration> builder;
  53
  54     /**
  55      * Initialize service.
  56      * @throws IOException on error
  57      */
  58     @PostConstruct
  59     public void init() throws IOException, ConfigurationException {
  60         requireNonNull(mappingFilePath);
  61         final URI filePath = Paths.get(mappingFilePath).toUri();
  62         builder = new ReloadingFileBasedConfigurationBuilder<>(YAMLConfiguration.class)
  63                 .configure(new Parameters().hierarchical().setURL(filePath.toURL()));
  64         builder.addEventListener(ConfigurationBuilderEvent.CONFIGURATION_REQUEST, event -> {
  65             builder.getReloadingController().checkForReloading(null);
  66             LOG.info("Reloading {}", filePath);
  67         });
  68         //Test initial configuration
  69         builder.getConfiguration();
  70     }
  71
  72     /**
  73      * Reads VesMappingConfiguration from yaml file.
  74      *
  75      * @return Ves Mapping Configuration
  76      */
  77     public VesMappingConfiguration getVesMappingConfiguration() throws ConfigurationException, IOException {
  78         final YAMLConfiguration configuration = builder.getConfiguration();
  79         final StringWriter output = new StringWriter();
  80         configuration.write(output);
  81         return YAML_READER.readValue(output.toString(), VesMappingConfiguration.class);
  82     }
  83 }