policy-agent/src/main/java/org/oransc/policyagent/clients/A1Client.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   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.policyagent.clients;
  22
  23 import java.util.List;
  24
  25 import org.oransc.policyagent.repository.Policy;
  26
  27 import reactor.core.publisher.Flux;
  28 import reactor.core.publisher.Mono;
  29
  30 /**
  31  * Common interface for 'A1' Policy access. Implementations of this interface
  32  * adapts to the different southbound REST APIs supported.
  33  */
  34 public interface A1Client {
  35
  36     public enum A1ProtocolType {
  37         UNKNOWN, //
  38         STD_V1_1, // STD A1 version 1.1
  39         OSC_V1, // OSC 'A1'
  40         SDNC_OSC_STD_V1_1, // SDNC_OSC with STD A1 version 1.1 southbound
  41         SDNC_OSC_OSC_V1, // SDNC_OSC with OSC 'A1' southbound
  42         SDNC_ONAP
  43     }
  44
  45     public Mono<A1ProtocolType> getProtocolVersion();
  46
  47     public Mono<List<String>> getPolicyTypeIdentities();
  48
  49     public Mono<List<String>> getPolicyIdentities();
  50
  51     public Mono<String> getPolicyTypeSchema(String policyTypeId);
  52
  53     public Mono<String> putPolicy(Policy policy);
  54
  55     public Mono<String> deletePolicy(Policy policy);
  56
  57     public Flux<String> deleteAllPolicies();
  58
  59     public Mono<String> getPolicyStatus(Policy policy);
  60 }