policy-agent/src/main/java/org/oransc/policyagent/repository/Ric.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   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.policyagent.repository;
  22
  23 import java.util.Collection;
  24 import java.util.HashMap;
  25 import java.util.Map;
  26 import java.util.Vector;
  27
  28 import lombok.Getter;
  29 import lombok.Setter;
  30
  31 import org.oransc.policyagent.clients.A1Client.A1ProtocolType;
  32 import org.oransc.policyagent.configuration.RicConfig;
  33
  34 /**
  35  * Represents the dynamic information about a NearRealtime-RIC.
  36  */
  37 public class Ric {
  38     private final RicConfig ricConfig;
  39     @Getter
  40     @Setter
  41     private RicState state = RicState.UNDEFINED;
  42     private Map<String, PolicyType> supportedPolicyTypes = new HashMap<>();
  43     @Getter
  44     @Setter
  45     private A1ProtocolType protocolVersion = A1ProtocolType.UNKNOWN;
  46
  47     /**
  48      * Creates the Ric. Initial state is {@link RicState.NOT_INITIATED}.
  49      *
  50      * @param ricConfig The {@link RicConfig} for this Ric.
  51      */
  52     public Ric(RicConfig ricConfig) {
  53         this.ricConfig = ricConfig;
  54     }
  55
  56     public String name() {
  57         return ricConfig.name();
  58     }
  59
  60     public RicConfig getConfig() {
  61         return this.ricConfig;
  62     }
  63
  64     /**
  65      * Gets the nodes managed by this Ric.
  66      *
  67      * @return a vector containing the nodes managed by this Ric.
  68      */
  69     public Vector<String> getManagedElementIds() {
  70         return ricConfig.managedElementIds();
  71     }
  72
  73     /**
  74      * Determines if the given node is managed by this Ric.
  75      *
  76      * @param managedElementId the node name to check.
  77      * @return true if the given node is managed by this Ric.
  78      */
  79     public boolean isManaging(String managedElementId) {
  80         return ricConfig.managedElementIds().contains(managedElementId);
  81     }
  82
  83     /**
  84      * Adds the given node as managed by this Ric.
  85      *
  86      * @param managedElementId the node to add.
  87      */
  88     public void addManagedElement(String managedElementId) {
  89         if (!ricConfig.managedElementIds().contains(managedElementId)) {
  90             ricConfig.managedElementIds().add(managedElementId);
  91         }
  92     }
  93
  94     /**
  95      * Removes the given node as managed by this Ric.
  96      *
  97      * @param managedElementId the node to remove.
  98      */
  99     public void removeManagedElement(String managedElementId) {
 100         ricConfig.managedElementIds().remove(managedElementId);
 101     }
 102
 103     /**
 104      * Gets the policy types supported by this Ric.
 105      *
 106      * @return the policy types supported by this Ric in an unmodifiable list.
 107      */
 108     public Collection<PolicyType> getSupportedPolicyTypes() {
 109         return supportedPolicyTypes.values();
 110     }
 111
 112     public Collection<String> getSupportedPolicyTypeNames() {
 113         return supportedPolicyTypes.keySet();
 114     }
 115
 116     /**
 117      * Adds a policy type as supported by this Ric.
 118      *
 119      * @param type the policy type to support.
 120      */
 121     public void addSupportedPolicyType(PolicyType type) {
 122         supportedPolicyTypes.put(type.name(), type);
 123     }
 124
 125     /**
 126      * Removes all policy type as supported by this Ric.
 127      */
 128     public void clearSupportedPolicyTypes() {
 129         supportedPolicyTypes.clear();
 130     }
 131
 132     /**
 133      * Checks if a type is supported by this Ric.
 134      *
 135      * @param typeName the name of the type to check if it is supported.
 136      *
 137      * @return true if the given type is supported by this Ric, false otherwise.
 138      */
 139     public boolean isSupportingType(String typeName) {
 140         return supportedPolicyTypes.containsKey(typeName);
 141     }
 142
 143     @Override
 144     public String toString() {
 145         return Ric.class.getSimpleName() + ": " + "name: " + name() + ", state: " + state + ", baseUrl: "
 146             + ricConfig.baseUrl() + ", managedNodes: " + ricConfig.managedElementIds();
 147     }
 148
 149     /**
 150      * Represents the states possible for a Ric.
 151      */
 152     public static enum RicState {
 153         /**
 154          * The agent view of the agent may be inconsistent.
 155          */
 156         UNDEFINED,
 157         /**
 158          * The normal state. Policies can be configured.
 159          */
 160         IDLE,
 161         /**
 162          * The Ric states are recovered.
 163          */
 164         RECOVERING
 165     }
 166 }