webapp-frontend/src/app/services/dashboard/dashboard.service.ts

   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 import { Injectable } from '@angular/core';
  21 import { HttpClient } from '@angular/common/http';
  22 import { Observable } from 'rxjs';
  23 import { DashboardSuccessTransport, EcompUser } from '../../interfaces/dashboard.types';
  24
  25 @Injectable({
  26   providedIn: 'root'
  27 })
  28
  29 /**
  30  * Services to query the dashboard's admin endpoints.
  31  */
  32 export class DashboardService {
  33
  34   private basePath = 'api/admin/';
  35
  36   constructor(private httpClient: HttpClient) {
  37     // injects to variable httpClient
  38   }
  39
  40  /**
  41    * Checks app health
  42    * @returns Observable that should yield a DashboardSuccessTransport
  43    */
  44   getHealth(): Observable<DashboardSuccessTransport> {
  45     return this.httpClient.get<DashboardSuccessTransport>(this.basePath + 'health');
  46   }
  47
  48   /**
  49    * Gets Dashboard version details
  50    * @returns Observable that should yield a DashboardSuccessTransport object
  51    */
  52   getVersion(): Observable<DashboardSuccessTransport> {
  53     return this.httpClient.get<DashboardSuccessTransport>(this.basePath + 'version');
  54   }
  55
  56   /**
  57    * Gets Dashboard users
  58    * @returns Observable that should yield a EcompUser array
  59    */
  60   getUsers(): Observable<EcompUser[]> {
  61     return this.httpClient.get<EcompUser[]>(this.basePath + 'user');
  62   }
  63
  64 }