com.mongodb.spi.dns.InetAddressResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed 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 com.mongodb.spi.dns;

import com.mongodb.MongoClientSettings;
import com.mongodb.annotations.ThreadSafe;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.List;

/**
 * This interface defines operations for looking up host names.
 *
 *  The default resolver for the driver can be customized by deploying an implementation of {@link InetAddressResolverProvider}.
 *
 * @see InetAddressResolverProvider
 * @see MongoClientSettings.Builder#inetAddressResolver(InetAddressResolver)
 * @since 4.10
 */
@ThreadSafe
public interface InetAddressResolver {
    /**
     * Given the name of a host, returns a list of IP addresses of the requested
     * address family associated with a provided hostname.
     *
     * The host name can be an IP literal, as with {@link InetAddress#getAllByName(String)}
     *
     * Implementations are encouraged to implement their own caching policies, as there is
     * no guarantee that the caller will implement a cache.
     *
     * @param host the host
     * @return a list of IP addresses for the requested host
     * @throws UnknownHostException if no IP addresses for the {@code host} could be found
     */
    List lookupByName(String host) throws UnknownHostException;
}