gerrit.onap Code Review - dcaegen2/services/sdk.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * ================================================================================
   5  * Copyright (C) 2019 Nokia. 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 package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api;
  21
  22 import com.google.gson.JsonObject;
  23 import reactor.core.publisher.Mono;
  24 import org.jetbrains.annotations.NotNull;
  25
  26 /**
  27  * <p>Main Config Binding Service client interface.</p>
  28  *
  29  * <p>User should use this interface to subscribe to events published when CBS client fetches configuration.</p>
  30  *
  31  * @since 1.1.2
  32  */
  33 public interface CbsClient {
  34
  35     /**
  36      * Get reactive configuration stream.
  37      * <p>
  38      * Returns a {@link Mono} that publishes new configuration after CBS client retrieves one.
  39      *
  40      * @param serviceComponentName url key under which CBS client should look for configuration
  41      * @return reactive stream of configuration
  42      * @since 1.1.2
  43      */
  44     @NotNull Mono<JsonObject> get(String serviceComponentName);
  45 }