001/*
002 * Copyright 2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.revetsec.oauth.server;
018
019import org.jspecify.annotations.NonNull;
020import javax.annotation.concurrent.ThreadSafe;
021import java.net.InetAddress;
022import java.time.Duration;
023import java.util.List;
024
025/**
026 * Trusted bounded address resolution for opt-in client metadata retrieval.
027 * Implementations return every numeric answer for the checked original hostname and honor the
028 * shrinking remaining budget on the calling thread. They must be safe for concurrent callers.
029 * Revetsec checks all answers and pins an approved numeric peer; this callback does not fetch
030 * metadata or authorize clients. No implicit system resolver or owned executor is supplied.
031 * Construction of a metadata policy never invokes this callback.
032 * @author <a href="https://www.revetkn.com">Mark Allen</a>
033 * @since 1.0.0
034 */
035@ThreadSafe
036public interface OAuthClientMetadataAddressResolver {
037 /**
038  * Resolves every address under the supplied remaining budget, without reverse lookup.
039  * @param hostname the checked original hostname
040  * @param remainingBudget the positive remaining operation budget
041  * @return all numeric answers; an empty list cannot establish a destination
042  * @since 1.0.0
043  */
044 @NonNull List<@NonNull InetAddress> resolve(@NonNull String hostname, @NonNull Duration remainingBudget);
045}