2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.policyagent.repository;
23 import java.util.Collection;
24 import java.util.HashMap;
26 import java.util.Vector;
28 import org.oransc.policyagent.clients.A1Client.A1ProtocolType;
29 import org.oransc.policyagent.configuration.RicConfig;
32 * Represents the dynamic information about a NearRealtime-RIC.
35 private final RicConfig ricConfig;
36 private RicState state = RicState.UNDEFINED;
37 private Map<String, PolicyType> supportedPolicyTypes = new HashMap<>();
38 private A1ProtocolType protocolVersion = A1ProtocolType.UNKNOWN;
41 * Creates the Ric. Initial state is {@link RicState.NOT_INITIATED}.
43 * @param ricConfig The {@link RicConfig} for this Ric.
45 public Ric(RicConfig ricConfig) {
46 this.ricConfig = ricConfig;
49 public String name() {
50 return ricConfig.name();
53 public RicState state() {
57 public void setState(RicState newState) {
61 public RicConfig getConfig() {
62 return this.ricConfig;
66 * Gets the nodes managed by this Ric.
68 * @return a vector containing the nodes managed by this Ric.
70 public Vector<String> getManagedElementIds() {
71 return ricConfig.managedElementIds();
75 * Determines if the given node is managed by this Ric.
77 * @param managedElementId the node name to check.
78 * @return true if the given node is managed by this Ric.
80 public boolean isManaging(String managedElementId) {
81 return ricConfig.managedElementIds().contains(managedElementId);
85 * Adds the given node as managed by this Ric.
87 * @param managedElementId the node to add.
89 public void addManagedElement(String managedElementId) {
90 if (!ricConfig.managedElementIds().contains(managedElementId)) {
91 ricConfig.managedElementIds().add(managedElementId);
96 * Removes the given node as managed by this Ric.
98 * @param managedElementId the node to remove.
100 public void removeManagedElement(String managedElementId) {
101 ricConfig.managedElementIds().remove(managedElementId);
105 * Gets the policy types supported by this Ric.
107 * @return the policy types supported by this Ric in an unmodifiable list.
109 public Collection<PolicyType> getSupportedPolicyTypes() {
110 return supportedPolicyTypes.values();
113 public Collection<String> getSupportedPolicyTypeNames() {
114 return supportedPolicyTypes.keySet();
118 * Adds a policy type as supported by this Ric.
120 * @param type the policy type to support.
122 public void addSupportedPolicyType(PolicyType type) {
123 supportedPolicyTypes.put(type.name(), type);
127 * Removes all policy type as supported by this Ric.
129 public void clearSupportedPolicyTypes() {
130 supportedPolicyTypes.clear();
134 * Checks if a type is supported by this Ric.
136 * @param typeName the name of the type to check if it is supported.
138 * @return true if the given type is supported by this Ric, false otherwise.
140 public boolean isSupportingType(String typeName) {
141 return supportedPolicyTypes.containsKey(typeName);
145 public String toString() {
146 return Ric.class.getSimpleName() + ": " + "name: " + name() + ", state: " + state + ", baseUrl: "
147 + ricConfig.baseUrl() + ", managedNodes: " + ricConfig.managedElementIds();
151 * Represents the states possible for a Ric.
153 public static enum RicState {
155 * The agent view of the agent may be inconsistent
159 * The normal state. Policies can be configured.
163 * The Ric states are recovered
168 public A1ProtocolType getProtocolVersion() {
169 return protocolVersion;
172 public void setProtocolVersion(A1ProtocolType version) {
173 protocolVersion = version;