Require RIC instance key in controller methods
[portal/ric-dashboard.git] / webapp-backend / src / main / java / org / oransc / ric / portal / dashboard / config / RICInstanceConfiguration.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 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.config;
22
23 import java.util.ArrayList;
24 import java.util.List;
25
26 import org.oransc.ric.portal.dashboard.model.RicInstance;
27 import org.oransc.ric.portal.dashboard.model.RicInstanceList;
28 import org.springframework.boot.context.properties.ConfigurationProperties;
29 import org.springframework.context.annotation.Bean;
30 import org.springframework.context.annotation.Configuration;
31 import org.springframework.context.annotation.Profile;
32
33 /**
34  * Publishes a list of RIC instances from configuration, written as a YAML list
35  * in application properties like this:
36  * 
37  * <pre>
38  * ric-instance-list:
39     instances:
40         -
41           key: key1
42           name: Friendly Name One
43           urlPrefix: http://foo.bar.one/
44         -
45           key: key2
46           name: Friendly Name Two
47           urlPrefix: http://foo.bar.two/
48  * </pre>
49  */
50 @Configuration
51 @ConfigurationProperties(prefix = "ric-instance-list")
52 @Profile("!test")
53 public class RICInstanceConfiguration {
54
55         private List<RicInstance> instances = new ArrayList<>();
56
57         // Called by spring with config data
58         public void setInstances(List<RicInstance> instances) {
59                 this.instances = instances;
60         }
61
62         @Bean
63         public RicInstanceList ricInstanceList() {
64                 return new RicInstanceList(instances);
65         }
66
67 }