common/utils.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16
  17 package common
  18
  19 import (
  20         "errors"
  21         "fmt"
  22 )
  23 /*
  24 ValidateAndBuildCellIdKey builds key according to the specified format returns the resulting string
  25  */
  26 func ValidateAndBuildCellIdKey(cellId string) (string, IRNibError) {
  27         if cellId == "" {
  28                 e := errors.New("#utils.ValidateAndBuildCellIdKey - an empty cell id received")
  29                 return "", NewValidationError(e)
  30         }
  31         return fmt.Sprintf("CELL:%s", cellId), nil
  32 }
  33 /*
  34 ValidateAndBuildNrCellIdKey builds key according to the specified format returns the resulting string
  35  */
  36 func ValidateAndBuildNrCellIdKey(cellId string) (string, IRNibError) {
  37         if cellId == "" {
  38                 e := errors.New("#utils.ValidateAndBuildNrCellIdKey - an empty cell id received")
  39                 return "", NewValidationError(e)
  40         }
  41         return fmt.Sprintf("NRCELL:%s", cellId), nil
  42 }
  43 /*
  44 ValidateAndBuildNodeBNameKey builds key according to the specified format returns the resulting string
  45  */
  46 func ValidateAndBuildNodeBNameKey(inventoryName string) (string, IRNibError) {
  47         if inventoryName == "" {
  48                 e := errors.New("#utils.ValidateAndBuildNodeBNameKey - an empty inventory name received")
  49                 return "", NewValidationError(e)
  50         }
  51         return fmt.Sprintf("RAN:%s", inventoryName), nil
  52 }
  53 /*
  54 ValidateAndBuildNodeBIdKey builds key according to the specified format returns the resulting string
  55  */
  56 func ValidateAndBuildNodeBIdKey(nodeType string, plmnId string, nbId string) (string, IRNibError) {
  57         if nodeType == "" {
  58                 e := errors.New("#utils.ValidateAndBuildNodeBIdKey - an empty node type received")
  59                 return "", NewValidationError(e)
  60         }
  61         if plmnId == "" {
  62                 e := errors.New("#utils.ValidateAndBuildNodeBIdKey - an empty plmnId received")
  63                 return "", NewValidationError(e)
  64         }
  65         if nbId == "" {
  66                 e := errors.New("#utils.ValidateAndBuildNodeBIdKey - an empty nbId received")
  67                 return "", NewValidationError(e)
  68         }
  69         return fmt.Sprintf("%s:%s:%s", nodeType, plmnId, nbId), nil
  70 }
  71 /*
  72 ValidateAndBuildCellNamePciKey builds key according to the specified format returns the resulting string
  73  */
  74 func ValidateAndBuildCellNamePciKey(inventoryName string, pci uint32) (string, IRNibError) {
  75         if inventoryName == "" {
  76                 e := errors.New("#utils.ValidateAndBuildCellNamePciKey - an empty inventory name received")
  77                 return "", NewValidationError(e)
  78         }
  79         return fmt.Sprintf("PCI:%s:%02x", inventoryName, pci), nil
  80 }