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;
31 import org.oransc.policyagent.clients.A1Client.A1ProtocolType;
32 import org.oransc.policyagent.configuration.RicConfig;
35 * Represents the dynamic information about a NearRealtime-RIC.
38 private final RicConfig ricConfig;
40 private RicState state = RicState.UNDEFINED;
41 private Map<String, PolicyType> supportedPolicyTypes = new HashMap<>();
44 private A1ProtocolType protocolVersion = A1ProtocolType.UNKNOWN;
47 * Creates the Ric. Initial state is {@link RicState.NOT_INITIATED}.
49 * @param ricConfig The {@link RicConfig} for this Ric.
51 public Ric(RicConfig ricConfig) {
52 this.ricConfig = ricConfig;
55 public String name() {
56 return ricConfig.name();
59 public RicConfig getConfig() {
60 return this.ricConfig;
63 public synchronized RicState getState() {
67 public synchronized void setState(RicState state) {
72 * Gets the nodes managed by this Ric.
74 * @return a vector containing the nodes managed by this Ric.
76 public synchronized Collection<String> getManagedElementIds() {
77 return new Vector<>(ricConfig.managedElementIds());
81 * Determines if the given node is managed by this Ric.
83 * @param managedElementId the node name to check.
84 * @return true if the given node is managed by this Ric.
86 public synchronized boolean isManaging(String managedElementId) {
87 return ricConfig.managedElementIds().contains(managedElementId);
91 * Adds the given node as managed by this Ric.
93 * @param managedElementId the node to add.
95 public synchronized void addManagedElement(String managedElementId) {
96 if (!ricConfig.managedElementIds().contains(managedElementId)) {
97 ricConfig.managedElementIds().add(managedElementId);
102 * Removes the given node as managed by this Ric.
104 * @param managedElementId the node to remove.
106 public synchronized void removeManagedElement(String managedElementId) {
107 ricConfig.managedElementIds().remove(managedElementId);
111 * Gets the policy types supported by this Ric.
113 * @return the policy types supported by this Ric in an unmodifiable list.
115 public synchronized Collection<PolicyType> getSupportedPolicyTypes() {
116 return new Vector<>(supportedPolicyTypes.values());
119 public synchronized Collection<String> getSupportedPolicyTypeNames() {
120 return new Vector<>(supportedPolicyTypes.keySet());
124 * Adds a policy type as supported by this Ric.
126 * @param type the policy type to support.
128 public synchronized void addSupportedPolicyType(PolicyType type) {
129 supportedPolicyTypes.put(type.name(), type);
133 * Removes all policy type as supported by this Ric.
135 public synchronized void clearSupportedPolicyTypes() {
136 supportedPolicyTypes.clear();
140 * Checks if a type is supported by this Ric.
142 * @param typeName the name of the type to check if it is supported.
144 * @return true if the given type is supported by this Ric, false otherwise.
146 public synchronized boolean isSupportingType(String typeName) {
147 return supportedPolicyTypes.containsKey(typeName);
151 public synchronized String toString() {
152 return Ric.class.getSimpleName() + ": " + "name: " + name() + ", state: " + state + ", baseUrl: "
153 + ricConfig.baseUrl() + ", managedNodes: " + ricConfig.managedElementIds();
157 * Represents the states possible for a Ric.
159 public static enum RicState {
161 * The agent view of the agent may be inconsistent.
165 * The normal state. Policies can be configured.
169 * The Ric states are recovered.