gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
   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.onap.ccsdk.oran.a1policymanagementservice.clients;
  22
  23 import java.util.List;
  24
  25 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  26 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  27
  28 import reactor.core.publisher.Flux;
  29 import reactor.core.publisher.Mono;
  30
  31 /**
  32  * Common interface for 'A1' Policy access. Implementations of this interface
  33  * adapts to the different southbound REST APIs supported.
  34  */
  35 public interface A1Client {
  36
  37     public interface Factory {
  38         A1Client create(RicConfig ricConfig, AsyncRestClientFactory restClientFactory);
  39     }
  40
  41     public enum A1ProtocolType {
  42         UNKNOWN, //
  43         STD_V1_1, // STD A1 version 1.1
  44         STD_V2_0_0, // STD A1 version 2.0.0
  45         OSC_V1, // OSC 'A1'
  46         CCSDK_A1_ADAPTER_STD_V1_1, // CCSDK_A1_ADAPTER with STD A1 version 1.1 southbound
  47         CCSDK_A1_ADAPTER_STD_V2_0_0, // CCSDK_A1_ADAPTER with STD A1 version 2.0.0 southbound
  48         CCSDK_A1_ADAPTER_OSC_V1, // CCSDK_A1_ADAPTER with OSC 'A1' southbound
  49         CUSTOM_PROTOCOL // Some other protocol handled by some custom A1 adapter class.
  50     }
  51
  52     public Mono<A1ProtocolType> getProtocolVersion();
  53
  54     public Mono<List<String>> getPolicyTypeIdentities();
  55
  56     public Mono<List<String>> getPolicyIdentities();
  57
  58     public Mono<String> getPolicyTypeSchema(String policyTypeId);
  59
  60     public Mono<String> putPolicy(Policy policy);
  61
  62     public Mono<String> deletePolicy(Policy policy);
  63
  64     public Flux<String> deleteAllPolicies();
  65
  66     public Mono<String> getPolicyStatus(Policy policy);
  67
  68 }