nastra commented on code in PR #10753: URL: https://github.com/apache/iceberg/pull/10753#discussion_r1876026218
########## core/src/main/java/org/apache/iceberg/rest/HTTPRequest.java: ########## @@ -0,0 +1,125 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.iceberg.rest; + +import com.fasterxml.jackson.databind.ObjectMapper; +import java.net.URI; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.immutables.value.Value; + +/** Represents an HTTP request. */ +@Value.Style(redactedMask = "****", depluralize = true) +@Value.Immutable +@SuppressWarnings({"ImmutablesStyle", "SafeLoggingPropagation"}) +public interface HTTPRequest { + + enum HTTPMethod { + GET, + HEAD, + POST, + DELETE + } + + /** + * Returns the base URI configured at the REST client level. The base URI is used to construct the + * full {@link #requestUri()}. + */ + @Value.Parameter(order = 0) + URI baseUri(); + + /** + * Returns the full URI of this request. The URI is constructed from the base URI, path, and query + * parameters. It cannot be modified directly. + */ + @Value.Lazy + default URI requestUri() { + return RESTUtil.buildRequestUri(this); + } + + /** Returns the HTTP method of this request. */ + @Value.Parameter(order = 1) + HTTPMethod method(); + + /** Returns the path of this request. */ + @Value.Parameter(order = 2) + String path(); + + /** Returns the query parameters of this request. */ + @Value.Parameter(order = 3) + Map<String, String> queryParameters(); + + /** Returns all the headers of this request. The map is case-sensitive! */ + @Value.Parameter(order = 4) + @Value.Redacted + Map<String, List<String>> headers(); + + /** Returns the header values of the given name. */ + default List<String> headers(String name) { + return headers().getOrDefault(name, List.of()); + } + + /** Returns whether the request contains a header with the given name. */ + default boolean containsHeader(String name) { + return !headers(name).isEmpty(); + } + + /** Returns the raw, unencoded request body. */ + @Nullable + @Value.Parameter(order = 5) + @Value.Redacted + Object body(); + + /** Returns the encoded request body as a string. */ + @Value.Lazy + @Nullable + @Value.Redacted + default String encodedBody() { + return RESTUtil.encodeRequestBody(this); + } + + /** + * Returns the {@link ObjectMapper} to use for encoding the request body. The default is {@link + * RESTObjectMapper#mapper()}. + */ + @Value.Default + default ObjectMapper mapper() { + return RESTObjectMapper.mapper(); + } + + HTTPRequest withBaseUri(URI baseUri); Review Comment: not sure why these are needed but the below diff should achieve the same with less code: ``` --- a/core/src/main/java/org/apache/iceberg/rest/HTTPRequest.java +++ b/core/src/main/java/org/apache/iceberg/rest/HTTPRequest.java @@ -43,7 +43,6 @@ public interface HTTPRequest { * Returns the base URI configured at the REST client level. The base URI is used to construct the * full {@link #requestUri()}. */ - @Value.Parameter(order = 0) URI baseUri(); /** @@ -56,19 +55,15 @@ public interface HTTPRequest { } /** Returns the HTTP method of this request. */ - @Value.Parameter(order = 1) HTTPMethod method(); /** Returns the path of this request. */ - @Value.Parameter(order = 2) String path(); /** Returns the query parameters of this request. */ - @Value.Parameter(order = 3) Map<String, String> queryParameters(); /** Returns all the headers of this request. The map is case-sensitive! */ - @Value.Parameter(order = 4) @Value.Redacted Map<String, List<String>> headers(); @@ -84,7 +79,6 @@ public interface HTTPRequest { /** Returns the raw, unencoded request body. */ @Nullable - @Value.Parameter(order = 5) @Value.Redacted Object body(); @@ -105,21 +99,9 @@ public interface HTTPRequest { return RESTObjectMapper.mapper(); } - HTTPRequest withBaseUri(URI baseUri); - - HTTPRequest withMethod(HTTPMethod method); - - HTTPRequest withPath(String path); - - HTTPRequest withQueryParameters(Map<String, ? extends String> queryParameters); - - HTTPRequest withHeaders(Map<String, ? extends List<String>> headers); - - HTTPRequest withBody(Object body); - default HTTPRequest putHeadersIfAbsent(Map<String, String> headers) { Map<String, List<String>> newHeaders = Maps.newLinkedHashMap(headers()); headers.forEach((name, value) -> newHeaders.putIfAbsent(name, List.of(value))); - return withHeaders(newHeaders); + return ImmutableHTTPRequest.builder().from(this).headers(newHeaders).build(); } ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
