Synch front-end and back-end method paths for AC
[portal/ric-dashboard.git] / webapp-frontend / src / app / services / ac-xapp / ac-xapp.service.ts
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 AT&T Intellectual Property and Nokia
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  import { Injectable } from '@angular/core';
22  import { HttpClient } from '@angular/common/http';
23  import { Observable } from 'rxjs';
24  import { map } from 'rxjs/operators';
25 import { ACAdmissionIntervalControl, ACAdmissionIntervalControlAck } from '../../interfaces/ac-xapp.types';
26 import { DashboardSuccessTransport } from '../../interfaces/dashboard.types';
27
28 /**
29  * Services for calling the Dashboard's AC endpoints.
30  */
31 @Injectable({
32   providedIn: 'root'
33 })
34 export class ACXappService {
35
36   private basePath = 'api/xapp/admctl';
37   private policyPath = 'policy';
38
39   private buildPath(...args: any[]) {
40     let result = this.basePath;
41     args.forEach(part => {
42       result = result + '/' + part;
43     });
44     return result;
45   }
46
47   constructor(private httpClient: HttpClient) {
48     // injects to variable httpClient
49   }
50
51   /**
52    * Gets version details
53    * @returns Observable that should yield a String
54    */
55   getVersion(): Observable<string> {
56     const url = this.buildPath('version');
57     return this.httpClient.get<DashboardSuccessTransport>(url).pipe(
58       // Extract the string here
59       map(res => res['data'])
60     );
61   }
62
63   /**
64    * Gets admission control parameters.
65    * @returns Observable that should yield an ACAdmissionIntervalControl
66    */
67   getPolicy(): Observable<ACAdmissionIntervalControl> {
68     const url = this.buildPath(this.policyPath);
69     return this.httpClient.get<ACAdmissionIntervalControl>(url);
70   }
71
72   /**
73    * Puts admission control parameters.
74    * @param policy an instance of ACAdmissionIntervalControl
75    * @returns Observable that should yield a response code, no data
76    */
77   putPolicy(policy: ACAdmissionIntervalControl): Observable<any> {
78     const url = this.buildPath(this.policyPath);
79     return this.httpClient.put<ACAdmissionIntervalControlAck>(url, policy, { observe: 'response' });
80   }
81
82 }