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.JsonElement;
  23 import com.google.gson.JsonObject;
  24 import java.time.Duration;
  25 import java.util.UUID;
  26 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.ImmutableRequestDiagnosticContext;
  27 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
  28 import reactor.core.publisher.Flux;
  29 import reactor.core.publisher.Mono;
  30 import org.jetbrains.annotations.NotNull;
  31
  32 /**
  33  * <p>Main Config Binding Service client interface.</p>
  34  *
  35  * <p>User should use this interface to subscribe to events published when CBS client fetches configuration.</p>
  36  *
  37  * @since 1.1.2
  38  */
  39 public interface CbsClient {
  40
  41     /**
  42      * Get reactive configuration stream.
  43      * <p>
  44      * Returns a {@link Mono} that publishes new configuration after CBS client retrieves one.
  45      *
  46      * @return reactive stream of configuration
  47      * @param diagnosticContext diagnostic context as defined in Logging Guideline
  48      * @since 1.1.2
  49      */
  50     @NotNull Mono<JsonObject> get(RequestDiagnosticContext diagnosticContext);
  51
  52     /**
  53      * Poll for configuration.
  54      *
  55      * Will call {@link #get(RequestDiagnosticContext)} after {@code initialDelay} every {@code period}. Resulting entries may or may not be
  56      * changed, ie. items in the stream might be the same until change is made in CBS.
  57      *
  58      * @param initialDelay delay after first request attempt
  59      * @param period frequency of update checks
  60      * @return stream of configuration states
  61      */
  62     default Flux<JsonObject> get(RequestDiagnosticContext diagnosticContext, Duration initialDelay, Duration period) {
  63         return Flux.interval(initialDelay, period)
  64                 .map(i -> ImmutableRequestDiagnosticContext.copyOf(diagnosticContext).withInvocationId(UUID.randomUUID()))
  65                 .flatMap(this::get);
  66     }
  67 }