webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/model/RicRegionList.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2020 AT&T Intellectual Property
   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  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20
  21 package org.oransc.ric.portal.dashboard.model;
  22
  23 import java.util.ArrayList;
  24 import java.util.List;
  25
  26 import org.oransc.ric.portal.dashboard.exception.UnknownInstanceException;
  27
  28 /**
  29  * Used as a bean to publish configuration data in a convenient way.
  30  */
  31 public class RicRegionList {
  32
  33         private final List<RicRegion> regions;
  34
  35         public RicRegionList() {
  36                 this.regions = new ArrayList<>();
  37         }
  38
  39         public RicRegionList(List<RicRegion> list) {
  40                 this.regions = list;
  41         }
  42
  43         public List<RicRegion> getRegions() {
  44                 return regions;
  45         }
  46
  47         /**
  48          * Builds a response that has only key-name pairs.
  49          *
  50          * @return List of RicRegionTransport objects
  51          */
  52         public List<RicRegionTransport> getSimpleInstances() {
  53                 List<RicRegionTransport> response = new ArrayList<>();
  54                 for (RicRegion r : regions)
  55                         response.add(new RicRegionTransport().name(r.getName()).instances(r.getKeyNameList()));
  56                 return response;
  57         }
  58
  59         /**
  60          * Gets the instance with the specified key in any region
  61          *
  62          * @param instanceKey
  63          *                        Key to fetch
  64          * @return Instance
  65          * @throws UnknownInstanceException
  66          *                                      If the key is not known
  67          */
  68         public RicInstance getInstance(String instanceKey) {
  69                 for (RicRegion r : regions)
  70                         for (RicInstance i : r.getInstances())
  71                                 if (i.getKey().equals(instanceKey))
  72                                         return i;
  73                 throw new UnknownInstanceException(instanceKey);
  74         }
  75
  76         @Override
  77         public String toString() {
  78                 return this.getClass().getSimpleName() + "[regions=" + regions + "]";
  79         }
  80
  81 }