ves-nf-oam-adopter/ves-nf-oam-adopter-snmp-manager/src/main/java/org/o/ran/oam/nf/oam/adopter/snmp/manager/mapper/SnmpMapper.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.mapper;
  21
  22 import io.reactivex.rxjava3.core.Maybe;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.o.ran.oam.nf.oam.adopter.api.CommonEventFormat302ONAP;
  26 import org.snmp4j.PDU;
  27 import org.snmp4j.smi.UdpAddress;
  28
  29 public interface SnmpMapper {
  30     /**
  31      * Translate SNMP protocol data unit to ONAP Event.
  32      *
  33      * @param peerAddress sender address
  34      * @param timeZone    sender time zone in UTC Format (E.g. UTC+02:00
  35      * @param pdu         SNMP protocol data unit
  36      * @return event or null if translation not supported
  37      */
  38     @NonNull Maybe<CommonEventFormat302ONAP> toEvent(
  39             @NonNull UdpAddress peerAddress,
  40             @Nullable String timeZone,
  41             @NonNull PDU pdu);
  42 }