1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.adservices.service.common.httpclient;
18 
19 import com.google.auto.value.AutoValue;
20 import com.google.common.collect.ImmutableMap;
21 
22 import java.util.List;
23 
24 /** Response sent by {@link AdServicesHttpsClient} when downloading payload */
25 @AutoValue
26 public abstract class AdServicesHttpClientResponse {
27 
28     /**
29      * @return the body of response when a payload is downloaded. This string can be encoded in
30      *     UTF-8 or Base64 encoding depending on the {@link AdServicesHttpsClient} method used to
31      *     make the HTTP call.
32      */
33     // TODO(b/323851937): We should return the response body in a byte
34     //  array. It will make {@link AdServicesHttpsClient} uniform and will be easy to handle all
35     //  different types of responses.
getResponseBody()36     public abstract String getResponseBody();
37 
38     /** @return the response headers associated with a payload download */
getResponseHeaders()39     public abstract ImmutableMap<String, List<String>> getResponseHeaders();
40 
41     /**
42      * Creates an {@link AdServicesHttpClientResponse}
43      *
44      * @param responseBody see {{@link #getResponseBody()}}
45      * @param responseHeaders see {{@link #getResponseHeaders()}}
46      * @return a response from downloading a payload
47      */
create( String responseBody, ImmutableMap<String, List<String>> responseHeaders)48     public static AdServicesHttpClientResponse create(
49             String responseBody, ImmutableMap<String, List<String>> responseHeaders) {
50         return builder().setResponseBody(responseBody).setResponseHeaders(responseHeaders).build();
51     }
52 
53     /** @return a builder to create an instance of {@link AdServicesHttpClientResponse} */
builder()54     public static AdServicesHttpClientResponse.Builder builder() {
55         return new AutoValue_AdServicesHttpClientResponse.Builder()
56                 .setResponseHeaders(ImmutableMap.of());
57     }
58 
59     /** A builder to create an instance of {@link AdServicesHttpClientResponse} */
60     @AutoValue.Builder
61     public abstract static class Builder {
62 
63         /** @param responseBody the body for the downloaded payload */
setResponseBody(String responseBody)64         public abstract AdServicesHttpClientResponse.Builder setResponseBody(String responseBody);
65 
66         /** @param responseHeaders response headers associated with a downloaded */
setResponseHeaders( ImmutableMap<String, List<String>> responseHeaders)67         public abstract AdServicesHttpClientResponse.Builder setResponseHeaders(
68                 ImmutableMap<String, List<String>> responseHeaders);
69 
70         /** @return an instance of {@link AdServicesHttpsClient} */
build()71         public abstract AdServicesHttpClientResponse build();
72     }
73 }
74