<module>ves-nf-oam-adopter-spotbugs</module>
<module>ves-nf-oam-adopter-api</module>
<module>ves-nf-oam-adopter-event-notifier</module>
+ <module>ves-nf-oam-adopter-snmp-manager</module>
</modules>
</project>
\ No newline at end of file
<artifactId>ves-nf-oam-adopter-event-notifier</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>ves-nf-oam-adopter-snmp-manager</artifactId>
+ <version>${project.version}</version>
+ </dependency>
</dependencies>
</dependencyManagement>
</project>
\ No newline at end of file
<sonar.coverage.jacoco.xmlReportPaths>
../ves-nf-oam-adopter-event-notifier/target/site/jacoco-ut/jacoco.xml,
../ves-nf-oam-adopter-event-notifier/target/site/jacoco-aggregate/jacoco.xml
+ ../ves-nf-oam-adopter-snmp-manager/target/site/jacoco-ut/jacoco.xml,
+ ../ves-nf-oam-adopter-snmp-manager/target/site/jacoco-aggregate/jacoco.xml
</sonar.coverage.jacoco.xmlReportPaths>
<!--Dependency Versions-->
+ <commons-configuration2.version>2.7</commons-configuration2.version>
+ <commons-io.version>2.6</commons-io.version>
+ <commons-beanutils.version>1.9.4</commons-beanutils.version>
<gson.version>2.8.6</gson.version>
<httpclient5.version>5.0.3</httpclient5.version>
- <lombok.version>1.18.20</lombok.version>
<jdt.annotation.version>2.2.600</jdt.annotation.version>
+ <lombok.version>1.18.20</lombok.version>
<rxjava.version>3.0.12</rxjava.version>
<spotbugs-maven-plugin.version>4.2.3</spotbugs-maven-plugin.version>
<spring.boot.version>2.4.5</spring.boot.version>
+ <snmp4j.version>3.4.4</snmp4j.version>
+ <spotbugs.version>4.2.3</spotbugs.version>
<!--Plugins Versions-->
<sonar.scanner.version>3.8.0.2131</sonar.scanner.version>
<com.puppycrawl.tools.version>8.41</com.puppycrawl.tools.version>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.snmp4j</groupId>
+ <artifactId>snmp4j</artifactId>
+ <version>${snmp4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-configuration2</artifactId>
+ <version>${commons-configuration2.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>commons-io</groupId>
+ <artifactId>commons-io</artifactId>
+ <version>${commons-io.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>commons-beanutils</groupId>
+ <artifactId>commons-beanutils</artifactId>
+ <version>${commons-beanutils.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.github.spotbugs</groupId>
+ <artifactId>spotbugs-annotations</artifactId>
+ <version>${spotbugs.version}</version>
+ </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+* ============LICENSE_START=======================================================
+* O-RAN-SC
+* ================================================================================
+* Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
+* ================================================================================
+* 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.
+* ============LICENSE_END============================================
+*
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.o-ran-sc.oam</groupId>
+ <artifactId>ves-nf-oam-adopter-parent</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <relativePath>../ves-nf-oam-adopter-parent/pom.xml</relativePath>
+ </parent>
+
+ <artifactId>ves-nf-oam-adopter-snmp-manager</artifactId>
+
+ <dependencies>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>ves-nf-oam-adopter-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>com.github.spotbugs</groupId>
+ <artifactId>spotbugs-annotations</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.dataformat</groupId>
+ <artifactId>jackson-dataformat-yaml</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.core</groupId>
+ <artifactId>jackson-databind</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.core</groupId>
+ <artifactId>jackson-annotations</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.snmp4j</groupId>
+ <artifactId>snmp4j</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>io.reactivex.rxjava3</groupId>
+ <artifactId>rxjava</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-configuration2</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>commons-io</groupId>
+ <artifactId>commons-io</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>commons-beanutils</groupId>
+ <artifactId>commons-beanutils</artifactId>
+ </dependency>
+ </dependencies>
+</project>
\ No newline at end of file
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager;
+
+import javax.annotation.PostConstruct;
+import org.o.ran.oam.nf.oam.adopter.api.VesEventNotifier;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.api.TimeZoneOffsetService;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper.SnmpMapper;
+
+public class SnmpManagerImpl implements AutoCloseable {
+ private static final String SNMP_MANAGER_THREAD = "SnmpManager";
+ private final Thread snmpThread;
+
+ /**
+ * Default constructor.
+ */
+ public SnmpManagerImpl(final String host, final int port, final SnmpMapper mapper,
+ final VesEventNotifier vesEventNotifier, final TimeZoneOffsetService timeZoneOffsetService) {
+ final SnmpTrapListener trapListener =
+ new SnmpTrapListener(host, port, mapper, vesEventNotifier, timeZoneOffsetService);
+ this.snmpThread = new Thread(trapListener, SNMP_MANAGER_THREAD);
+ }
+
+ @PostConstruct
+ public void init() {
+ snmpThread.start();
+ }
+
+ @Override
+ public void close() {
+ snmpThread.interrupt();
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager;
+
+import static java.util.Objects.requireNonNull;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.net.URI;
+import java.nio.file.Paths;
+import javax.annotation.PostConstruct;
+import org.apache.commons.configuration2.YAMLConfiguration;
+import org.apache.commons.configuration2.builder.ConfigurationBuilderEvent;
+import org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder;
+import org.apache.commons.configuration2.builder.fluent.Parameters;
+import org.apache.commons.configuration2.event.EventListener;
+import org.apache.commons.configuration2.ex.ConfigurationException;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.VesMappingConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+/**
+ * Reads and listens for changes on snmp mapping configuration.
+ */
+@Service
+public class SnmpMappingConfigurationProvider {
+ private static final Logger LOG = LoggerFactory.getLogger(SnmpMappingConfigurationProvider.class);
+
+ private static final ObjectMapper YAML_READER = new ObjectMapper(new YAMLFactory());
+ @Value("${snmp-manager.mapping-config-path:#{null}}")
+ private String mappingFilePath;
+ private ReloadingFileBasedConfigurationBuilder<YAMLConfiguration> builder;
+
+ /**
+ * Initialize service.
+ * @throws IOException on error
+ */
+ @PostConstruct
+ public void init() throws IOException, ConfigurationException {
+ requireNonNull(mappingFilePath);
+ final URI filePath = Paths.get(mappingFilePath).toUri();
+ builder = new ReloadingFileBasedConfigurationBuilder<>(YAMLConfiguration.class)
+ .configure(new Parameters().hierarchical().setURL(filePath.toURL()));
+ builder.addEventListener(ConfigurationBuilderEvent.CONFIGURATION_REQUEST, (EventListener) event -> {
+ builder.getReloadingController().checkForReloading(null);
+ LOG.info("Reloading {}", filePath);
+ });
+ //Test initial configuration
+ builder.getConfiguration();
+ }
+
+ /**
+ * Reads VesMappingConfiguration from yaml file.
+ *
+ * @return Ves Mapping Configuration
+ */
+ public VesMappingConfiguration getVesMappingConfiguration() throws ConfigurationException, IOException {
+ final YAMLConfiguration configuration = builder.getConfiguration();
+ final StringWriter output = new StringWriter();
+ configuration.write(output);
+ return YAML_READER.readValue(output.toString(), VesMappingConfiguration.class);
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager;
+
+import com.google.gson.Gson;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.IOException;
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.util.Optional;
+import org.o.ran.oam.nf.oam.adopter.api.VesEventNotifier;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.api.TimeZoneOffsetService;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper.SnmpMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.snmp4j.CommandResponder;
+import org.snmp4j.CommandResponderEvent;
+import org.snmp4j.MessageDispatcher;
+import org.snmp4j.MessageDispatcherImpl;
+import org.snmp4j.PDU;
+import org.snmp4j.Snmp;
+import org.snmp4j.mp.MPv2c;
+import org.snmp4j.smi.UdpAddress;
+import org.snmp4j.transport.DefaultUdpTransportMapping;
+import org.snmp4j.util.MultiThreadedMessageDispatcher;
+import org.snmp4j.util.ThreadPool;
+
+final class SnmpTrapListener implements CommandResponder, Runnable {
+
+ private static final Logger LOG = LoggerFactory.getLogger(SnmpTrapListener.class);
+ private static final int THREADS_SIZE = 2;
+ private final String hostPortAddress;
+ private final SnmpMapper mapper;
+ private final VesEventNotifier vesEventNotifier;
+ private final Gson gson = new Gson();
+ private final TimeZoneOffsetService timeZoneOffsetService;
+
+ public SnmpTrapListener(final String host, final Integer port, final SnmpMapper mapper,
+ final VesEventNotifier vesEventNotifier, final TimeZoneOffsetService timeZoneOffsetService) {
+ LOG.info("SnmpTrapListener listening on {}:{}", host, port);
+ this.hostPortAddress = host + "/" + port;
+ this.mapper = mapper;
+ this.vesEventNotifier = vesEventNotifier;
+ this.timeZoneOffsetService = timeZoneOffsetService;
+ }
+
+ @SuppressFBWarnings("WA_NOT_IN_LOOP")
+ @Override
+ public synchronized void run() {
+ try {
+ final UdpAddress udpAddress = new UdpAddress(hostPortAddress);
+ final DefaultUdpTransportMapping snmpTarget = new DefaultUdpTransportMapping(udpAddress);
+ final ThreadPool threadPool = ThreadPool.create("SNMP_V2_Listener", THREADS_SIZE);
+ final MessageDispatcher dispatcher =
+ new MultiThreadedMessageDispatcher(threadPool, new MessageDispatcherImpl());
+ dispatcher.addMessageProcessingModel(new MPv2c());
+
+ final Snmp snmp = new Snmp(dispatcher, snmpTarget);
+ snmp.addCommandResponder(this);
+
+ snmpTarget.listen();
+ LOG.debug("Listening on {}", snmpTarget);
+ try {
+ wait();
+ } catch (final InterruptedException ex) {
+ Thread.currentThread().interrupt();
+ }
+ } catch (final IOException e) {
+ LOG.error("Error occurred while listening to SNMP messages: {}", e.getMessage());
+ }
+ }
+
+ /**
+ * This method will be called whenever a pdu is received on the given port
+ * specified in the listen() method.
+ */
+ @Override
+ public synchronized void processPdu(final CommandResponderEvent cmdRespEvent) {
+ LOG.info("Received PDU");
+ final PDU pdu = cmdRespEvent.getPDU();
+ if (pdu == null) {
+ LOG.warn("Ignoring PDU.");
+ return;
+ }
+
+ final UdpAddress address = (UdpAddress) cmdRespEvent.getPeerAddress();
+ final ZoneId optZoneId = timeZoneOffsetService.getTimeZone(address.getInetAddress().getHostAddress());
+ final String timeZone = Optional.ofNullable(optZoneId)
+ .map(zoneId -> "UTC" + LocalDateTime.now().atZone(zoneId).getOffset()
+ .toString()).orElse(null);
+
+ mapper.toEvent(address, timeZone, pdu)
+ .flatMapCompletable(vesEventNotifier::notifyEvents)
+ .doOnSubscribe(result -> LOG.debug("SNMP Trap processing started"))
+ .doOnComplete(() -> LOG.debug("SNMP Trap processed successfully"))
+ .doOnError(error -> LOG.error("Failed to process SNMP Trap", error)).subscribe();
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.api;
+
+import java.time.ZoneId;
+import org.eclipse.jdt.annotation.Nullable;
+
+public interface TimeZoneOffsetService {
+
+ /**
+ * Returns Time zone of specific device if present.
+ */
+ @Nullable ZoneId getTimeZone(String host);
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.configurations;
+
+import org.o.ran.oam.nf.oam.adopter.api.VesEventNotifier;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.SnmpManagerImpl;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.api.TimeZoneOffsetService;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper.SnmpMapper;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.properties.SnmpManagerProperties;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableConfigurationProperties
+public class SnmpManagerConfig {
+ private final SnmpManagerProperties snmpManagerProperties;
+ private final SnmpMapper snmpMapper;
+ private final VesEventNotifier vesEventNotifier;
+ private final TimeZoneOffsetService timeZoneOffsetService;
+
+ /**
+ * Snmp Manager Configuration Constructor.
+ */
+ @Autowired
+ public SnmpManagerConfig(final SnmpManagerProperties snmpManagerProperties, final SnmpMapper snmpMapper,
+ final VesEventNotifier vesEventNotifier, final TimeZoneOffsetService timeZoneOffsetService) {
+ this.snmpManagerProperties = snmpManagerProperties;
+ this.snmpMapper = snmpMapper;
+ this.vesEventNotifier = vesEventNotifier;
+ this.timeZoneOffsetService = timeZoneOffsetService;
+ }
+
+ @Bean
+ public SnmpManagerImpl getSnmpManagerService() {
+ return new SnmpManagerImpl(snmpManagerProperties.getHost(), snmpManagerProperties.getPort(), snmpMapper,
+ vesEventNotifier, timeZoneOffsetService);
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper;
+
+import java.util.Optional;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.o.ran.oam.nf.oam.adopter.api.CommonEventHeader;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.TrapsMappingConfiguration;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.VesMappingConfiguration;
+import org.snmp4j.PDU;
+import org.snmp4j.smi.OID;
+import org.snmp4j.smi.UdpAddress;
+import org.snmp4j.smi.Variable;
+
+/**
+ * Follows
+ * https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves7_1spec.html#datatype-commoneventheader
+ */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+final class CommonEventHeaderHandler {
+ static CommonEventHeader toCommonEventHeader(final UdpAddress peerAddress,
+ final VesMappingConfiguration vesMappingConfig, final TrapsMappingConfiguration mappingConfiguration,
+ final PDU pdu, final String timeZone) {
+ final CommonEventHeader header = new CommonEventHeader();
+ setMandatoryFields(header, peerAddress, vesMappingConfig, mappingConfiguration, pdu);
+ setOptionalFields(header, vesMappingConfig, mappingConfiguration, pdu, timeZone);
+ return header;
+ }
+
+ private static void setOptionalFields(final CommonEventHeader header,
+ final VesMappingConfiguration vesMappingConfig, final TrapsMappingConfiguration mappingConfiguration,
+ final PDU pdu, final String timeZone) {
+ header.setNfVendorName(vesMappingConfig.getNfVendorName());
+ final String oidEntityId = mappingConfiguration.getOidReportingEntityID();
+ if (oidEntityId != null) {
+ final Variable uuid = pdu.getVariable(new OID(oidEntityId));
+ header.setReportingEntityId(uuid == null ? null : uuid.toString());
+ }
+ header.setNfNamingCode(null); //NOP
+ header.setNfcNamingCode(null); //NOP
+ if (timeZone != null) {
+ header.setTimeZoneOffset(timeZone);
+ }
+ }
+
+ private static void setMandatoryFields(final CommonEventHeader header, final UdpAddress peerAddress,
+ final VesMappingConfiguration vesMappingConfig, final TrapsMappingConfiguration mappingConfiguration,
+ final PDU pdu) {
+ header.setDomain(CommonEventHeader.Domain.FAULT);
+
+ final Optional<OID> eventIdOid = Optional.ofNullable(mappingConfiguration.getOidEventId()).map(OID::new);
+ final Optional<Variable> eventIdValue = eventIdOid.map(pdu::getVariable);
+ final String eventId = eventIdValue.map(Variable::toString).orElse(pdu.getRequestID().toString());
+ header.setEventId(eventId);
+ header.setEventName(
+ CommonEventHeader.Domain.FAULT.name() + "_" + vesMappingConfig.getReportingEntityName() + "_"
+ + mappingConfiguration.getName());
+
+ final String oidStartEpoch = mappingConfiguration.getEventStartEpochMicrosec();
+ if (oidStartEpoch != null) {
+ final Variable uuid = pdu.getVariable(new OID(oidStartEpoch));
+ header.setStartEpochMicrosec(uuid == null ? null : Long.valueOf(uuid.toString()));
+ } else {
+ header.setStartEpochMicrosec(System.currentTimeMillis());
+ }
+
+ final String oidLastEpoch = mappingConfiguration.getEventLastEpochMicrosec();
+ if (oidLastEpoch != null) {
+ final Variable uuid = pdu.getVariable(new OID(oidLastEpoch));
+ header.setLastEpochMicrosec(uuid == null ? null : Long.valueOf(uuid.toString()));
+ } else {
+ header.setLastEpochMicrosec(System.currentTimeMillis());
+ }
+ header.setPriority(CommonEventHeader.Priority.HIGH);
+ header.setReportingEntityName(vesMappingConfig.getReportingEntityName());
+ header.setReportingEntityId(vesMappingConfig.getReportingEntityId());
+ header.setSequence(extractEventSequence(mappingConfiguration, pdu));
+ final String oidSourceName = mappingConfiguration.getOidSourceName();
+ if (oidSourceName != null) {
+ final Variable sourceName = pdu.getVariable(new OID(oidSourceName));
+ header.setSourceName(sourceName.toString());
+ } else {
+ header.setSourceName(peerAddress.getInetAddress().getHostAddress());
+ }
+ header.setVersion(CommonEventHeader.Version._4_0);
+ header.setVesEventListenerVersion(Optional.ofNullable(vesMappingConfig.getVesEventListenerVersion())
+ .map(CommonEventHeader.VesEventListenerVersion::fromValue)
+ .orElse(CommonEventHeader.VesEventListenerVersion._7_1));
+ }
+
+ private static long extractEventSequence(final TrapsMappingConfiguration mappingConfiguration, final PDU pdu) {
+ final Optional<String> optEventSequenceOid = Optional.ofNullable(mappingConfiguration.getOidEventSequence());
+ if (optEventSequenceOid.isPresent()) {
+ final String eventSequenceOid = optEventSequenceOid.get();
+ if (!eventSequenceOid.contains(".")) {
+ return Long.parseLong(eventSequenceOid);
+ }
+ final Optional<Variable> optValue = Optional.ofNullable(pdu.getVariable(new OID(eventSequenceOid)));
+ if (optValue.isPresent()) {
+ return optValue.get().toLong();
+ }
+ }
+ return 0L;
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper;
+
+import static org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper.SnmpMapperImpl.DEFAULT;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.o.ran.oam.nf.oam.adopter.api.FaultFields;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.TrapsMappingConfiguration;
+import org.snmp4j.PDU;
+import org.snmp4j.smi.OID;
+import org.snmp4j.smi.Variable;
+import org.snmp4j.smi.VariableBinding;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+final class FaultFieldsHandler {
+ private static final String SNMP_FAULT = "SNMP_Fault";
+ private static final String SNMP_UNKNOWN = "Unknown";
+
+ public static FaultFields toFaultFields(final TrapsMappingConfiguration trapsDescription, final PDU pdu) {
+ final FaultFields faultFields = new FaultFields();
+ setMandatoryFields(faultFields, trapsDescription, pdu);
+ setOptionalFields(faultFields, trapsDescription, pdu);
+ return faultFields;
+ }
+
+ private static void setMandatoryFields(final FaultFields faultFields,
+ final TrapsMappingConfiguration trapsDescription, final PDU pdu) {
+ faultFields.setAlarmCondition(trapsDescription.getName());
+ faultFields.setEventSeverity(FaultFields.EventSeverity.fromValue(trapsDescription.getOidEventSeverity()));
+ faultFields.setEventSourceType(Optional.ofNullable(trapsDescription.getEventSourceType()).orElse(SNMP_UNKNOWN));
+ faultFields.setFaultFieldsVersion(FaultFields.FaultFieldsVersion._4_0);
+ final String descOid = trapsDescription.getOidSpecificProblemDesc();
+ faultFields.setSpecificProblem(SNMP_FAULT);
+ if (descOid != null && !DEFAULT.equals(descOid)) {
+ final Variable desc = pdu.getVariable(new OID(descOid));
+ faultFields.setSpecificProblem(desc == null ? SNMP_FAULT : desc.toString());
+ }
+ faultFields.setVfStatus(FaultFields.VfStatus.ACTIVE);
+ }
+
+ private static void setOptionalFields(final FaultFields faultFields,
+ final TrapsMappingConfiguration trapsDescription, final PDU pdu) {
+ final List<? extends VariableBinding> variables = pdu.getVariableBindings();
+ final Map<String, String> map = variables.stream()
+ .collect(Collectors.toMap(x -> x.getOid().toString(), x -> x.getVariable().toString()));
+
+ faultFields.setAlarmAdditionalInformation(map.isEmpty() ? null : map);
+ final String interfaceOid = trapsDescription.getOidAlarmInterfaceName();
+ if (interfaceOid != null) {
+ final Variable desc = pdu.getVariable(new OID(interfaceOid));
+ faultFields.setAlarmInterfaceA(desc == null ? SNMP_FAULT : desc.toString());
+ }
+ final String eCategory = trapsDescription.getEventCategory();
+ faultFields.setEventCategory(eCategory);
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper;
+
+import io.reactivex.rxjava3.core.Maybe;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.o.ran.oam.nf.oam.adopter.api.CommonEventFormat302ONAP;
+import org.snmp4j.PDU;
+import org.snmp4j.smi.UdpAddress;
+
+public interface SnmpMapper {
+ /**
+ * Translate SNMP protocol data unit to ONAP Event.
+ *
+ * @param peerAddress sender address
+ * @param timeZone sender time zone in UTC Format (E.g. UTC+02:00
+ * @param pdu SNMP protocol data unit
+ * @return event or null if translation not supported
+ */
+ @NonNull Maybe<CommonEventFormat302ONAP> toEvent(
+ @NonNull UdpAddress peerAddress,
+ @Nullable String timeZone,
+ @NonNull PDU pdu);
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.mapper;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import io.reactivex.rxjava3.core.Maybe;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import org.o.ran.oam.nf.oam.adopter.api.CommonEventFormat302ONAP;
+import org.o.ran.oam.nf.oam.adopter.api.Event;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.SnmpMappingConfigurationProvider;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.TrapsMappingConfiguration;
+import org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos.VesMappingConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.snmp4j.PDU;
+import org.snmp4j.smi.OID;
+import org.snmp4j.smi.UdpAddress;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+@Service
+public class SnmpMapperImpl implements SnmpMapper {
+ private static final Logger LOG = LoggerFactory.getLogger(SnmpMapperImpl.class);
+ public static final String DEFAULT = "default";
+ public static final OID SNMP_TRAP_OID = new OID("1.3.6.1.6.3.1.1.4.1.0");
+ private final SnmpMappingConfigurationProvider snmpMappingConfigurationProvider;
+
+ @Autowired
+ public SnmpMapperImpl(final SnmpMappingConfigurationProvider snmpMappingConfigurationProvider) {
+ this.snmpMappingConfigurationProvider = snmpMappingConfigurationProvider;
+ }
+
+ @Override
+ @SuppressFBWarnings("REC_CATCH_EXCEPTION")
+ public Maybe<CommonEventFormat302ONAP> toEvent(final UdpAddress peerAddress, final String timeZone, final PDU pdu) {
+ try {
+ final int eventType = pdu.getType();
+ if (pdu.getType() != PDU.NOTIFICATION) {
+ LOG.warn("SNMP Event type {} not supported, ignoring event.", eventType);
+ return Maybe.empty();
+ }
+ LOG.info("Starting Mapping of SNMP Event type {}.", eventType);
+ LOG.trace("Pdu received {}.", pdu);
+ final Event event = new Event();
+ final String trapOidVariable = pdu.getVariable(SNMP_TRAP_OID).toString();
+ final VesMappingConfiguration vesMappingConfig =
+ snmpMappingConfigurationProvider.getVesMappingConfiguration();
+ final Map<String, TrapsMappingConfiguration> trapsDescriptions = vesMappingConfig.getTraps().stream()
+ .collect(Collectors.toMap(TrapsMappingConfiguration::getOid, trapsDescription -> trapsDescription));
+ final TrapsMappingConfiguration trapsDescription =
+ Optional.ofNullable(trapsDescriptions.get(trapOidVariable)).orElse(trapsDescriptions.get(DEFAULT));
+ event.setCommonEventHeader(CommonEventHeaderHandler.toCommonEventHeader(peerAddress, vesMappingConfig,
+ trapsDescription, pdu, timeZone));
+ event.setFaultFields(FaultFieldsHandler.toFaultFields(trapsDescription, pdu));
+ final CommonEventFormat302ONAP eventFormat = new CommonEventFormat302ONAP();
+ eventFormat.setEvent(event);
+ eventFormat.setEventList(null);
+ LOG.info("Mapping of SNMP Event type {} finished.", eventType);
+ return Maybe.just(eventFormat);
+ } catch (final Exception e) {
+ return Maybe.error(e);
+ }
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+public class TrapsMappingConfiguration {
+ @JsonProperty("oid")
+ private String oid;
+ @JsonProperty("name")
+ private String name;
+ @JsonProperty("oid-event-id")
+ private String oidEventId;
+ @JsonProperty("event-severity")
+ private String oidEventSeverity;
+ @JsonProperty("oid-specific-problem-desc")
+ private String oidSpecificProblemDesc;
+ @JsonProperty("oid-source-name")
+ private String oidSourceName;
+ @JsonProperty("oid-reporting-entity-id")
+ private String oidReportingEntityID;
+ @JsonProperty("oid-alarm-interface-name")
+ private String oidAlarmInterfaceName;
+ @JsonProperty("event-category")
+ private String eventCategory;
+ @JsonProperty("event-source-type")
+ private String eventSourceType;
+ @JsonProperty("oid-event-sequence")
+ private String oidEventSequence;
+ @JsonProperty("oid-start-epoch-microsec")
+ private String eventStartEpochMicrosec;
+ @JsonProperty("oid-last-epoch-microsec")
+ private String eventLastEpochMicrosec;
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.pojos;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+public class VesMappingConfiguration {
+ @JsonProperty("reporting-entity-name")
+ private String reportingEntityName;
+ @JsonProperty("reporting-entity-id")
+ private String reportingEntityId;
+ @JsonProperty("nf-vendor-name")
+ private String nfVendorName;
+ @JsonProperty("traps")
+ private List<TrapsMappingConfiguration> traps;
+ @JsonProperty("ves-event-listener-version")
+ private String vesEventListenerVersion;
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * O-RAN-SC
+ * ================================================================================
+ * Copyright © 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.o.ran.oam.nf.oam.adopter.snmp.manager.properties;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+@Component
+@ConfigurationProperties(prefix = "snmp-manager")
+@Data
+@NoArgsConstructor
+public class SnmpManagerProperties {
+ private String host;
+ private int port;
+}
Code Review / oam / nf-oam-adopter.git / commitdiff