Add timeout for Publisher(dmaap-client)
[dcaegen2/services/sdk.git] / rest-services / http-client / src / main / java / org / onap / dcaegen2 / services / sdk / rest / services / adapters / http / HttpRequest.java
1 /*
2  * ============LICENSE_START====================================
3  * DCAEGEN2-SERVICES-SDK
4  * =========================================================
5  * Copyright (C) 2019-2020 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.adapters.http;
22
23 import io.vavr.collection.HashMap;
24 import io.vavr.collection.Map;
25 import org.immutables.value.Value;
26 import org.jetbrains.annotations.Nullable;
27 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
28
29 import java.time.Duration;
30
31 /**
32  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
33  * @since March 2019
34  */
35 @Value.Immutable
36 public interface HttpRequest {
37
38     String url();
39
40     HttpMethod method();
41
42     @Nullable Duration timeout();
43
44     @Nullable RequestBody body();
45
46     @Value.Default
47     default RequestDiagnosticContext diagnosticContext() {
48         return RequestDiagnosticContext.create();
49     }
50
51     @Value.Default
52     default Map<String, String> customHeaders() {
53         return HashMap.empty();
54     }
55
56     @Value.Derived
57     default Map<String, String> headers() {
58         final RequestDiagnosticContext ctx = diagnosticContext();
59         return ctx == null
60                 ? customHeaders()
61                 : customHeaders().merge(ctx.remoteCallHttpHeaders());
62     }
63 }