Auth Manager API part 4: RESTClient, HTTPClient #11992
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * 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 java.util.Map; | ||
| import java.util.function.Consumer; | ||
| import org.apache.iceberg.rest.HTTPRequest.HTTPMethod; | ||
| import org.apache.iceberg.rest.auth.AuthSession; | ||
| import org.apache.iceberg.rest.responses.ErrorResponse; | ||
|
|
||
| /** | ||
| * A base class for {@link RESTClient} implementations. | ||
| * | ||
| * <p>All methods in {@link RESTClient} are implemented in the same way: first, an {@link | ||
| * HTTPRequest} is {@linkplain #buildRequest(HTTPMethod, String, Map, Map, Object) built from the | ||
| * method arguments}, then {@linkplain #execute(HTTPRequest, Class, Consumer, Consumer) executed}. | ||
| * | ||
| * <p>This allows subclasses to provide a consistent way to execute all requests, regardless of the | ||
| * method or arguments. | ||
| */ | ||
| public abstract class BaseHTTPClient implements RESTClient { | ||
|
|
||
| @Override | ||
| public abstract RESTClient withAuthSession(AuthSession session); | ||
|
|
||
| @Override | ||
| public void head(String path, Map<String, String> headers, Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.HEAD, path, null, headers, null); | ||
| execute(request, null, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T delete( | ||
danielcweeks marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| String path, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.DELETE, path, null, headers, null); | ||
| return execute(request, responseType, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T delete( | ||
| String path, | ||
| Map<String, String> queryParams, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.DELETE, path, queryParams, headers, null); | ||
| return execute(request, responseType, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T get( | ||
| String path, | ||
| Map<String, String> queryParams, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.GET, path, queryParams, headers, null); | ||
| return execute(request, responseType, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T post( | ||
| String path, | ||
| RESTRequest body, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, body); | ||
| return execute(request, responseType, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T post( | ||
| String path, | ||
| RESTRequest body, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler, | ||
| Consumer<Map<String, String>> responseHeaders) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, body); | ||
| return execute(request, responseType, errorHandler, responseHeaders); | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends RESTResponse> T postForm( | ||
| String path, | ||
| Map<String, String> formData, | ||
| Class<T> responseType, | ||
| Map<String, String> headers, | ||
| Consumer<ErrorResponse> errorHandler) { | ||
| HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, formData); | ||
| return execute(request, responseType, errorHandler, h -> {}); | ||
| } | ||
|
|
||
| protected abstract HTTPRequest buildRequest( | ||
| HTTPMethod method, | ||
| String path, | ||
| Map<String, String> queryParams, | ||
| Map<String, String> headers, | ||
| Object body); | ||
|
|
||
| protected abstract <T extends RESTResponse> T execute( | ||
| HTTPRequest request, | ||
| Class<T> responseType, | ||
| Consumer<ErrorResponse> errorHandler, | ||
| Consumer<Map<String, String>> responseHeaders); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@adutra It's beyond the scope of this PR since this is an existing problem, but somehow we need the AuthManager/AuthSession to be able to refresh OAuth tokens here as well. The token here will expire at which point the credential provider will not be able to get new vended credentials.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. I don't mind looking into it once we have the whole API merged 👍