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
  21 package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model;
  22
  23 import java.util.UUID;
  24 import org.immutables.value.Value;
  25 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.ImmutableRequestDiagnosticContext;
  26 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
  27
  28 /**
  29  * A recipe on which CBS endpoint to call. Usually you should use {@link org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests}
  30  * which is a factory to each request type.
  31  *
  32  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
  33  * @since 1.1.4
  34  */
  35 @Value.Immutable
  36 public interface CbsRequest {
  37
  38     /**
  39      * The CBS request path. It will be created by the library.
  40      */
  41     RequestPath requestPath();
  42
  43     /**
  44      * Diagnostic context as defined in Logging Guideline
  45      */
  46     RequestDiagnosticContext diagnosticContext();
  47
  48     /**
  49      * Return a view on this CbsRequest with updated InvocationID.
  50      */
  51     default CbsRequest withNewInvocationId() {
  52         final RequestDiagnosticContext newDiagnosticCtx = ImmutableRequestDiagnosticContext
  53                 .copyOf(diagnosticContext())
  54                 .withInvocationId(UUID.randomUUID());
  55         return ImmutableCbsRequest.copyOf(this).withDiagnosticContext(newDiagnosticCtx);
  56     }
  57 }